X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=doc%2Fmanual%2Fstyle.txt;h=54c1342e64d47165cb60d990574b2b67cef06518;hb=288a1f453d2c786332946f16d5610950daeb83e5;hp=71bb5f6bc18243d5759eba60dcf2bf5773cba519;hpb=060980357df2f71b8d18eb6a86a8c9878a8b417e;p=openocd.git diff --git a/doc/manual/style.txt b/doc/manual/style.txt index 71bb5f6bc1..54c1342e64 100644 --- a/doc/manual/style.txt +++ b/doc/manual/style.txt @@ -77,7 +77,7 @@ Finally, try to avoid lines of code that are longer than than 72-80 columns: - inline functions - @c // comments -- in new code, prefer these for single-line comments - trailing comma allowed in enum declarations -- designated initializers (@{ .field = value @}) +- designated initializers ( .field = value ) - variables declarations should occur at the point of first use - new block scopes for selection and iteration statements - use malloc() to create dynamic arrays. Do @b not use @c alloca @@ -308,7 +308,7 @@ For technical reference material: - Else it's a "Config Command" if it must be used before the configuration stage completes. - For a "Driver", list its name. - - Use BNF style regular expressions to define parameters: + - Use EBNF style regular expressions to define parameters: brackets around zero-or-one choices, parentheses around exactly-one choices. - Use \@option, \@file, \@var and other mechanisms where appropriate. @@ -370,7 +370,7 @@ Maintainers must also be sure to follow additional guidelines: This page contains style guidelines for the OpenOCD autotools scripts. -The following guidelines apply to the @c configure.in file: +The following guidelines apply to the @c configure.ac file: - Better guidelines need to be developed, but until then... - Use good judgement.