home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 9 / FreshFishVol9-CD2.bin / bbs / gnu / gdb-4.14-src.lha / gdb-4.14 / etc / standards.info-1 < prev    next >
Encoding:
GNU Info File  |  1995-03-04  |  48.1 KB  |  1,226 lines
  1. This is Info file standards.info, produced by Makeinfo-1.55 from the
  2. input file ./standards.texi.
  3.  
  4. START-INFO-DIR-ENTRY
  5. * Standards: (standards).        GNU coding standards.
  6. END-INFO-DIR-ENTRY
  7.  
  8.    GNU Coding Standards Copyright (C) 1992, 1993, 1994 Free Software
  9. Foundation
  10.  
  11.    Permission is granted to make and distribute verbatim copies of this
  12. manual provided the copyright notice and this permission notice are
  13. preserved on all copies.
  14.  
  15.    Permission is granted to copy and distribute modified versions of
  16. this manual under the conditions for verbatim copying, provided that
  17. the entire resulting derived work is distributed under the terms of a
  18. permission notice identical to this one.
  19.  
  20.    Permission is granted to copy and distribute translations of this
  21. manual into another language, under the above conditions for modified
  22. versions, except that this permission notice may be stated in a
  23. translation approved by the Free Software Foundation.
  24.  
  25. 
  26. File: standards.info,  Node: Top,  Next: Reading Non-Free Code,  Prev: (dir),  Up: (dir)
  27.  
  28. Version
  29. *******
  30.  
  31.    Last updated 28 March 1994.
  32.  
  33. * Menu:
  34.  
  35. * Reading Non-Free Code::    Referring to Proprietary Programs
  36. * Contributions::        Accepting Contributions
  37. * Change Logs::            Recording Changes
  38. * Compatibility::        Compatibility with Other Implementations
  39. * Makefile Conventions::    Makefile Conventions
  40. * Configuration::        How Configuration Should Work
  41. * Source Language::        Using Languages Other Than C
  42. * Formatting::            Formatting Your Source Code
  43. * Comments::            Commenting Your Work
  44. * Syntactic Conventions::    Clean Use of C Constructs
  45. * Names::            Naming Variables and Functions
  46. * Using Extensions::        Using Non-standard Features
  47. * System Functions::            Portability and "standard" library functions
  48. * Semantics::            Program Behavior for All Programs
  49. * Errors::            Formatting Error Messages
  50. * Libraries::            Library Behavior
  51. * Portability::            Portability As It Applies to GNU
  52. * User Interfaces::        Standards for Command Line Interfaces
  53. * Documentation::        Documenting Programs
  54. * Releases::            Making Releases
  55.  
  56. 
  57. File: standards.info,  Node: Reading Non-Free Code,  Next: Contributions,  Prev: Top,  Up: Top
  58.  
  59. Referring to Proprietary Programs
  60. *********************************
  61.  
  62.    Don't in any circumstances refer to Unix source code for or during
  63. your work on GNU!  (Or to any other proprietary programs.)
  64.  
  65.    If you have a vague recollection of the internals of a Unix program,
  66. this does not absolutely mean you can't write an imitation of it, but
  67. do try to organize the imitation internally along different lines,
  68. because this is likely to make the details of the Unix version
  69. irrelevant and dissimilar to your results.
  70.  
  71.    For example, Unix utilities were generally optimized to minimize
  72. memory use; if you go for speed instead, your program will be very
  73. different.  You could keep the entire input file in core and scan it
  74. there instead of using stdio.  Use a smarter algorithm discovered more
  75. recently than the Unix program.  Eliminate use of temporary files.  Do
  76. it in one pass instead of two (we did this in the assembler).
  77.  
  78.    Or, on the contrary, emphasize simplicity instead of speed.  For some
  79. applications, the speed of today's computers makes simpler algorithms
  80. adequate.
  81.  
  82.    Or go for generality.  For example, Unix programs often have static
  83. tables or fixed-size strings, which make for arbitrary limits; use
  84. dynamic allocation instead.  Make sure your program handles NULs and
  85. other funny characters in the input files.  Add a programming language
  86. for extensibility and write part of the program in that language.
  87.  
  88.    Or turn some parts of the program into independently usable
  89. libraries.  Or use a simple garbage collector instead of tracking
  90. precisely when to free memory, or use a new GNU facility such as
  91. obstacks.
  92.  
  93. 
  94. File: standards.info,  Node: Contributions,  Next: Change Logs,  Prev: Reading Non-Free Code,  Up: Top
  95.  
  96. Accepting Contributions
  97. ***********************
  98.  
  99.    If someone else sends you a piece of code to add to the program you
  100. are working on, we need legal papers to use it--the same sort of legal
  101. papers we will need to get from you.  *Each* significant contributor to
  102. a program must sign some sort of legal papers in order for us to have
  103. clear title to the program.  The main author alone is not enough.
  104.  
  105.    So, before adding in any contributions from other people, tell us so
  106. we can arrange to get the papers.  Then wait until we tell you that we
  107. have received the signed papers, before you actually use the
  108. contribution.
  109.  
  110.    This applies both before you release the program and afterward.  If
  111. you receive diffs to fix a bug, and they make significant change, we
  112. need legal papers for it.
  113.  
  114.    You don't need papers for changes of a few lines here or there, since
  115. they are not significant for copyright purposes.  Also, you don't need
  116. papers if all you get from the suggestion is some ideas, not actual code
  117. which you use.  For example, if you write a different solution to the
  118. problem, you don't need to get papers.
  119.  
  120.    I know this is frustrating; it's frustrating for us as well.  But if
  121. you don't wait, you are going out on a limb--for example, what if the
  122. contributor's employer won't sign a disclaimer?  You might have to take
  123. that code out again!
  124.  
  125.    The very worst thing is if you forget to tell us about the other
  126. contributor.  We could be very embarrassed in court some day as a
  127. result.
  128.  
  129. 
  130. File: standards.info,  Node: Change Logs,  Next: Compatibility,  Prev: Contributions,  Up: Top
  131.  
  132. Change Logs
  133. ***********
  134.  
  135.    Keep a change log for each directory, describing the changes made to
  136. source files in that directory.  The purpose of this is so that people
  137. investigating bugs in the future will know about the changes that might
  138. have introduced the bug.  Often a new bug can be found by looking at
  139. what was recently changed.  More importantly, change logs can help
  140. eliminate conceptual inconsistencies between different parts of a
  141. program; they can give you a history of how the conflicting concepts
  142. arose.
  143.  
  144.    Use the Emacs command `M-x add-change' to start a new entry in the
  145. change log.  An entry should have an asterisk, the name of the changed
  146. file, and then in parentheses the name of the changed functions,
  147. variables or whatever, followed by a colon.  Then describe the changes
  148. you made to that function or variable.
  149.  
  150.    Separate unrelated entries with blank lines.  When two entries
  151. represent parts of the same change, so that they work together, then
  152. don't put blank lines between them.  Then you can omit the file name
  153. and the asterisk when successive entries are in the same file.
  154.  
  155.    Here are some examples:
  156.  
  157.      * register.el (insert-register): Return nil.
  158.      (jump-to-register): Likewise.
  159.      
  160.      * sort.el (sort-subr): Return nil.
  161.      
  162.      * tex-mode.el (tex-bibtex-file, tex-file, tex-region):
  163.      Restart the tex shell if process is gone or stopped.
  164.      (tex-shell-running): New function.
  165.      
  166.      * expr.c (store_one_arg): Round size up for move_block_to_reg.
  167.      (expand_call): Round up when emitting USE insns.
  168.      * stmt.c (assign_parms): Round size up for move_block_from_reg.
  169.  
  170.    It's important to name the changed function or variable in full.
  171. Don't abbreviate them; don't combine them.  Subsequent maintainers will
  172. often search for a function name to find all the change log entries that
  173. pertain to it; if you abbreviate the name, they won't find it when they
  174. search.  For example, some people are tempted to abbreviate groups of
  175. function names by writing `* register.el ({insert,jump-to}-register)';
  176. this is not a good idea, since searching for `jump-to-register' or
  177. `insert-register' would not find the entry.
  178.  
  179.    There's no need to describe the full purpose of the changes or how
  180. they work together.  It is better to put such explanations in comments
  181. in the code.  That's why just "New function" is enough; there is a
  182. comment with the function in the source to explain what it does.
  183.  
  184.    However, sometimes it is useful to write one line to describe the
  185. overall purpose of a large batch of changes.
  186.  
  187.    You can think of the change log as a conceptual "undo list" which
  188. explains how earlier versions were different from the current version.
  189. People can see the current version; they don't need the change log to
  190. tell them what is in it.  What they want from a change log is a clear
  191. explanation of how the earlier version differed.
  192.  
  193.    When you change the calling sequence of a function in a simple
  194. fashion, and you change all the callers of the function, there is no
  195. need to make individual entries for all the callers.  Just write in the
  196. entry for the function being called, "All callers changed."
  197.  
  198.    When you change just comments or doc strings, it is enough to write
  199. an entry for the file, without mentioning the functions.  Write just,
  200. "Doc fix."  There's no need to keep a change log for documentation
  201. files.  This is because documentation is not susceptible to bugs that
  202. are hard to fix.  Documentation does not consist of parts that must
  203. interact in a precisely engineered fashion; to correct an error, you
  204. need not know the history of the erroneous passage.
  205.  
  206. 
  207. File: standards.info,  Node: Compatibility,  Next: Makefile Conventions,  Prev: Change Logs,  Up: Top
  208.  
  209. Compatibility with Other Implementations
  210. ****************************************
  211.  
  212.    With certain exceptions, utility programs and libraries for GNU
  213. should be upward compatible with those in Berkeley Unix, and upward
  214. compatible with ANSI C if ANSI C specifies their behavior, and upward
  215. compatible with POSIX if POSIX specifies their behavior.
  216.  
  217.    When these standards conflict, it is useful to offer compatibility
  218. modes for each of them.
  219.  
  220.    ANSI C and POSIX prohibit many kinds of extensions.  Feel free to
  221. make the extensions anyway, and include a `--ansi' or `--compatible'
  222. option to turn them off.  However, if the extension has a significant
  223. chance of breaking any real programs or scripts, then it is not really
  224. upward compatible.  Try to redesign its interface.
  225.  
  226.    Many GNU programs suppress extensions that conflict with POSIX if the
  227. environment variable `POSIXLY_CORRECT' is defined (even if it is
  228. defined with a null value).  Please make your program recognize this
  229. variable if appropriate.
  230.  
  231.    When a feature is used only by users (not by programs or command
  232. files), and it is done poorly in Unix, feel free to replace it
  233. completely with something totally different and better.  (For example,
  234. vi is replaced with Emacs.)  But it is nice to offer a compatible
  235. feature as well.  (There is a free vi clone, so we offer it.)
  236.  
  237.    Additional useful features not in Berkeley Unix are welcome.
  238. Additional programs with no counterpart in Unix may be useful, but our
  239. first priority is usually to duplicate what Unix already has.
  240.  
  241. 
  242. File: standards.info,  Node: Makefile Conventions,  Next: Configuration,  Prev: Compatibility,  Up: Top
  243.  
  244. Makefile Conventions
  245. ********************
  246.  
  247.    This chapter describes conventions for writing the Makefiles for GNU
  248. programs.
  249.  
  250. * Menu:
  251.  
  252. * Makefile Basics::
  253. * Utilities in Makefiles::
  254. * Standard Targets::
  255. * Command Variables::
  256. * Directory Variables::
  257.  
  258. 
  259. File: standards.info,  Node: Makefile Basics,  Next: Utilities in Makefiles,  Up: Makefile Conventions
  260.  
  261. General Conventions for Makefiles
  262. =================================
  263.  
  264.    Every Makefile should contain this line:
  265.  
  266.      SHELL = /bin/sh
  267.  
  268. to avoid trouble on systems where the `SHELL' variable might be
  269. inherited from the environment.  (This is never a problem with GNU
  270. `make'.)
  271.  
  272.    Don't assume that `.' is in the path for command execution.  When
  273. you need to run programs that are a part of your package during the
  274. make, please make sure that it uses `./' if the program is built as
  275. part of the make or `$(srcdir)/' if the file is an unchanging part of
  276. the source code.  Without one of these prefixes, the current search
  277. path is used.
  278.  
  279.    The distinction between `./' and `$(srcdir)/' is important when
  280. using the `--srcdir' option to `configure'.  A rule of the form:
  281.  
  282.      foo.1 : foo.man sedscript
  283.              sed -e sedscript foo.man > foo.1
  284.  
  285. will fail when the current directory is not the source directory,
  286. because `foo.man' and `sedscript' are not in the current directory.
  287.  
  288.    When using GNU `make', relying on `VPATH' to find the source file
  289. will work in the case where there is a single dependency file, since
  290. the `make' automatic variable `$<' will represent the source file
  291. wherever it is.  (Many versions of `make' set `$<' only in implicit
  292. rules.)  A makefile target like
  293.  
  294.      foo.o : bar.c
  295.              $(CC) -I. -I$(srcdir) $(CFLAGS) -c bar.c -o foo.o
  296.  
  297. should instead be written as
  298.  
  299.      foo.o : bar.c
  300.              $(CC) $(CFLAGS) $< -o $@
  301.  
  302. in order to allow `VPATH' to work correctly.  When the target has
  303. multiple dependencies, using an explicit `$(srcdir)' is the easiest way
  304. to make the rule work well.  For example, the target above for `foo.1'
  305. is best written as:
  306.  
  307.      foo.1 : foo.man sedscript
  308.              sed -s $(srcdir)/sedscript $(srcdir)/foo.man > foo.1
  309.  
  310. 
  311. File: standards.info,  Node: Utilities in Makefiles,  Next: Standard Targets,  Prev: Makefile Basics,  Up: Makefile Conventions
  312.  
  313. Utilities in Makefiles
  314. ======================
  315.  
  316.    Write the Makefile commands (and any shell scripts, such as
  317. `configure') to run in `sh', not in `csh'.  Don't use any special
  318. features of `ksh' or `bash'.
  319.  
  320.    The `configure' script and the Makefile rules for building and
  321. installation should not use any utilities directly except these:
  322.  
  323.      cat cmp cp echo egrep expr grep
  324.      ln mkdir mv pwd rm rmdir sed test touch
  325.  
  326.    Stick to the generally supported options for these programs.  For
  327. example, don't use `mkdir -p', convenient as it may be, because most
  328. systems don't support it.
  329.  
  330.    The Makefile rules for building and installation can also use
  331. compilers and related programs, but should do so via `make' variables
  332. so that the user can substitute alternatives.  Here are some of the
  333. programs we mean:
  334.  
  335.      ar bison cc flex install ld lex
  336.      make makeinfo ranlib texi2dvi yacc
  337.  
  338.    When you use `ranlib', you should test whether it exists, and run it
  339. only if it exists, so that the distribution will work on systems that
  340. don't have `ranlib'.
  341.  
  342.    If you use symbolic links, you should implement a fallback for
  343. systems that don't have symbolic links.
  344.  
  345.    It is ok to use other utilities in Makefile portions (or scripts)
  346. intended only for particular systems where you know those utilities to
  347. exist.
  348.  
  349. 
  350. File: standards.info,  Node: Standard Targets,  Next: Command Variables,  Prev: Utilities in Makefiles,  Up: Makefile Conventions
  351.  
  352. Standard Targets for Users
  353. ==========================
  354.  
  355.    All GNU programs should have the following targets in their
  356. Makefiles:
  357.  
  358. `all'
  359.      Compile the entire program.  This should be the default target.
  360.      This target need not rebuild any documentation files; Info files
  361.      should normally be included in the distribution, and DVI files
  362.      should be made only when explicitly asked for.
  363.  
  364. `install'
  365.      Compile the program and copy the executables, libraries, and so on
  366.      to the file names where they should reside for actual use.  If
  367.      there is a simple test to verify that a program is properly
  368.      installed, this target should run that test.
  369.  
  370.      The commands should create all the directories in which files are
  371.      to be installed, if they don't already exist.  This includes the
  372.      directories specified as the values of the variables `prefix' and
  373.      `exec_prefix', as well as all subdirectories that are needed.  One
  374.      way to do this is by means of an `installdirs' target as described
  375.      below.
  376.  
  377.      Use `-' before any command for installing a man page, so that
  378.      `make' will ignore any errors.  This is in case there are systems
  379.      that don't have the Unix man page documentation system installed.
  380.  
  381.      The way to install Info files is to copy them into `$(infodir)'
  382.      with `$(INSTALL_DATA)' (*note Command Variables::.), and then run
  383.      the `install-info' program if it is present.  `install-info' is a
  384.      script that edits the Info `dir' file to add or update the menu
  385.      entry for the given Info file; it will be part of the Texinfo
  386.      package.  Here is a sample rule to install an Info file:
  387.  
  388.           $(infodir)/foo.info: foo.info
  389.           # There may be a newer info file in . than in srcdir.
  390.                   -if test -f foo.info; then d=.; \
  391.                    else d=$(srcdir); fi; \
  392.                   $(INSTALL_DATA) $$d/foo.info $@; \
  393.           # Run install-info only if it exists.
  394.           # Use `if' instead of just prepending `-' to the
  395.           # line so we notice real errors from install-info.
  396.           # We use `$(SHELL) -c' because some shells do not
  397.           # fail gracefully when there is an unknown command.
  398.                   if $(SHELL) -c 'install-info --version' \
  399.                      >/dev/null 2>&1; then \
  400.                     install-info --infodir=$(infodir) $$d/foo.info; \
  401.                   else true; fi
  402.  
  403. `uninstall'
  404.      Delete all the installed files that the `install' target would
  405.      create (but not the noninstalled files such as `make all' would
  406.      create).
  407.  
  408. `clean'
  409.      Delete all files from the current directory that are normally
  410.      created by building the program.  Don't delete the files that
  411.      record the configuration.  Also preserve files that could be made
  412.      by building, but normally aren't because the distribution comes
  413.      with them.
  414.  
  415.      Delete `.dvi' files here if they are not part of the distribution.
  416.  
  417. `distclean'
  418.      Delete all files from the current directory that are created by
  419.      configuring or building the program.  If you have unpacked the
  420.      source and built the program without creating any other files,
  421.      `make distclean' should leave only the files that were in the
  422.      distribution.
  423.  
  424. `mostlyclean'
  425.      Like `clean', but may refrain from deleting a few files that people
  426.      normally don't want to recompile.  For example, the `mostlyclean'
  427.      target for GCC does not delete `libgcc.a', because recompiling it
  428.      is rarely necessary and takes a lot of time.
  429.  
  430. `realclean'
  431.      Delete everything from the current directory that can be
  432.      reconstructed with this Makefile.  This typically includes
  433.      everything deleted by `distclean', plus more: C source files
  434.      produced by Bison, tags tables, Info files, and so on.
  435.  
  436.      One exception, however: `make realclean' should not delete
  437.      `configure' even if `configure' can be remade using a rule in the
  438.      Makefile.  More generally, `make realclean' should not delete
  439.      anything that needs to exist in order to run `configure' and then
  440.      begin to build the program.
  441.  
  442. `TAGS'
  443.      Update a tags table for this program.
  444.  
  445. `info'
  446.      Generate any Info files needed.  The best way to write the rules
  447.      is as follows:
  448.  
  449.           info: foo.info
  450.           
  451.           foo.info: foo.texi chap1.texi chap2.texi
  452.                   $(MAKEINFO) $(srcdir)/foo.texi
  453.  
  454.      You must define the variable `MAKEINFO' in the Makefile.  It should
  455.      run the `makeinfo' program, which is part of the Texinfo
  456.      distribution.
  457.  
  458. `dvi'
  459.      Generate DVI files for all TeXinfo documentation.  For example:
  460.  
  461.           dvi: foo.dvi
  462.           
  463.           foo.dvi: foo.texi chap1.texi chap2.texi
  464.                   $(TEXI2DVI) $(srcdir)/foo.texi
  465.  
  466.      You must define the variable `TEXI2DVI' in the Makefile.  It should
  467.      run the program `texi2dvi', which is part of the Texinfo
  468.      distribution.  Alternatively, write just the dependencies, and
  469.      allow GNU Make to provide the command.
  470.  
  471. `dist'
  472.      Create a distribution tar file for this program.  The tar file
  473.      should be set up so that the file names in the tar file start with
  474.      a subdirectory name which is the name of the package it is a
  475.      distribution for.  This name can include the version number.
  476.  
  477.      For example, the distribution tar file of GCC version 1.40 unpacks
  478.      into a subdirectory named `gcc-1.40'.
  479.  
  480.      The easiest way to do this is to create a subdirectory
  481.      appropriately named, use `ln' or `cp' to install the proper files
  482.      in it, and then `tar' that subdirectory.
  483.  
  484.      The `dist' target should explicitly depend on all non-source files
  485.      that are in the distribution, to make sure they are up to date in
  486.      the distribution.  *Note Making Releases: (standards)Releases.
  487.  
  488. `check'
  489.      Perform self-tests (if any).  The user must build the program
  490.      before running the tests, but need not install the program; you
  491.      should write the self-tests so that they work when the program is
  492.      built but not installed.
  493.  
  494.    The following targets are suggested as conventional names, for
  495. programs in which they are useful.
  496.  
  497. `installcheck'
  498.      Perform installation tests (if any).  The user must build and
  499.      install the program before running the tests.  You should not
  500.      assume that `$(bindir)' is in the search path.
  501.  
  502. `installdirs'
  503.      It's useful to add a target named `installdirs' to create the
  504.      directories where files are installed, and their parent
  505.      directories.  There is a script called `mkinstalldirs' which is
  506.      convenient for this; find it in the Texinfo package.You can use a
  507.      rule like this:
  508.  
  509.           # Make sure all installation directories (e.g. $(bindir))
  510.           # actually exist by making them if necessary.
  511.           installdirs: mkinstalldirs
  512.                   $(srcdir)/mkinstalldirs $(bindir) $(datadir) \
  513.                                           $(libdir) $(infodir) \
  514.                                           $(mandir)
  515.  
  516. 
  517. File: standards.info,  Node: Command Variables,  Next: Directory Variables,  Prev: Standard Targets,  Up: Makefile Conventions
  518.  
  519. Variables for Specifying Commands
  520. =================================
  521.  
  522.    Makefiles should provide variables for overriding certain commands,
  523. options, and so on.
  524.  
  525.    In particular, you should run most utility programs via variables.
  526. Thus, if you use Bison, have a variable named `BISON' whose default
  527. value is set with `BISON = bison', and refer to it with `$(BISON)'
  528. whenever you need to use Bison.
  529.  
  530.    File management utilities such as `ln', `rm', `mv', and so on, need
  531. not be referred to through variables in this way, since users don't
  532. need to replace them with other programs.
  533.  
  534.    Each program-name variable should come with an options variable that
  535. is used to supply options to the program.  Append `FLAGS' to the
  536. program-name variable name to get the options variable name--for
  537. example, `BISONFLAGS'.  (The name `CFLAGS' is an exception to this
  538. rule, but we keep it because it is standard.)  Use `CPPFLAGS' in any
  539. compilation command that runs the preprocessor, and use `LDFLAGS' in
  540. any compilation command that does linking as well as in any direct use
  541. of `ld'.
  542.  
  543.    If there are C compiler options that *must* be used for proper
  544. compilation of certain files, do not include them in `CFLAGS'.  Users
  545. expect to be able to specify `CFLAGS' freely themselves.  Instead,
  546. arrange to pass the necessary options to the C compiler independently
  547. of `CFLAGS', by writing them explicitly in the compilation commands or
  548. by defining an implicit rule, like this:
  549.  
  550.      CFLAGS = -g
  551.      ALL_CFLAGS = -I. $(CFLAGS)
  552.      .c.o:
  553.              $(CC) -c $(CPPFLAGS) $(ALL_CFLAGS) $<
  554.  
  555.    Do include the `-g' option in `CFLAGS', because that is not
  556. *required* for proper compilation.  You can consider it a default that
  557. is only recommended.  If the package is set up so that it is compiled
  558. with GCC by default, then you might as well include `-O' in the default
  559. value of `CFLAGS' as well.
  560.  
  561.    Put `CFLAGS' last in the compilation command, after other variables
  562. containing compiler options, so the user can use `CFLAGS' to override
  563. the others.
  564.  
  565.    Every Makefile should define the variable `INSTALL', which is the
  566. basic command for installing a file into the system.
  567.  
  568.    Every Makefile should also define the variables `INSTALL_PROGRAM'
  569. and `INSTALL_DATA'.  (The default for each of these should be
  570. `$(INSTALL)'.)  Then it should use those variables as the commands for
  571. actual installation, for executables and nonexecutables respectively.
  572. Use these variables as follows:
  573.  
  574.      $(INSTALL_PROGRAM) foo $(bindir)/foo
  575.      $(INSTALL_DATA) libfoo.a $(libdir)/libfoo.a
  576.  
  577. Always use a file name, not a directory name, as the second argument of
  578. the installation commands.  Use a separate command for each file to be
  579. installed.
  580.  
  581. 
  582. File: standards.info,  Node: Directory Variables,  Prev: Command Variables,  Up: Makefile Conventions
  583.  
  584. Variables for Installation Directories
  585. ======================================
  586.  
  587.    Installation directories should always be named by variables, so it
  588. is easy to install in a nonstandard place.  The standard names for these
  589. variables are:
  590.  
  591. `prefix'
  592.      A prefix used in constructing the default values of the variables
  593.      listed below.  The default value of `prefix' should be `/usr/local'
  594.      (at least for now).
  595.  
  596. `exec_prefix'
  597.      A prefix used in constructing the default values of some of the
  598.      variables listed below.  The default value of `exec_prefix' should
  599.      be `$(prefix)'.
  600.  
  601.      Generally, `$(exec_prefix)' is used for directories that contain
  602.      machine-specific files (such as executables and subroutine
  603.      libraries), while `$(prefix)' is used directly for other
  604.      directories.
  605.  
  606. `bindir'
  607.      The directory for installing executable programs that users can
  608.      run.  This should normally be `/usr/local/bin', but write it as
  609.      `$(exec_prefix)/bin'.
  610.  
  611. `libdir'
  612.      The directory for installing executable files to be run by the
  613.      program rather than by users.  Object files and libraries of
  614.      object code should also go in this directory.  The idea is that
  615.      this directory is used for files that pertain to a specific
  616.      machine architecture, but need not be in the path for commands.
  617.      The value of `libdir' should normally be `/usr/local/lib', but
  618.      write it as `$(exec_prefix)/lib'.
  619.  
  620. `datadir'
  621.      The directory for installing read-only data files which the
  622.      programs refer to while they run.  This directory is used for
  623.      files which are independent of the type of machine being used.
  624.      This should normally be `/usr/local/lib', but write it as
  625.      `$(prefix)/lib'.
  626.  
  627. `statedir'
  628.      The directory for installing data files which the programs modify
  629.      while they run.  These files should be independent of the type of
  630.      machine being used, and it should be possible to share them among
  631.      machines at a network installation.  This should normally be
  632.      `/usr/local/lib', but write it as `$(prefix)/lib'.
  633.  
  634. `includedir'
  635.      The directory for installing header files to be included by user
  636.      programs with the C `#include' preprocessor directive.  This
  637.      should normally be `/usr/local/include', but write it as
  638.      `$(prefix)/include'.
  639.  
  640.      Most compilers other than GCC do not look for header files in
  641.      `/usr/local/include'.  So installing the header files this way is
  642.      only useful with GCC.  Sometimes this is not a problem because some
  643.      libraries are only really intended to work with GCC.  But some
  644.      libraries are intended to work with other compilers.  They should
  645.      install their header files in two places, one specified by
  646.      `includedir' and one specified by `oldincludedir'.
  647.  
  648. `oldincludedir'
  649.      The directory for installing `#include' header files for use with
  650.      compilers other than GCC.  This should normally be `/usr/include'.
  651.  
  652.      The Makefile commands should check whether the value of
  653.      `oldincludedir' is empty.  If it is, they should not try to use
  654.      it; they should cancel the second installation of the header files.
  655.  
  656.      A package should not replace an existing header in this directory
  657.      unless the header came from the same package.  Thus, if your Foo
  658.      package provides a header file `foo.h', then it should install the
  659.      header file in the `oldincludedir' directory if either (1) there
  660.      is no `foo.h' there or (2) the `foo.h' that exists came from the
  661.      Foo package.
  662.  
  663.      To tell whether `foo.h' came from the Foo package, put a magic
  664.      string in the file--part of a comment--and grep for that string.
  665.  
  666. `mandir'
  667.      The directory for installing the man pages (if any) for this
  668.      package.  It should include the suffix for the proper section of
  669.      the manual--usually `1' for a utility.  It will normally be
  670.      `/usr/local/man/man1', but you should write it as
  671.      `$(prefix)/man/man1'.
  672.  
  673. `man1dir'
  674.      The directory for installing section 1 man pages.
  675.  
  676. `man2dir'
  677.      The directory for installing section 2 man pages.
  678.  
  679. `...'
  680.      Use these names instead of `mandir' if the package needs to
  681.      install man pages in more than one section of the manual.
  682.  
  683.      *Don't make the primary documentation for any GNU software be a
  684.      man page.  Write a manual in Texinfo instead.  Man pages are just
  685.      for the sake of people running GNU software on Unix, which is a
  686.      secondary application only.*
  687.  
  688. `manext'
  689.      The file name extension for the installed man page.  This should
  690.      contain a period followed by the appropriate digit; it should
  691.      normally be `.1'.
  692.  
  693. `man1ext'
  694.      The file name extension for installed section 1 man pages.
  695.  
  696. `man2ext'
  697.      The file name extension for installed section 2 man pages.
  698.  
  699. `...'
  700.      Use these names instead of `manext' if the package needs to
  701.      install man pages in more than one section of the manual.
  702.  
  703. `infodir'
  704.      The directory for installing the Info files for this package.  By
  705.      default, it should be `/usr/local/info', but it should be written
  706.      as `$(prefix)/info'.
  707.  
  708. `srcdir'
  709.      The directory for the sources being compiled.  The value of this
  710.      variable is normally inserted by the `configure' shell script.
  711.  
  712.    For example:
  713.  
  714.      # Common prefix for installation directories.
  715.      # NOTE: This directory must exist when you start the install.
  716.      prefix = /usr/local
  717.      exec_prefix = $(prefix)
  718.      # Where to put the executable for the command `gcc'.
  719.      bindir = $(exec_prefix)/bin
  720.      # Where to put the directories used by the compiler.
  721.      libdir = $(exec_prefix)/lib
  722.      # Where to put the Info files.
  723.      infodir = $(prefix)/info
  724.  
  725.    If your program installs a large number of files into one of the
  726. standard user-specified directories, it might be useful to group them
  727. into a subdirectory particular to that program.  If you do this, you
  728. should write the `install' rule to create these subdirectories.
  729.  
  730.    Do not expect the user to include the subdirectory name in the value
  731. of any of the variables listed above.  The idea of having a uniform set
  732. of variable names for installation directories is to enable the user to
  733. specify the exact same values for several different GNU packages.  In
  734. order for this to be useful, all the packages must be designed so that
  735. they will work sensibly when the user does so.
  736.  
  737. 
  738. File: standards.info,  Node: Configuration,  Next: Source Language,  Prev: Makefile Conventions,  Up: Top
  739.  
  740. How Configuration Should Work
  741. *****************************
  742.  
  743.    Each GNU distribution should come with a shell script named
  744. `configure'.  This script is given arguments which describe the kind of
  745. machine and system you want to compile the program for.
  746.  
  747.    The `configure' script must record the configuration options so that
  748. they affect compilation.
  749.  
  750.    One way to do this is to make a link from a standard name such as
  751. `config.h' to the proper configuration file for the chosen system.  If
  752. you use this technique, the distribution should *not* contain a file
  753. named `config.h'.  This is so that people won't be able to build the
  754. program without configuring it first.
  755.  
  756.    Another thing that `configure' can do is to edit the Makefile.  If
  757. you do this, the distribution should *not* contain a file named
  758. `Makefile'.  Instead, include a file `Makefile.in' which contains the
  759. input used for editing.  Once again, this is so that people won't be
  760. able to build the program without configuring it first.
  761.  
  762.    If `configure' does write the `Makefile', then `Makefile' should
  763. have a target named `Makefile' which causes `configure' to be rerun,
  764. setting up the same configuration that was set up last time.  The files
  765. that `configure' reads should be listed as dependencies of `Makefile'.
  766.  
  767.    All the files which are output from the `configure' script should
  768. have comments at the beginning explaining that they were generated
  769. automatically using `configure'.  This is so that users won't think of
  770. trying to edit them by hand.
  771.  
  772.    The `configure' script should write a file named `config.status'
  773. which describes which configuration options were specified when the
  774. program was last configured.  This file should be a shell script which,
  775. if run, will recreate the same configuration.
  776.  
  777.    The `configure' script should accept an option of the form
  778. `--srcdir=DIRNAME' to specify the directory where sources are found (if
  779. it is not the current directory).  This makes it possible to build the
  780. program in a separate directory, so that the actual source directory is
  781. not modified.
  782.  
  783.    If the user does not specify `--srcdir', then `configure' should
  784. check both `.' and `..' to see if it can find the sources.  If it finds
  785. the sources in one of these places, it should use them from there.
  786. Otherwise, it should report that it cannot find the sources, and should
  787. exit with nonzero status.
  788.  
  789.    Usually the easy way to support `--srcdir' is by editing a
  790. definition of `VPATH' into the Makefile.  Some rules may need to refer
  791. explicitly to the specified source directory.  To make this possible,
  792. `configure' can add to the Makefile a variable named `srcdir' whose
  793. value is precisely the specified directory.
  794.  
  795.    The `configure' script should also take an argument which specifies
  796. the type of system to build the program for.  This argument should look
  797. like this:
  798.  
  799.      CPU-COMPANY-SYSTEM
  800.  
  801.    For example, a Sun 3 might be `m68k-sun-sunos4.1'.
  802.  
  803.    The `configure' script needs to be able to decode all plausible
  804. alternatives for how to describe a machine.  Thus, `sun3-sunos4.1'
  805. would be a valid alias.  So would `sun3-bsd4.2', since SunOS is
  806. basically BSD and no other BSD system is used on a Sun.  For many
  807. programs, `vax-dec-ultrix' would be an alias for `vax-dec-bsd', simply
  808. because the differences between Ultrix and BSD are rarely noticeable,
  809. but a few programs might need to distinguish them.
  810.  
  811.    There is a shell script called `config.sub' that you can use as a
  812. subroutine to validate system types and canonicalize aliases.
  813.  
  814.    Other options are permitted to specify in more detail the software
  815. or hardware present on the machine, and include or exclude optional
  816. parts of the package:
  817.  
  818. `--enable-FEATURE[=PARAMETER]'
  819.      Configure the package to build and install an optional user-level
  820.      facility called FEATURE.  This allows users to choose which
  821.      optional features to include.  Giving an optional PARAMETER of
  822.      `no' should omit FEATURE, if it is built by default.
  823.  
  824.      No `--enable' option should *ever* cause one feature to replace
  825.      another.  No `--enable' option should ever substitute one useful
  826.      behavior for another useful behavior.  The only proper use for
  827.      `--enable' is for questions of whether to build part of the program
  828.      or exclude it.
  829.  
  830. `--with-PACKAGE'
  831.      The package PACKAGE will be installed, so configure this package
  832.      to work with PACKAGE.
  833.  
  834.      Possible values of PACKAGE include `x', `x-toolkit', `gnu-as' (or
  835.      `gas'), `gnu-ld', `gnu-libc', and `gdb'.
  836.  
  837.      Do not use a `--with' option to specify the file name to use to
  838.      find certain files.  That is outside the scope of what `--with'
  839.      options are for.
  840.  
  841. `--nfp'
  842.      The target machine has no floating point processor.
  843.  
  844. `--gas'
  845.      The target machine assembler is GAS, the GNU assembler.  This is
  846.      obsolete; users should use `--with-gnu-as' instead.
  847.  
  848. `--x'
  849.      The target machine has the X Window System installed.  This is
  850.      obsolete; users should use `--with-x' instead.
  851.  
  852.    All `configure' scripts should accept all of these "detail" options,
  853. whether or not they make any difference to the particular package at
  854. hand.  In particular, they should accept any option that starts with
  855. `--with-' or `--enable-'.  This is so users will be able to configure
  856. an entire GNU source tree at once with a single set of options.
  857.  
  858.    You will note that the categories `--with-' and `--enable-' are
  859. narrow: they *do not* provide a place for any sort of option you might
  860. think of.  That is deliberate.  We want to limit the possible
  861. configuration options in GNU software.  We do not want GNU programs to
  862. have idiosyncratic configuration options.
  863.  
  864.    Packages that perform part of compilation may support
  865. cross-compilation.  In such a case, the host and target machines for
  866. the program may be different.  The `configure' script should normally
  867. treat the specified type of system as both the host and the target,
  868. thus producing a program which works for the same type of machine that
  869. it runs on.
  870.  
  871.    The way to build a cross-compiler, cross-assembler, or what have
  872. you, is to specify the option `--host=HOSTTYPE' when running
  873. `configure'.  This specifies the host system without changing the type
  874. of target system.  The syntax for HOSTTYPE is the same as described
  875. above.
  876.  
  877.    Bootstrapping a cross-compiler requires compiling it on a machine
  878. other than the host it will run on.  Compilation packages accept a
  879. configuration option `--build=HOSTTYPE' for specifying the
  880. configuration on which you will compile them, in case that is different
  881. from the host.
  882.  
  883.    Programs for which cross-operation is not meaningful need not accept
  884. the `--host' option, because configuring an entire operating system for
  885. cross-operation is not a meaningful thing.
  886.  
  887.    Some programs have ways of configuring themselves automatically.  If
  888. your program is set up to do this, your `configure' script can simply
  889. ignore most of its arguments.
  890.  
  891. 
  892. File: standards.info,  Node: Source Language,  Next: Formatting,  Prev: Configuration,  Up: Top
  893.  
  894. Using Languages Other Than C
  895. ****************************
  896.  
  897.    Using a language other than C is like using a non-standard feature:
  898. it will cause trouble for users.  Even if GCC supports the other
  899. language, users may find it inconvenient to have to install the
  900. compiler for that other language in order to build your program.  So
  901. please write in C.
  902.  
  903.    There are three exceptions for this rule:
  904.  
  905.    * It is okay to use a special language if the same program contains
  906.      an interpreter for that language.
  907.  
  908.      Thus, it is not a problem that GNU Emacs contains code written in
  909.      Emacs Lisp, because it comes with a Lisp interpreter.
  910.  
  911.    * It is okay to use another language in a tool specifically intended
  912.      for use with that language.
  913.  
  914.      This is okay because the only people who want to build the tool
  915.      will be those who have installed the other language anyway.
  916.  
  917.    * If an application is not of extremely widespread interest, then
  918.      perhaps it's not important if the application is inconvenient to
  919.      install.
  920.  
  921. 
  922. File: standards.info,  Node: Formatting,  Next: Comments,  Prev: Source Language,  Up: Top
  923.  
  924. Formatting Your Source Code
  925. ***************************
  926.  
  927.    It is important to put the open-brace that starts the body of a C
  928. function in column zero, and avoid putting any other open-brace or
  929. open-parenthesis or open-bracket in column zero.  Several tools look
  930. for open-braces in column zero to find the beginnings of C functions.
  931. These tools will not work on code not formatted that way.
  932.  
  933.    It is also important for function definitions to start the name of
  934. the function in column zero.  This helps people to search for function
  935. definitions, and may also help certain tools recognize them.  Thus, the
  936. proper format is this:
  937.  
  938.      static char *
  939.      concat (s1, s2)        /* Name starts in column zero here */
  940.           char *s1, *s2;
  941.      {                     /* Open brace in column zero here */
  942.        ...
  943.      }
  944.  
  945. or, if you want to use ANSI C, format the definition like this:
  946.  
  947.      static char *
  948.      concat (char *s1, char *s2)
  949.      {
  950.        ...
  951.      }
  952.  
  953.    In ANSI C, if the arguments don't fit nicely on one line, split it
  954. like this:
  955.  
  956.      int
  957.      lots_of_args (int an_integer, long a_long, short a_short,
  958.                    double a_double, float a_float)
  959.      ...
  960.  
  961.    For the body of the function, we prefer code formatted like this:
  962.  
  963.      if (x < foo (y, z))
  964.        haha = bar[4] + 5;
  965.      else
  966.        {
  967.          while (z)
  968.            {
  969.              haha += foo (z, z);
  970.              z--;
  971.            }
  972.          return ++x + bar ();
  973.        }
  974.  
  975.    We find it easier to read a program when it has spaces before the
  976. open-parentheses and after the commas.  Especially after the commas.
  977.  
  978.    When you split an expression into multiple lines, split it before an
  979. operator, not after one.  Here is the right way:
  980.  
  981.      if (foo_this_is_long && bar > win (x, y, z)
  982.          && remaining_condition)
  983.  
  984.    Try to avoid having two operators of different precedence at the same
  985. level of indentation.  For example, don't write this:
  986.  
  987.      mode = (inmode[j] == VOIDmode
  988.              || GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])
  989.              ? outmode[j] : inmode[j]);
  990.  
  991.    Instead, use extra parentheses so that the indentation shows the
  992. nesting:
  993.  
  994.      mode = ((inmode[j] == VOIDmode
  995.               || (GET_MODE_SIZE (outmode[j]) > GET_MODE_SIZE (inmode[j])))
  996.              ? outmode[j] : inmode[j]);
  997.  
  998.    Insert extra parentheses so that Emacs will indent the code properly.
  999. For example, the following indentation looks nice if you do it by hand,
  1000. but Emacs would mess it up:
  1001.  
  1002.      v = rup->ru_utime.tv_sec*1000 + rup->ru_utime.tv_usec/1000
  1003.          + rup->ru_stime.tv_sec*1000 + rup->ru_stime.tv_usec/1000;
  1004.  
  1005.    But adding a set of parentheses solves the problem:
  1006.  
  1007.      v = (rup->ru_utime.tv_sec*1000 + rup->ru_utime.tv_usec/1000
  1008.           + rup->ru_stime.tv_sec*1000 + rup->ru_stime.tv_usec/1000);
  1009.  
  1010.    Format do-while statements like this:
  1011.  
  1012.      do
  1013.        {
  1014.          a = foo (a);
  1015.        }
  1016.      while (a > 0);
  1017.  
  1018.    Please use formfeed characters (control-L) to divide the program into
  1019. pages at logical places (but not within a function).  It does not matter
  1020. just how long the pages are, since they do not have to fit on a printed
  1021. page.  The formfeeds should appear alone on lines by themselves.
  1022.  
  1023. 
  1024. File: standards.info,  Node: Comments,  Next: Syntactic Conventions,  Prev: Formatting,  Up: Top
  1025.  
  1026. Commenting Your Work
  1027. ********************
  1028.  
  1029.    Every program should start with a comment saying briefly what it is
  1030. for.  Example: `fmt - filter for simple filling of text'.
  1031.  
  1032.    Please put a comment on each function saying what the function does,
  1033. what sorts of arguments it gets, and what the possible values of
  1034. arguments mean and are used for.  It is not necessary to duplicate in
  1035. words the meaning of the C argument declarations, if a C type is being
  1036. used in its customary fashion.  If there is anything nonstandard about
  1037. its use (such as an argument of type `char *' which is really the
  1038. address of the second character of a string, not the first), or any
  1039. possible values that would not work the way one would expect (such as,
  1040. that strings containing newlines are not guaranteed to work), be sure
  1041. to say so.
  1042.  
  1043.    Also explain the significance of the return value, if there is one.
  1044.  
  1045.    Please put two spaces after the end of a sentence in your comments,
  1046. so that the Emacs sentence commands will work.  Also, please write
  1047. complete sentences and capitalize the first word.  If a lower-case
  1048. identifer comes at the beginning of a sentence, don't capitalize it!
  1049. Changing the spelling makes it a different identifier.  If you don't
  1050. like starting a sentence with a lower case letter, write the sentence
  1051. differently (e.g., "The identifier lower-case is ...").
  1052.  
  1053.    The comment on a function is much clearer if you use the argument
  1054. names to speak about the argument values.  The variable name itself
  1055. should be lower case, but write it in upper case when you are speaking
  1056. about the value rather than the variable itself.  Thus, "the inode
  1057. number NODE_NUM" rather than "an inode".
  1058.  
  1059.    There is usually no purpose in restating the name of the function in
  1060. the comment before it, because the reader can see that for himself.
  1061. There might be an exception when the comment is so long that the
  1062. function itself would be off the bottom of the screen.
  1063.  
  1064.    There should be a comment on each static variable as well, like this:
  1065.  
  1066.      /* Nonzero means truncate lines in the display;
  1067.         zero means continue them.  */
  1068.      int truncate_lines;
  1069.  
  1070.    Every `#endif' should have a comment, except in the case of short
  1071. conditionals (just a few lines) that are not nested.  The comment should
  1072. state the condition of the conditional that is ending, *including its
  1073. sense*.  `#else' should have a comment describing the condition *and
  1074. sense* of the code that follows.  For example:
  1075.  
  1076.      #ifdef foo
  1077.        ...
  1078.      #else /* not foo */
  1079.        ...
  1080.      #endif /* not foo */
  1081.  
  1082. but, by contrast, write the comments this way for a `#ifndef':
  1083.  
  1084.      #ifndef foo
  1085.        ...
  1086.      #else /* foo */
  1087.        ...
  1088.      #endif /* foo */
  1089.  
  1090. 
  1091. File: standards.info,  Node: Syntactic Conventions,  Next: Names,  Prev: Comments,  Up: Top
  1092.  
  1093. Clean Use of C Constructs
  1094. *************************
  1095.  
  1096.    Please explicitly declare all arguments to functions.  Don't omit
  1097. them just because they are `int's.
  1098.  
  1099.    Declarations of external functions and functions to appear later in
  1100. the source file should all go in one place near the beginning of the
  1101. file (somewhere before the first function definition in the file), or
  1102. else should go in a header file.  Don't put `extern' declarations inside
  1103. functions.
  1104.  
  1105.    It used to be common practice to use the same local variables (with
  1106. names like `tem') over and over for different values within one
  1107. function.  Instead of doing this, it is better declare a separate local
  1108. variable for each distinct purpose, and give it a name which is
  1109. meaningful.  This not only makes programs easier to understand, it also
  1110. facilitates optimization by good compilers.  You can also move the
  1111. declaration of each local variable into the smallest scope that includes
  1112. all its uses.  This makes the program even cleaner.
  1113.  
  1114.    Don't use local variables or parameters that shadow global
  1115. identifiers.
  1116.  
  1117.    Don't declare multiple variables in one declaration that spans lines.
  1118. Start a new declaration on each line, instead.  For example, instead of
  1119. this:
  1120.  
  1121.      int    foo,
  1122.             bar;
  1123.  
  1124. write either this:
  1125.  
  1126.      int foo, bar;
  1127.  
  1128. or this:
  1129.  
  1130.      int foo;
  1131.      int bar;
  1132.  
  1133. (If they are global variables, each should have a comment preceding it
  1134. anyway.)
  1135.  
  1136.    When you have an `if'-`else' statement nested in another `if'
  1137. statement, always put braces around the `if'-`else'.  Thus, never write
  1138. like this:
  1139.  
  1140.      if (foo)
  1141.        if (bar)
  1142.          win ();
  1143.        else
  1144.          lose ();
  1145.  
  1146. always like this:
  1147.  
  1148.      if (foo)
  1149.        {
  1150.          if (bar)
  1151.            win ();
  1152.          else
  1153.            lose ();
  1154.        }
  1155.  
  1156.    If you have an `if' statement nested inside of an `else' statement,
  1157. either write `else if' on one line, like this,
  1158.  
  1159.      if (foo)
  1160.        ...
  1161.      else if (bar)
  1162.        ...
  1163.  
  1164. with its `then'-part indented like the preceding `then'-part, or write
  1165. the nested `if' within braces like this:
  1166.  
  1167.      if (foo)
  1168.        ...
  1169.      else
  1170.        {
  1171.          if (bar)
  1172.            ...
  1173.        }
  1174.  
  1175.    Don't declare both a structure tag and variables or typedefs in the
  1176. same declaration.  Instead, declare the structure tag separately and
  1177. then use it to declare the variables or typedefs.
  1178.  
  1179.    Try to avoid assignments inside `if'-conditions.  For example, don't
  1180. write this:
  1181.  
  1182.      if ((foo = (char *) malloc (sizeof *foo)) == 0)
  1183.        fatal ("virtual memory exhausted");
  1184.  
  1185. instead, write this:
  1186.  
  1187.      foo = (char *) malloc (sizeof *foo);
  1188.      if (foo == 0)
  1189.        fatal ("virtual memory exhausted");
  1190.  
  1191.    Don't make the program ugly to placate `lint'.  Please don't insert
  1192. any casts to `void'.  Zero without a cast is perfectly fine as a null
  1193. pointer constant.
  1194.  
  1195. 
  1196. File: standards.info,  Node: Names,  Next: Using Extensions,  Prev: Syntactic Conventions,  Up: Top
  1197.  
  1198. Naming Variables and Functions
  1199. ******************************
  1200.  
  1201.    Please use underscores to separate words in a name, so that the Emacs
  1202. word commands can be useful within them.  Stick to lower case; reserve
  1203. upper case for macros and `enum' constants, and for name-prefixes that
  1204. follow a uniform convention.
  1205.  
  1206.    For example, you should use names like `ignore_space_change_flag';
  1207. don't use names like `iCantReadThis'.
  1208.  
  1209.    Variables that indicate whether command-line options have been
  1210. specified should be named after the meaning of the option, not after
  1211. the option-letter.  A comment should state both the exact meaning of
  1212. the option and its letter.  For example,
  1213.  
  1214.      /* Ignore changes in horizontal whitespace (-b).  */
  1215.      int ignore_space_change_flag;
  1216.  
  1217.    When you want to define names with constant integer values, use
  1218. `enum' rather than `#define'.  GDB knows about enumeration constants.
  1219.  
  1220.    Use file names of 14 characters or less, to avoid creating gratuitous
  1221. problems on System V.  You can use the program `doschk' to test for
  1222. this.  `doschk' also tests for potential name conflicts if the files
  1223. were loaded onto an MS-DOS file system--something you may or may not
  1224. care about.
  1225.  
  1226.