[Emacs-diffs] emacs-25 e1171de: * CONTRIBUTE (Documenting your changes): Index new vars/commands in manual.

[Tino Calancha]

branch: emacs-25
commit e1171de6d1922af4bb8e9b4eae2becf1b7b597d4
Author: Tino Calancha <address@hidden>
Commit: Tino Calancha <address@hidden>

    * CONTRIBUTE (Documenting your changes): Index new vars/commands in manual.
---
 CONTRIBUTE |    7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/CONTRIBUTE b/CONTRIBUTE
index 809b6e3..e9a0341 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
address@hidden 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.