Re: [PATCH v3 7/7] docs: add a man-pages link to the front page

From: Randy Dunlap <rdunlap@infradead.org>
To: Thorsten Leemhuis <linux@leemhuis.info>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, Kees Cook <keescook@chromium.org>,
	Jani Nikula <jani.nikula@linux.intel.com>,
	Joe Perches <joe@perches.com>, David Vernet <void@manifault.com>
Subject: Re: [PATCH v3 7/7] docs: add a man-pages link to the front page
Date: Wed, 28 Sep 2022 08:03:20 -0700	[thread overview]
Message-ID: <14088654-189e-2983-fbdd-d2a28b0b13db@infradead.org> (raw)
In-Reply-To: <ff413763-6cac-576f-7671-2f883bb56c51@leemhuis.info>

On 9/27/22 23:21, Thorsten Leemhuis wrote:
> 
> 
> On 27.09.22 18:05, Jonathan Corbet wrote:
>> Readers looking for user-oriented information may benefit from it.
>>
>> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
>> ---
>>  Documentation/index.rst | 2 ++
>>  1 file changed, 2 insertions(+)
>>
>> diff --git a/Documentation/index.rst b/Documentation/index.rst
>> index 5a700548ae82..85eab6e990ab 100644
>> --- a/Documentation/index.rst
>> +++ b/Documentation/index.rst
>> @@ -76,6 +76,8 @@ developers seeking information on the kernel's user-space APIs.
>>     User-space tools <tools/index>
>>     userspace-api/index
>>  
>> +See also: the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_,
>> +which are kept separately from the kernel's own documentation.
> 
> People following that link might be inclined to click on the section 1
> and then find a lot of stuff that has nothing or not much to do with the
> kernel and then might feel lost. So how about a text like this instead:
> 
> ```
> See also the `Linux man pages <https://www.kernel.org/doc/man-pages/>`_,
> as that where some of the kernel's documentation is kept. Among it are
> for example descriptions of Linux' `system calls
> <https://man7.org/linux/man-pages/dir_section_2.html>`_ and `devices
> <https://man7.org/linux/man-pages/dir_section_4.html>`_; the sections
> `files <https://man7.org/linux/man-pages/dir_section_5.html>`_ and
> `overviews, conventions, and miscellaneous
> <https://man7.org/linux/man-pages/dir_section_7.html>`_ also contain
> many documents dedicated to aspects of the kernel.
> ```
> 
> The last section (e.g. everything after the semicolon) might not be
> worth it.

I prefer the simple instead of the verbose.

-- 
~Randy