aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul Eggert2017-03-19 12:29:07 -0700
committerPaul Eggert2017-03-19 12:29:07 -0700
commit6be08305c404652d5bb977e8bce8f1019cda42c9 (patch)
tree05ec509ddccc52dd3eb3e3d73e914dd4dbc7f2a6
parent2cb81869f81a5774134b9c887a0c1b133d89876c (diff)
parente1171de6d1922af4bb8e9b4eae2becf1b7b597d4 (diff)
downloademacs-6be08305c404652d5bb977e8bce8f1019cda42c9.tar.gz
emacs-6be08305c404652d5bb977e8bce8f1019cda42c9.zip
Merge from origin/emacs-25
e1171de * CONTRIBUTE (Documenting your changes): Index new vars/comma...
-rw-r--r--CONTRIBUTE7
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
261that *all* the necessary documentation updates have been made, mark 261that *all* the necessary documentation updates have been made, mark
262the entry with "+++". Otherwise do not mark it. 262the entry with "+++". Otherwise do not mark it.
263 263
264If your change requires updating the manuals to document new
265functions/commands/variables/faces, then use the proper Texinfo
266command to index them; for instance, use @vindex for variables and
267@findex for functions/commands. For the full list of predefine indices, see
268http://www.gnu.org/software/texinfo/manual/texinfo/html_node/Predefined-Indices.html
269or run the shell command 'info "(texinfo)Predefined Indices"'.
270
264For more specific tips on Emacs's doc style, see 271For more specific tips on Emacs's doc style, see
265http://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html 272http://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html
266Use 'checkdoc' to check for documentation errors before submitting a patch. 273Use 'checkdoc' to check for documentation errors before submitting a patch.