diff options
| author | Paul Eggert <eggert@cs.ucla.edu> | 2017-03-19 12:29:07 -0700 |
|---|---|---|
| committer | Paul Eggert <eggert@cs.ucla.edu> | 2017-03-19 12:29:07 -0700 |
| commit | 6be08305c404652d5bb977e8bce8f1019cda42c9 (patch) | |
| tree | 05ec509ddccc52dd3eb3e3d73e914dd4dbc7f2a6 /CONTRIBUTE | |
| parent | 2cb81869f81a5774134b9c887a0c1b133d89876c (diff) | |
| parent | e1171de6d1922af4bb8e9b4eae2becf1b7b597d4 (diff) | |
| download | emacs-6be08305c404652d5bb977e8bce8f1019cda42c9.tar.gz | |
Merge from origin/emacs-25
e1171de * CONTRIBUTE (Documenting your changes): Index new vars/comma...
Diffstat (limited to 'CONTRIBUTE')
| -rw-r--r-- | CONTRIBUTE | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE index 8e45b6780e7..92a76d841c4 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE @@ -261,6 +261,13 @@ know it does not, mark the NEWS entry with "---". If you know that *all* the necessary documentation updates have been made, mark the entry with "+++". Otherwise do not mark it. +If your change requires updating the manuals to document new +functions/commands/variables/faces, then use the proper Texinfo +command to index them; for instance, use @vindex for variables and +@findex for functions/commands. For the full list of predefine indices, see +http://www.gnu.org/software/texinfo/manual/texinfo/html_node/Predefined-Indices.html +or run the shell command 'info "(texinfo)Predefined Indices"'. + For more specific tips on Emacs's doc style, see http://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html Use 'checkdoc' to check for documentation errors before submitting a patch. |