From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Tino Calancha Newsgroups: gmane.emacs.devel 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 Message-ID: <8760kr4ml0.fsf_-_@calancha-pc> References: <87vau3jl6f.fsf@gmail.com> <87inq0xhiw.fsf@mail.linkov.net> <87d1g55h8d.fsf@mail.linkov.net> <87r33ywquz.fsf@mail.linkov.net> <87ziilc05e.fsf@gmail.com> <8760l9wcci.fsf@mail.linkov.net> <87fukb2xmk.fsf@gmail.com> <87h94qu01u.fsf@mail.linkov.net> <87inp6nsdf.fsf@gmail.com> <87lgtu4w5c.fsf@mail.linkov.net> <878tpt1m4b.fsf@mail.linkov.net> <874m0hrw59.fsf@calancha-pc> <831svky2zq.fsf@gnu.org> <83k298uwpn.fsf@gnu.org> <83d1ezvh06.fsf@gnu.org> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: blaine.gmane.org 1486117345 16563 195.159.176.226 (3 Feb 2017 10:22:25 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 3 Feb 2017 10:22:25 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.0.50 (gnu/linux) Cc: emacs-devel@gnu.org, tino.calancha@gmail.com To: Eli Zaretskii Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri Feb 03 11:22:19 2017 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cZb0U-000466-Uh for ged-emacs-devel@m.gmane.org; Fri, 03 Feb 2017 11:22:19 +0100 Original-Received: from localhost ([::1]:33115 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cZb0a-0005sX-BE for ged-emacs-devel@m.gmane.org; Fri, 03 Feb 2017 05:22:24 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:51029) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cZajN-0008QE-R8 for emacs-devel@gnu.org; Fri, 03 Feb 2017 05:04:39 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cZajJ-0006QY-QM for emacs-devel@gnu.org; Fri, 03 Feb 2017 05:04:37 -0500 Original-Received: from mail-pf0-x241.google.com ([2607:f8b0:400e:c00::241]:33611) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1cZajJ-0006Pg-Lw; Fri, 03 Feb 2017 05:04:33 -0500 Original-Received: by mail-pf0-x241.google.com with SMTP id e4so1286576pfg.0; Fri, 03 Feb 2017 02:04:33 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=DoycM9qGjDlp7xJjkG0bevJG9bq4ppjuMo62EhwjVL0=; b=iaJ6VmznrptLYA1OttDccM73F6qVqJ9MG3zXFtwfETjYflI9LxwM/uiYavgT9FIBax xdhxEzN2Ig/LEHXaMrMrZpeMI72jRiuWI0TZfjoYAQBoVgKJThZuntBZwvSs1/11MMxC ncoXiFna16aEZonED5QoN/JAuRpjv2XL5rWonyL05SKD1kaKXtjL++svtwS5N2lIurEC TqYZaMh8xXXAByAoNVsDPiyz1zVrrK6ajSuC+VGNnN2ExGqAq/5lA9Da+lw0ZktvKJW5 nI4/bhjDcDGalcgLe1IlX0dkZ1skbCoWdkEcOsbvdSGBCLB0uA2vX0y9FH10qO3ZtCwm ztAA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=DoycM9qGjDlp7xJjkG0bevJG9bq4ppjuMo62EhwjVL0=; b=skzKXqxIrc4cqgloFWlcR604W0ua5MQoA9sUJKPKjooCbWijD865pI6i4hJpMs331Q zxGu+Gh0n5M0etRB4bKF52zR0EI2gueqnJqDonFgi8cGkkqjbWWL8q13lgvR7Cv4C/EH YbSbiI9vy+VkVYzzR4vN/z52xZ9gfj8/aqLSEm2TaIRmQF/SojANErEhYtP7/69QUTBP fgkq8gJBoSpIhQvmB0x6DJGYCOQt1bDBUeQrJMb3V5mYmsS7nLBUNxZbkGrZWOF8X/d5 LUJP1QO7O8fL9/6bnJI/Eaft91t5GgBCwIPaKIlxijX0Q8HGi8iq6Srb9LFXhznYCFsW PUiQ== X-Gm-Message-State: AIkVDXIAdSTyVohoe8YjLJr8pY2TvCTGhJZO7lOqfsbkjOd9yy9pZJtWgCHwtf42M/2ibA== X-Received: by 10.84.143.129 with SMTP id 1mr19943077plz.42.1486116272441; Fri, 03 Feb 2017 02:04:32 -0800 (PST) Original-Received: from calancha-pc (104.81.147.124.dy.bbexcite.jp. [124.147.81.104]) by smtp.gmail.com with ESMTPSA id t133sm66189382pgc.24.2017.02.03.02.04.30 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Fri, 03 Feb 2017 02:04:31 -0800 (PST) In-Reply-To: <83d1ezvh06.fsf@gnu.org> (Eli Zaretskii's message of "Fri, 03 Feb 2017 10:02:49 +0200") X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 2607:f8b0:400e:c00::241 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:211920 Archived-At: Eli Zaretskii writes: >> From: Tino Calancha >> Date: Fri, 3 Feb 2017 12:11:11 +0900 (JST) >> cc: Tino Calancha , emacs-devel@gnu.org >> >> 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 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(+) diff --git a/CONTRIBUTE b/CONTRIBUTE index c12f0cc08d..49b8919f17 100644 --- a/CONTRIBUTE +++ b/CONTRIBUTE @@ -250,6 +250,12 @@ 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 + 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. -- 2.11.0 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; In GNU Emacs 25.1.91.1 (x86_64-pc-linux-gnu, GTK+ Version 3.22.6) of 2017-02-03 Repository revision: 7e02a477bbcabb4e65aeecade79b67357c0b9dae