emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] master 6be0830 08/17: Merge from origin/emacs-25


From: Paul Eggert
Subject: [Emacs-diffs] master 6be0830 08/17: Merge from origin/emacs-25
Date: Sun, 19 Mar 2017 15:41:42 -0400 (EDT)

branch: master
commit 6be08305c404652d5bb977e8bce8f1019cda42c9
Merge: 2cb8186 e1171de
Author: Paul Eggert <address@hidden>
Commit: Paul Eggert <address@hidden>

    Merge from origin/emacs-25
    
    e1171de * CONTRIBUTE (Documenting your changes): Index new vars/comma...
---
 CONTRIBUTE | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/CONTRIBUTE b/CONTRIBUTE
index 8e45b67..92a76d8 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
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.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]