Re: Handling of updates to kernel Documentation/ tree

["Michael Kerrisk (man-pages)" <mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>]

On 03/09/2015 04:07 PM, Christoph Hellwig wrote:
> On Mon, Mar 09, 2015 at 03:17:58PM +0100, Stephan Mueller wrote:
>> 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?

Actually, a lot of man pages do refer to kernel Documentation files.
What's the problem?

Thanks,

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