summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorMark Whitley2001-02-03 00:20:14 +0000
committerMark Whitley2001-02-03 00:20:14 +0000
commit925edb828df9665714d2ce71a6ef8242bbf4eb15 (patch)
tree68168437ab047f5ca43131ad9a890744b0d5be62 /docs
parentc3fc3c5e7a35f96f23a543d0886b5297c49d565c (diff)
downloadbusybox-925edb828df9665714d2ce71a6ef8242bbf4eb15.zip
busybox-925edb828df9665714d2ce71a6ef8242bbf4eb15.tar.gz
Added some more on paren spacing and a section on testing guidelines.
Diffstat (limited to 'docs')
-rw-r--r--docs/style-guide.txt40
1 files changed, 38 insertions, 2 deletions
diff --git a/docs/style-guide.txt b/docs/style-guide.txt
index 1a04e44..ee7547f 100644
--- a/docs/style-guide.txt
+++ b/docs/style-guide.txt
@@ -107,23 +107,26 @@ between it and the opening control block statement. Examples:
Don't do this either:
while (!done){
+
do{
And for heaven's sake, don't do this:
while (!done)
{
+
do
{
Do this instead:
while (!done) {
+
do {
-Paren Spacing
-~~~~~~~~~~~~~
+Spacing around Parentheses
+~~~~~~~~~~~~~~~~~~~~~~~~~~
Put a space between C keywords and left parens, but not between
function names and the left paren that starts it's parameter list (whether it
@@ -145,6 +148,19 @@ is being declared or called). Examples:
...
baz = my_func(1, 2);
+Also, don't put a space between the left paren and the first term, nor between
+the last arg and the right paren.
+
+ Don't do this:
+
+ if ( x < 1 )
+ strcmp( thisstr, thatstr )
+
+ Do this instead:
+
+ if (x < 1)
+ strcmp(thisstr, thatstr)
+
Cuddled Elses
~~~~~~~~~~~~~
@@ -583,3 +599,23 @@ illustrates emphasizing logical blocks:
/* clean up */
free(line);
}
+
+
+Testing Guidelines
+~~~~~~~~~~~~~~~~~~
+
+It's considered good form to test your new feature before you submit a patch
+to the mailing list, and especially before you commit a change to CVS. Here
+are some guildlines on testing your changes.
+
+ - Always test busybox grep against GNU grep and make sure the behavior /
+ output is identical between the two.
+
+ - Try several different permutations and combinations of the features you're
+ adding and make sure they all work. (Make sure one feature does not
+ interfere with another, etc.)
+
+ - Make sure you test compiling against the source both with the feature
+ turned on and turned off in Config.h and make sure busybox compiles cleanly
+ both ways.
+