From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by smtp.lore.kernel.org (Postfix) with ESMTP id 3FD85C32771 for ; Wed, 28 Sep 2022 15:03:37 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S233320AbiI1PD1 (ORCPT ); Wed, 28 Sep 2022 11:03:27 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:47936 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229640AbiI1PD0 (ORCPT ); Wed, 28 Sep 2022 11:03:26 -0400 Received: from bombadil.infradead.org (bombadil.infradead.org [IPv6:2607:7c80:54:3::133]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 0B53A367A8; Wed, 28 Sep 2022 08:03:24 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=bombadil.20210309; h=Content-Transfer-Encoding: Content-Type:In-Reply-To:From:References:Cc:To:Subject:MIME-Version:Date: Message-ID:Sender:Reply-To:Content-ID:Content-Description; bh=j8dtOkI4/DbIj26pNqdisQlvlJxpcZ2xj3Pqld4MWOI=; b=HpLywNW0Z3W544AcYHbYLNQIwy 9YZdryN4uy9s6PPfiJF5bJN1fQJkAbuAO42Uys/VjQc8DO30QcxhJTJRrdtyk+J6p7zVcrk7KbC/8 AXKaStZW15/Y/KX2E3mblk49BOliLtFSxaa7eA2Z51b0oMfkW9ZbXCvN9JyO2yhMV/na1Bbht55r8 cvYsThs+6xNhBTAtI59F9X3+iUq2XrfXJbj85pOzp5Di8D4SDyCyQt6z38HvjX8xWTP//oVEaL52K +DZeErui1JDRlpym3ZRUflYStJMeIHHp+twr/WD+6PwpHOceWQeg9PuwINRZhvx8FqWM+Bjewx4D2 J30Rf/yw==; Received: from [2601:1c2:d80:3110::a2e7] by bombadil.infradead.org with esmtpsa (Exim 4.94.2 #2 (Red Hat Linux)) id 1odYan-00GmQE-Di; Wed, 28 Sep 2022 15:03:21 +0000 Message-ID: <14088654-189e-2983-fbdd-d2a28b0b13db@infradead.org> Date: Wed, 28 Sep 2022 08:03:20 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.2.2 Subject: Re: [PATCH v3 7/7] docs: add a man-pages link to the front page Content-Language: en-US To: Thorsten Leemhuis , Jonathan Corbet , linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, Kees Cook , Jani Nikula , Joe Perches , David Vernet References: <20220927160559.97154-1-corbet@lwn.net> <20220927160559.97154-8-corbet@lwn.net> From: Randy Dunlap In-Reply-To: Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit Precedence: bulk List-ID: X-Mailing-List: linux-doc@vger.kernel.org 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 >> --- >> 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 >> userspace-api/index >> >> +See also: the `Linux 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 `_, > as that where some of the kernel's documentation is kept. Among it are > for example descriptions of Linux' `system calls > `_ and `devices > `_; the sections > `files `_ and > `overviews, conventions, and miscellaneous > `_ 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