Re: Handling of updates to kernel Documentation/ tree

Am Montag, 9. März 2015, 08:07:39 schrieb Christoph Hellwig:

Hi Christoph,

On Mon, Mar 09, 2015 at 03:17:58PM +0100, Stephan Mueller wrote:

quoted

Hi Michael,

how shall an update to the Documentation/ tree be handled in man
pages
that contain a pointer to these documents?

Specifically, socket(2) contains a reference to
Documentation/crypto/crypto-API-userspace.txt. With the patch [1] the
document is gone and its contents is moved into a DocBook.

Shall the kernel DocBook website [2] be referenced? If so, when is it
appropriate to add the patch (note, the change is expected to be
propagated to Linus' tree in 4.1-rc1).

Referencing a kernel Documentation file from a man page sounds like
a bad idea to me.  Why can't we include a nroff-yfied version of the
content in the man-pages repository?

You can see the compiled output at [1]. You see that the output is 
larger. Of course I can provide a patch of the output from make mandocs 
of that DocBook. I would think that this documentation is too large to 
be put into socket(2).

The only proposal I would have is to format the output into a separate 
man page for chapter 4.

[1] http://www.chronox.de/crypto-API/User.html


Ciao
Stephan
--
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