OrgApache/incubator-nuttx
OrgApache
/
incubator-nuttx
mirror of https://github.com/apache/incubator-nuttx.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Update README.

This commit is contained in:
Gregory Nutt 2018-04-11 14:39:54 -06:00
parent a69d23d48c
commit be61157246
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
tools/README.txt
View File

@ -916,6 +916,8 @@ uncrustify.cfg
- FAR attributes in pointer declarations.
- The Nuttx standard function header block comments.
- Naming violations such as use of CamelCase variable names,
lower case pre-processor definitions, etc.
Comment blocks, function headers, files headers, etc. must be formatted
manually.
@ -924,6 +926,14 @@ uncrustify.cfg
it leaves it alone, but if the block comment is deemed to need a fix
it starts erroneously indenting the continuation lines of the comment.
NOTE: uncrustify.cfg should *ONLY* be used with new files that have an
inconsistent coding style. uncrustify.cfg should get you in the ballpark,
but you should expect to review and hand-edit the files to assume 100%
compliance.
WARNING: *NEVER* use uncrustify.cfg for modifications to existing NuttX
files. It will probably corrupt the style in subtle ways!
This was last verified against uncrustify 0.66.1 by Bob Feretich.
About uncrustify: Uncrustify is a highly configurable, easily modifiable