From: "Drew Adams" <drew.adams@oracle.com>
To: "'Stephen J. Turnbull'" <stephen@xemacs.org>
Cc: emacs-devel@gnu.org
Subject: RE: C-h C-b to view "Reporting Bugs" section of the manual
Date: Mon, 21 May 2012 22:28:50 -0700 [thread overview]
Message-ID: <D967D38F3B474404B45B35E7A0C3B6B1@us.oracle.com> (raw)
In-Reply-To: <87aa10q2f6.fsf@uwakimon.sk.tsukuba.ac.jp>
> 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.)
next prev parent reply other threads:[~2012-05-22 5:28 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-05-21 19:38 C-h C-b to view "Reporting Bugs" section of the manual Glenn Morris
2012-05-21 20:53 ` Drew Adams
2012-05-22 0:17 ` Stephen J. Turnbull
2012-05-22 1:57 ` Drew Adams
2012-05-22 3:23 ` Stephen J. Turnbull
2012-05-22 5:27 ` Drew Adams
2012-05-23 3:22 ` Stephen J. Turnbull
2012-05-22 4:12 ` Stephen J. Turnbull
2012-05-22 5:28 ` Drew Adams [this message]
2012-05-22 6:59 ` Glenn Morris
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=D967D38F3B474404B45B35E7A0C3B6B1@us.oracle.com \
--to=drew.adams@oracle.com \
--cc=emacs-devel@gnu.org \
--cc=stephen@xemacs.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.