X-Git-Url: http://git.openafs.org/?p=openafs.git;a=blobdiff_plain;f=README.DEVEL;h=f775c0b12f3f084a3471a4bdec856406413587a6;hp=af83ca3bf0900102fa095585cd32937325f097b1;hb=64a305971f984184e17d45592da72b607f0ab724;hpb=50ed43bfb45202fb288130c0e716db013391d855 diff --git a/README.DEVEL b/README.DEVEL index af83ca3..f775c0b 100644 --- a/README.DEVEL +++ b/README.DEVEL @@ -7,8 +7,8 @@ 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. +Do not use $< for non-pattern rules in any cross-platform dir as it +requires a reasonable make that is not available on all systems. Do not have build rules that build multiple targets. Make doesn't seem able to handle this, and it interferes with -j builds. (In particular, build the @@ -50,7 +50,8 @@ The declaration of the routines should be done in ANSI style. If at some later date, it is determined that prototypes don't work on some platform properly, we can use ansi2knr during the compile. - rettype routine(argtype arg) + rettype + routine(argtype arg) { } @@ -70,6 +71,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.