procps/Documentation/CodingStyle
Jim Warner 421b08a4df all: fix misspellings in docs and program comments
We might as well join the coreutils and util-linux
projects in correcting our own typos.

The following was left unchanged:
   top/top.c[1797]: thru -> "through"

references:
http://lists.gnu.org/archive/html/coreutils/2012-04/msg00057.html
http://marc.info/?l=util-linux-ng&m=133518057419736&w=2

Signed-off-by: Jim Warner <james.warner@comcast.net>
2012-04-25 13:46:02 +10:00

28 lines
1.2 KiB
Plaintext

Most developers find Linux coding style easy to read, and there is
really no reason to reinvent this practise, so procps-ng goes along
with others.
http://git.kernel.org/?p=linux/kernel/git/torvalds/linux-2.6.git;a=blob_plain;f=Documentation/CodingStyle
In addtion to Linux coding style this project has few additional
wishes to contributors.
* Many small patches are favoured over one big. Break down is done on
basis of logical functionality; for example #endif mark ups,
compiler warning and exit codes fixes all should be individual
small patches.
* Use 'FIXME: ' in code comments, manual pages, autotools files,
scripts and so on to indicate something is wrong. The reason we do
is as simple as being able to find easily where problem areas are.
* In writing arithmetic comparisons, use "<" and "<=" rather than
">" and ">=". For some justification, read this:
http://thread.gmane.org/gmane.comp.version-control.git/3903/focus=4126
* Be nice to translators. Don't change translatable strings if you
can avoid it. If you must rearrange individual lines (e.g., in
multi-line --help strings), extract and create new strings, rather
than extracting and moving into existing blocks. This avoids
making unnecessary work for translators.