linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Michael Kerrisk (man-pages)" <mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
To: Christoph Hellwig <hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
Cc: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org,
	Stephan Mueller
	<stephan.mueller-fwYZOkdEjagAvxtiuMwx3w@public.gmane.org>,
	Michael Kerrisk
	<michael.kerrisk-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>,
	linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Subject: Re: Handling of updates to kernel Documentation/ tree
Date: Tue, 10 Mar 2015 06:56:37 +0100	[thread overview]
Message-ID: <54FE8795.4090809@gmail.com> (raw)
In-Reply-To: <20150309160520.GA28067-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>

On 03/09/2015 05:05 PM, Christoph Hellwig wrote:
> On Mon, Mar 09, 2015 at 05:03:52PM +0100, Michael Kerrisk (man-pages) wrote:
>> Actually, a lot of man pages do refer to kernel Documentation files.
>> What's the problem?
> 
> It's not easily accessibe and coherent information.  It requires a
> checked out kernel tree (or a web mirror these days), which might
> be a different version than you expect.  Referencing actually installed
> case documentation like man page or at least info pages is a lot easier
> for the user.

I agree that installed documentation is preferable, but sometimes
it's not always practical to get that documentation in the desired form.
So, failing that man-pages does quite often reference kernel source files.

Cheers,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

  parent reply	other threads:[~2015-03-10  5:56 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-03-09 14:17 Handling of updates to kernel Documentation/ tree Stephan Mueller
2015-03-09 15:07 ` Christoph Hellwig
     [not found]   ` <20150309150739.GA6131-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
2015-03-09 16:03     ` Michael Kerrisk (man-pages)
     [not found]       ` <54FDC468.40503-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
2015-03-09 16:05         ` Christoph Hellwig
     [not found]           ` <20150309160520.GA28067-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
2015-03-10  5:56             ` Michael Kerrisk (man-pages) [this message]
2015-03-09 16:16     ` Stephan Mueller
2015-03-09 17:40     ` Mike Frysinger
2015-03-10  5:56       ` Michael Kerrisk (man-pages)
2015-03-10 14:11       ` Christoph Hellwig
     [not found]         ` <20150310141104.GA17228-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
2015-03-12  9:56           ` Stephan Mueller

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=54FE8795.4090809@gmail.com \
    --to=mtk.manpages-re5jqeeqqe8avxtiumwx3w@public.gmane.org \
    --cc=hch-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org \
    --cc=linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org \
    --cc=michael.kerrisk-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org \
    --cc=stephan.mueller-fwYZOkdEjagAvxtiuMwx3w@public.gmane.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.
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 NNTP newsgroup(s).