mirror of
https://github.com/apache/nuttx.git
synced 2026-05-22 13:52:22 +08:00
Matteo Golin
53fdfa68b9
All of the tools listed on the original documentation are now given their own individual doc pages. This makes it much easier to cross-reference them from other documentation locations (as many are used in CI/for specific architectures) and it also makes it easier for users to digest the information. Signed-off-by: Matteo Golin <matteo.golin@gmail.com>
36 lines
1.4 KiB
ReStructuredText
36 lines
1.4 KiB
ReStructuredText
=============
|
|
``nxstyle.c``
|
|
=============
|
|
|
|
I am embarrassed that this is here. This program is a complete hack but,
|
|
unfortunately, it has become so useful to me that I need to keep it here.
|
|
|
|
A little background: I have tinkered with pretty printers for some
|
|
time and have not been happy with the results. An alternative that
|
|
occurred to me would be just a standard checker that examines a C
|
|
file that gives warnings for violations of the coding standard.
|
|
|
|
This turns out to be more difficult that you might think. A pretty
|
|
printer understands C syntax: They break the file up into its C
|
|
components then reassembles the output in the format. But parsing the
|
|
C loses the original file layout and so it not useful in this case.
|
|
|
|
This program instead, uses a collection of heuristics (i.e., hacks and
|
|
bandaids) to examine the C file for obvious violations of the coding
|
|
standard. This program is completely ignorant of C syntax; it simply
|
|
performs crude pattern matching to check the file.
|
|
|
|
Prints formatted messages that are classified as info, warn, error,
|
|
fatal. In a parsable format that can be used by editors and IDEs.
|
|
|
|
Usage::
|
|
|
|
nxstyle [-m <excess>] [-v <level>] [-r <start,count>] <filename>
|
|
nxstyle -h this help
|
|
nxstyle -v <level> where level is
|
|
0 - no output
|
|
1 - PASS/FAIL
|
|
2 - output each line (default)
|
|
|
|
See also indent.sh and uncrustify.cfg
|