From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.devel Subject: RE: C-h C-b to view "Reporting Bugs" section of the manual Date: Mon, 21 May 2012 22:28:50 -0700 Message-ID: References: <41txz9pboj.fsf@fencepost.gnu.org><3C645B82A25242F7AF3BE16B9CB9BCAA@us.oracle.com><87hav9oyq3.fsf@uwakimon.sk.tsukuba.ac.jp><9404D5B04C754DFAA8733E1027D8BDF5@us.oracle.com> <87aa10q2f6.fsf@uwakimon.sk.tsukuba.ac.jp> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: dough.gmane.org 1337664544 19297 80.91.229.3 (22 May 2012 05:29:04 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Tue, 22 May 2012 05:29:04 +0000 (UTC) Cc: emacs-devel@gnu.org To: "'Stephen J. Turnbull'" Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Tue May 22 07:29:03 2012 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1SWheZ-00089h-9q for ged-emacs-devel@m.gmane.org; Tue, 22 May 2012 07:29:03 +0200 Original-Received: from localhost ([::1]:59313 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SWheY-0002Ph-Qg for ged-emacs-devel@m.gmane.org; Tue, 22 May 2012 01:29:02 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:33458) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SWheV-0002PZ-1Z for emacs-devel@gnu.org; Tue, 22 May 2012 01:29:00 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SWheT-0003fk-5K for emacs-devel@gnu.org; Tue, 22 May 2012 01:28:58 -0400 Original-Received: from rcsinet15.oracle.com ([148.87.113.117]:30720) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SWheS-0003fg-Ui for emacs-devel@gnu.org; Tue, 22 May 2012 01:28:57 -0400 Original-Received: from acsinet22.oracle.com (acsinet22.oracle.com [141.146.126.238]) by rcsinet15.oracle.com (Sentrion-MTA-4.2.2/Sentrion-MTA-4.2.2) with ESMTP id q4M5Ssul001652 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Tue, 22 May 2012 05:28:54 GMT Original-Received: from acsmt356.oracle.com (acsmt356.oracle.com [141.146.40.156]) by acsinet22.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id q4M5Sre5027190 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO); Tue, 22 May 2012 05:28:54 GMT Original-Received: from abhmt119.oracle.com (abhmt119.oracle.com [141.146.116.71]) by acsmt356.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id q4M5SrDd011904; Tue, 22 May 2012 00:28:53 -0500 Original-Received: from dradamslap1 (/10.159.160.54) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Mon, 21 May 2012 22:28:53 -0700 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: <87aa10q2f6.fsf@uwakimon.sk.tsukuba.ac.jp> Thread-Index: Ac030S04rGp+4e8eT0+VKO78ch+nEgAArEMQ X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: acsinet22.oracle.com [141.146.126.238] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 1) X-Received-From: 148.87.113.117 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 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-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:150597 Archived-At: > here the purpose of putting the Bugs node on a key is to > make it immediately available to bug reporters. Well, sure. Put anything on a key and it is immediately available - via the key. In this case, the info is immediately available to bug reporters ... [drumroll] ... who know about that key. ;-) > This isn't about documenting the use of r-e-b, it's about good > style in bug reports. The information about good bug reporting already exists. This is only about how to access it. Do we need a key for that? Is a key even very helpful for that? How to find the key? Or is it enough (and better) to put a link to the info in the bug-reporting instructions - which you suggested, and which I agreed was a good idea. My point was that if we added such links to help descriptions _anyway_ then a direct link would be available for someone looking to find out more about reporting bugs by checking the command `report-emacs-bug'. That's all. > So it would need to be special-cased somehow (I guess you could have a > generic function that would apropos the obarray and/or the known Info > nodes, but that might be expensive since it would probably have to hit > the disk a lot, possibly including decompressing compressed Info > files). No idea what that's all about. Passons... > The proposal to special-case it as a help key is going in the right > direction by making it very inexpensive to get to the Bugs node, but I > question its usefulness because of discoverability concerns. Me too. I like your idea of adding a link to the reporting instructions. That's clearly the best place for discovery. The point about a link in the help for `report-emacs-bug' was only that that comes for free if we already provide such a feature for `describe-*' output generally (which I do, and which is easily done). No, such a link is not as immediately available as a link in the reporting instructions. But it is more discoverable than `C-h C-b' - at least someone who looks up what `C-h f `report-emacs-bug' is all about will come across it. (And it doesn't cost a key binding, which was the original question.)