diff options
| author | Tino Calancha <tino.calancha@gmail.com> | 2017-02-03 19:59:22 +0900 |
|---|---|---|
| committer | Tino Calancha <tino.calancha@gmail.com> | 2017-02-03 19:59:22 +0900 |
| commit | e1171de6d1922af4bb8e9b4eae2becf1b7b597d4 (patch) | |
| tree | 87de43806100e035f6b7ae98520a6b47afa4697c /CONTRIBUTE | |
| parent | 6102d01ecae664edf192bb25c01622df4518eb49 (diff) | |
| download | emacs-e1171de6d1922af4bb8e9b4eae2becf1b7b597d4.tar.gz | |
* CONTRIBUTE (Documenting your changes): Index new vars/commands in manual.
Diffstat (limited to 'CONTRIBUTE')
| -rw-r--r-- | CONTRIBUTE | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/CONTRIBUTE b/CONTRIBUTE index 809b6e3208d..e9a03419807 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE @@ -250,6 +250,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. |