walkero
/
cppcheck
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Merge pull request #26 from gerundt/man-appendix 

Add "Writing Cppcheck rules" and "Cppcheck Design" articles as appendix to the manual
This commit is contained in:
Daniel Marjamäki 2011-06-29 09:58:15 -07:00
parent e597ad72e7 8a48193162
commit edae93a68a
6 changed files with 30 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
man/buildman.sh
View File

@ -5,15 +5,3 @@ xsltproc -o manual.html /usr/share/xml/docbook/stylesheet/nwalsh/xhtml/docbook.x
xsltproc -o intermediate-fo-file.fo /usr/share/xml/docbook/stylesheet/nwalsh/fo/docbook.xsl manual.docbook
fop -pdf manual.pdf -fo intermediate-fo-file.fo
xsltproc --stringparam generate.toc "article nop" -o intermediate-fo-file.fo /usr/share/xml/docbook/stylesheet/nwalsh/fo/docbook.xsl writing-rules-1.docbook
fop -pdf writing-rules-1.pdf -fo intermediate-fo-file.fo
xsltproc --stringparam generate.toc "article nop" -o intermediate-fo-file.fo /usr/share/xml/docbook/stylesheet/nwalsh/fo/docbook.xsl writing-rules-2.docbook
fop -pdf writing-rules-2.pdf -fo intermediate-fo-file.fo
xsltproc --stringparam generate.toc "article nop" -o intermediate-fo-file.fo /usr/share/xml/docbook/stylesheet/nwalsh/fo/docbook.xsl writing-rules-3.docbook
fop -pdf writing-rules-3.pdf -fo intermediate-fo-file.fo
xsltproc --stringparam generate.toc "article nop" -o intermediate-fo-file.fo /usr/share/xml/docbook/stylesheet/nwalsh/fo/docbook.xsl cppcheck-design.docbook
fop -pdf cppcheck-design.pdf -fo intermediate-fo-file.fo

10
man/cppcheck-design.docbook
View File

@ -1,11 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<article version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook">
<appendix>
<info>
<title>Cppcheck Design</title>
@ -191,4 +185,4 @@ void f2()
<para>Cppcheck will just find some bugs. It is likely that you won't find
these bugs unless you use Cppcheck.</para>
</section>
</article>
</appendix>

16
man/manual.docbook
View File

@ -1,6 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
"/usr/share/xml/docbook/schema/dtd/4.4/docbookx.dtd">
"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY writing-rules-1 SYSTEM "writing-rules-1.docbook">
<!ENTITY writing-rules-2 SYSTEM "writing-rules-2.docbook">
<!ENTITY writing-rules-3 SYSTEM "writing-rules-3.docbook">
<!ENTITY cppcheck-design SYSTEM "cppcheck-design.docbook">
]>
<book>
<bookinfo>
<title>Cppcheck 1.49</title>
@ -612,4 +617,13 @@ htmlreport/cppcheck-htmlreport --file=err.xml --report-dir=test1 --source-dir=.<
if you want to limit the checking.</para>
</section>
</chapter>
<appendix>
<title>Writing Cppcheck rules</title>
&writing-rules-1;
&writing-rules-2;
&writing-rules-3;
</appendix>
&cppcheck-design;
</book>

14
man/writing-rules-1.docbook
View File

@ -1,11 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<article>
<articleinfo>
<title>Writing Cppcheck rules</title>
<subtitle>Part 1 - Getting started</subtitle>
<section>
<info>
<title>Part 1 - Getting started</title>
<author>
<firstname>Daniel</firstname>
@ -18,7 +14,7 @@
</author>
<pubdate>2010</pubdate>
</articleinfo>
</info>
<section>
<title>Introduction</title>
@ -146,4 +142,4 @@ Checking dealloc.cpp...
[dealloc.cpp:2]: (style) Redundant condition. It is valid to free a NULL pointer.</programlisting>
</section>
</section>
</article>
</section>

14
man/writing-rules-2.docbook
View File

@ -1,11 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
<article>
<articleinfo>
<title>Writing Cppcheck rules</title>
<subtitle>Part 2 - The Cppcheck data representation</subtitle>
<section>
<info>
<title>Part 2 - The Cppcheck data representation</title>
<author>
<firstname>Daniel</firstname>
@ -18,7 +14,7 @@
</author>
<pubdate>2010</pubdate>
</articleinfo>
</info>
<section>
<title>Introduction</title>
@ -350,4 +346,4 @@ s8 x;</programlisting>
</section>
</section>
</section>
</article>
</section>

14
man/writing-rules-3.docbook
View File

@ -1,15 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<article version="5.0" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns:m="http://www.w3.org/1998/Math/MathML"
xmlns:html="http://www.w3.org/1999/xhtml"
xmlns:db="http://docbook.org/ns/docbook">
<section>
<info>
<title>Writing Cppcheck rules</title>
<subtitle>Part 3 - Introduction to writing rules with C++</subtitle>
<title>Part 3 - Introduction to writing rules with C++</title>
<author>
<personname><firstname>Daniel</firstname><surname>Marjamäki</surname></personname>
@ -246,4 +238,4 @@ void CheckOther::dangerousUsageStrtolError(const Token *tok)
<para>The pattern <literal>(|,</literal> can also be written as
<literal>[(,]</literal>.</para>
</section>
</article>
</section>