X-Git-Url: https://git.openafs.org/?p=openafs.git;a=blobdiff_plain;f=README.DEVEL;h=b7b57a8c957c9bbb2262e33ba70dafcbf2065271;hp=d39cbc6594495895e0931371f22ed60c3b6470c8;hb=8105129987e2848f21247eea4103ae31772d68be;hpb=4042667388406e540c8a6546031d514793ffc8c4 diff --git a/README.DEVEL b/README.DEVEL index d39cbc6..b7b57a8 100644 --- a/README.DEVEL +++ b/README.DEVEL @@ -34,7 +34,7 @@ Format of the prototype files should look like: #ifndef AFS_SRC_DDD_PROTO_H #define AFS_SRC_DDD_PROTO_H - + /* filename.c */ prototypes @@ -47,10 +47,10 @@ In most of the existing prototypes, the define is DDD_PROTOTYPES_H, which is probably ok as well. 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 +later date, it is determined that prototypes don't work on some platform properly, we can use ansi2knr during the compile. - rettype + rettype routine(argtype arg) { @@ -62,13 +62,13 @@ and should have (void) if no arguments are taken. Header files should not contain macros or other definitions unless they are used across multiple source files. -All routines should be declared static if they are not used outside that +All routines should be declared static if they are not used outside that source file. Compiles on gcc-using machines should strive to handle using -Wstrict-prototypes -Werror. (this may take a while) -Routines shall be defined in source prior to use if possible, and +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