unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefan@marxist.se>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 39215@debbugs.gnu.org
Subject: bug#39215: Hyperlinks to man pages in doc strings
Date: Tue, 21 Jan 2020 17:32:35 +0100	[thread overview]
Message-ID: <CADwFkmmM+j09Gj6P4sPbPbDB1B=v--kb9voq587eS+3Zqh3+nw@mail.gmail.com> (raw)
In-Reply-To: <83iml4x1mc.fsf@gnu.org>

Eli Zaretskii <eliz@gnu.org> writes:

> 'find' has an Info manual: find.info.  Why not use a hyperlink to that
> instead, something we already support?  Many utilities have similar
> Info manuals, and the glibc has an Info manual as well.

I was looking for something which would work also with BSD find (or
indeed any find not from GNU findutils).  My idea was to specify both.

But that's just one example.  Most non-GNU software don't use texinfo.
They often have man pages.  It would be useful to be able to add links
to them.

> Nitpicking: let's not call Info manuals "pages".  They are not like
> "man pages", which are a collection of short concise usage
> descriptions.

Sure, I'll try to remember to say "info manuals" in our documentation
and sources.

(FWIW, I think getting people to stop using that vocabulary is going
to be an uphill battle, since it is so ubiquitous.  We even use this
nomenclature in some places in Emacs itself.  Try grepping for "info
pages" in our sources.)

Best regards,
Stefan Kangas





  reply	other threads:[~2020-01-21 16:32 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-01-21  8:55 bug#39215: Hyperlinks to man pages in doc strings Stefan Kangas
2020-01-21 15:36 ` Eli Zaretskii
2020-01-21 16:32   ` Stefan Kangas [this message]
2020-01-21 16:56     ` Eli Zaretskii
2020-01-22  4:03       ` Glenn Morris
2020-01-22 15:45         ` Eli Zaretskii
2020-01-23  1:39       ` Richard Stallman
2020-01-23  3:14         ` Stefan Kangas
2020-01-24  2:58           ` Richard Stallman
2021-09-25  1:07             ` Stefan Kangas
2021-09-25  1:13               ` Lars Ingebrigtsen
2021-09-25  2:10                 ` Stefan Kangas
2021-09-25  1:32               ` Phil Sainty
2021-09-25  2:10                 ` Stefan Kangas

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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='CADwFkmmM+j09Gj6P4sPbPbDB1B=v--kb9voq587eS+3Zqh3+nw@mail.gmail.com' \
    --to=stefan@marxist.se \
    --cc=39215@debbugs.gnu.org \
    --cc=eliz@gnu.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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).