[Top][All Lists]

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

CONTRIBUTE: Mention indexing new vars/commands in manual [was: Run occur

From: Tino Calancha
Subject: CONTRIBUTE: Mention indexing new vars/commands in manual [was: Run occur command restricted to a region]
Date: Fri, 03 Feb 2017 19:04:27 +0900
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/26.0.50 (gnu/linux)

Eli Zaretskii <address@hidden> writes:

>> From: Tino Calancha <address@hidden>
>> Date: Fri, 3 Feb 2017 12:11:11 +0900 (JST)
>> cc: Tino Calancha <address@hidden>, address@hidden
>> I just noticed your commit df915775bc4ead095aa37d2b098de748e1821027
>> Now i understand that you mean the concept index.
> Not just the concept index: the variables should go into the variable
> indec and functions/commands into their index.  There are separate
> @cindex, @vindex, and @findex commands in Texinfo.
Do you think would be worth to mention briefly about this in CONTRIBUTE?
>From caa8e6955e65f3bb45e816dcfc3dc66cdd0fde28 Mon Sep 17 00:00:00 2001
From: Tino Calancha <address@hidden>
Date: Fri, 3 Feb 2017 18:55:00 +0900
Subject: [PATCH] * CONTRIBUTE (Documenting your changes): Index new
 vars/commands in manual.

 CONTRIBUTE | 6 ++++++
 1 file changed, 6 insertions(+)

index c12f0cc08d..49b8919f17 100644
@@ -250,6 +250,12 @@ know it does not, mark the NEWS entry with "---".  If you 
 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, 
 For more specific tips on Emacs's doc style, see
 Use 'checkdoc' to check for documentation errors before submitting a patch.

In GNU Emacs (x86_64-pc-linux-gnu, GTK+ Version 3.22.6)
 of 2017-02-03
Repository revision: 7e02a477bbcabb4e65aeecade79b67357c0b9dae

reply via email to

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