Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added documentation for --suppress-xml #1420

Merged
merged 3 commits into from
Oct 13, 2018
Merged

Added documentation for --suppress-xml #1420

merged 3 commits into from
Oct 13, 2018

Conversation

Laro88
Copy link
Contributor

@Laro88 Laro88 commented Oct 10, 2018

No description provided.

@Laro88
Copy link
Contributor Author

Laro88 commented Oct 10, 2018

The xml example in the manual seems wrong

<?xml version="1.0"?>
<suppressions>
 <suppress>
 <id>preprocessorErrorDirective</id>
 <fileName>somedir/IDataReceiver.h</fileName>

@@ -515,6 +516,12 @@ There are false positives with this option. Each result must be carefully invest
<para>Suppress warnings listed in the file.
Each suppression is in the format of &lt;spec&gt; above.</para>
</listitem>
</varlistentry>
<varlistentry>
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This <varlistentry> have too much indentation

Copy link
Owner

@danmar danmar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nits.

It feels like we should indent this with the runastyle script cppcheck/runastyle. However that is a different PR.

@Laro88
Copy link
Contributor Author

Laro88 commented Oct 11, 2018

I have updated the indentation in the xml, however I don't know where the actual manual document is. If it is in the git repo then I will paste a sample in there that seems to work.

@amai2012 amai2012 mentioned this pull request Oct 11, 2018
danmar pushed a commit that referenced this pull request Oct 13, 2018
Try to format cppcheck.1.xml via xmllint as suggested in #1420
@danmar danmar merged commit 5328caa into danmar:master Oct 13, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants