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

Fix #13672: Update manual before release #7339

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

olabetskyi
Copy link
Collaborator

The title will be chaged

@@ -757,12 +761,12 @@ The output will look like this:

You can write your own pattern. For instance, to get warning messages that are formatted like traditional gcc, then the following format can be used:
Copy link
Owner

@danmar danmar Feb 27, 2025

Choose a reason for hiding this comment

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

I am not sure we should say "traditional gcc" anymore though if the column is added. I don't know which version this match? A warning from recent gcc seems to be something like:

1.c:1:8: warning: division by zero [-Wdiv-by-zero]
    1 | int x=0/0;
      |        ^

@@ -755,14 +759,14 @@ The output will look like this:

## User defined output format (single line)

You can write your own pattern. For instance, to get warning messages that are formatted like traditional gcc, then the following format can be used:
You can write your own pattern. For instance, to get warning messages that are separated by colon you could use this pattern:
Copy link
Owner

Choose a reason for hiding this comment

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

This text is not strictly correct. There are spaces in the pattern also. I think this would be better then:

Suggested change
You can write your own pattern. For instance, to get warning messages that are separated by colon you could use this pattern:
You can write your own pattern. For instance:

@@ -1163,10 +1173,18 @@ Command to active Cert C++ checkers:

cppcheck --premium=cert-c++ ....

Command to active Misra C 2023 checkers:
Copy link
Owner

Choose a reason for hiding this comment

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

active => activate

seems it's wrong in the other places also.

man/manual.md Outdated
Command to active Misra C++ 2008 checkers:

cppcheck --premium=misra-c++-2008 ....

## Licenses
Copy link
Owner

Choose a reason for hiding this comment

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

This ## Licenses should also be remove from the open source manual.

@olabetskyi olabetskyi changed the title Update manual before release Fix #13672: Update manual before release Feb 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants