X-Git-Url: http://git.openafs.org/?p=openafs.git;a=blobdiff_plain;f=README.DEVEL;h=3c3d2b9704d2efe162705974304d87a4a63945fd;hp=e4354dd6ea2dadb87766c688830904e50c70d556;hb=bc9c0a14154639d8e45554a3abeb867af9a8d0b2;hpb=a32bbb929bcb5988af419ea03640f2220c22c330 diff --git a/README.DEVEL b/README.DEVEL index e4354dd..3c3d2b9 100644 --- a/README.DEVEL +++ b/README.DEVEL @@ -1,6 +1,12 @@ Notes on Coding Standards/Requirements for OpenAFS Source --------------------------------------------------------- +We have an official style. Please use it. If you have gnu indent 2.2.9 or +later you can reformat for this style with the following option: + +-npro -nbad -bap -nbc -bbo -br -ce -cdw -brs -ncdb -cp1 -ncs -di2 -ndj -nfc1 +-nfca -i4 -lp -npcs -nprs -psl -sc -nsob -ts8 + Do not use $< in any cross-platform dir as it requires a reasonable make that is not available on all systems. @@ -64,6 +70,9 @@ Compiles on gcc-using machines should strive to handle using Routines shall be defined in source prior to use if possible, and prototyped in block at top of file if static. +API documentation in the code should be done using Qt-style Doxygen +comments. + If you make a routine or variable static, be sure and remove it from the AIX .exp files.