coreutils
[Top][All Lists]
Advanced

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

Re: [PATCH] doc: sort: add link to Coreutils FAQ for common pitfalls


From: Jim Meyering
Subject: Re: [PATCH] doc: sort: add link to Coreutils FAQ for common pitfalls
Date: Thu, 15 Mar 2012 11:35:36 +0100

Bernhard Voelker wrote:
> As there are many questions here on this mailing list regarding
> "strange sort behaviour" and most are redirected to the FAQ,
> what about adding the URL to the info page?
...
> Subject: [PATCH] doc: sort: add link to Coreutils FAQ for common pitfalls
>
> * doc/coreutils.texi (sort invocation): Add link to Coreutils FAQ #22.
...
> +For more details, see the source code or read about common pitfalls in
> +the @acronym{FAQ} topic
> +@uref{https://www.gnu.org/software/coreutils/faq/#Sort-does-not-sort-in-normal-order_0021,
> +@samp{Sort does not sort in normal order}}.

Thanks for the suggestion.
However, I'm leery of adding a FAQ link like that to the documentation.
First, I'm not sure how canonical/stable the "_0021" part of that link is.
I know we'll take care not to change it, but imho, that part
does not belong in a link we would reference.

Linking aside, since the FAQ says things that the documentation does not,
but that are obviously useful, perhaps we should simply move part or all of
the FAQ into coreutils.texi (or, more likely, a separate file).
Then a simple reference to the FAQ section would have the same effect.

I've Cc'd Bob Proulx, who wrote most of our FAQ.



reply via email to

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