From be6115724634fe18db0c40d5cf7c1f4652fc9024 Mon Sep 17 00:00:00 2001 From: Gregory Nutt Date: Wed, 11 Apr 2018 14:39:54 -0600 Subject: [PATCH] Update README. --- tools/README.txt | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/tools/README.txt b/tools/README.txt index aedb9954e6..e78444e7ef 100644 --- a/tools/README.txt +++ b/tools/README.txt @@ -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