Updated some of the documentation
This commit is contained in:
@@ -3,11 +3,11 @@ different compilers; here are some rules for writing code that will work
|
||||
on multiple platforms.
|
||||
|
||||
Regarding tabs, indenting, and code style, we run:
|
||||
$ indent -kr -nut -nlp -ip4 -cli4 -bfda -nbc -nbbo -c0 -cd0 -cp0 -di0 -l79 filename.c
|
||||
$ clang-format -i -style=file -fallback-style=none filename.c
|
||||
on the code prior to releasing it. This ensures a standard look and feel
|
||||
to the code regardless of the authors preferred style. You may certainly
|
||||
adjust the code to your preferred style using an indent tool. We use the
|
||||
script indent.sh to adjust all the .c and .h files.
|
||||
"make pretty" to adjust all the .c and .h files.
|
||||
|
||||
For variable names, separate words within the variables by underscores.
|
||||
Do not use capital letters as separators. Consider how much harder
|
||||
@@ -233,3 +233,5 @@ header file, and the dependent routine is placed in a ports directory.
|
||||
Reference: The cross platform aspect of this coding standard is based
|
||||
on the developer coding standard for Ethereal/Wireshark and has been
|
||||
modified by Steve Karg for this project. Thank you, Ethereal/Wireshark!
|
||||
The naming convention is based on the writings of Jack Ganssle. Thank you,
|
||||
Jack!
|
||||
|
||||
Reference in New Issue
Block a user