CODING: discuss indentation for non-C files

Right now, that's just Makefile and plain text.
We'll want to add more eventually.

Change-Id: I10c559fe94c7c634e1de6d98020a1c7a391da2b4
Reviewed-on: https://gerrit.openafs.org/15629
Reviewed-by: Michael Meffie <mmeffie@sinenomine.net>
Reviewed-by: Mark Vitale <mvitale@sinenomine.net>
Reviewed-by: Cheyenne Wills <cwills@sinenomine.net>
Reviewed-by: Benjamin Kaduk <kaduk@mit.edu>
Tested-by: Benjamin Kaduk <kaduk@mit.edu>
This commit is contained in:
Benjamin Kaduk 2024-01-14 15:45:55 -08:00
parent eff7ef1f98
commit 665e30f74d

12
CODING
View File

@ -9,8 +9,9 @@ review to cover, and discusses how we handle compiler warnings.
Prototyping and Style
=====================
We have an official style. Please use it. If you have gnu indent 2.2.9 or
later you can format new files for this style with the following options:
We have an official style for C code. Please use it. If you have gnu indent
2.2.9 or later you can format new files for this style with the following
options:
-npro -nbad -bap -nbc -bbo -br -ce -cdw -brs -ncdb -cp1 -ncs -di2 -ndj -nfc1
-nfca -i4 -lp -npcs -nprs -psl -sc -nsob -ts8
@ -21,6 +22,13 @@ initial style cleanup commit before making sweeping changes to a given
file, and otherwise try to accommodate the prevailing style in the file
when making minor changes.
The style for non-C code varies. Makefiles must use literal tabs to
indent rule bodies, but use spaces for any additional indentation
needed. Plain text files (such as this one) should use spaces for
indentation, with a 4-space indent as the default when one is needed.
Other cases will be added here as they are encountered and a consensus
determined for how to handle them.
Prototypes for all source files in a given dir DDD should be placed
in the file DDD/DDD_prototypes.h. All externally used (either API
or used by other source files) routines and variables should be