From: Stephen Kitt <steve@sk2.org>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 1/6] docs: pretty up sysctl/kernel.rst
Date: Thu, 13 Feb 2020 20:21:46 +0100 [thread overview]
Message-ID: <20200213202146.02ebc959@heffalump.sk2.org> (raw)
In-Reply-To: <20200213115238.1cce0534@lwn.net>
[-- Attachment #1: Type: text/plain, Size: 2030 bytes --]
Hi Jon,
Thanks for the quick review!
On Thu, 13 Feb 2020 11:52:38 -0700, Jonathan Corbet <corbet@lwn.net> wrote:
> On Thu, 13 Feb 2020 18:46:56 +0100
> Stephen Kitt <steve@sk2.org> wrote:
[...]
> > diff --git a/Documentation/admin-guide/sysctl/kernel.rst
> > b/Documentation/admin-guide/sysctl/kernel.rst index
> > def074807cee..1de8f0b199b1 100644 ---
> > a/Documentation/admin-guide/sysctl/kernel.rst +++
> > b/Documentation/admin-guide/sysctl/kernel.rst @@ -2,262 +2,188 @@
> > Documentation for /proc/sys/kernel/
> > ===================================
> >
> > -kernel version 2.2.10
> > +Kernel version 2.2.10
>
> I honestly can't see the value of fixing up a line like that. When I
> encounter a kernel document that references something like 2.2.10, I assume
> it's full of dust and cobwebs. I'd just take that out.
Indeed, and I do intend to update it to 5.5. I was planning on ultimately
removing the line above, and only leaving the line mentioning the kernel
version below.
> > Copyright (c) 1998, 1999, Rik van Riel <riel@nl.linux.org>
> >
> > -Copyright (c) 2009, Shen Feng<shen@cn.fujitsu.com>
> > +Copyright (c) 2009, Shen Feng <shen@cn.fujitsu.com>
Would it also be OK to move these to the end of the document?
> > -For general info and legal blurb, please look in index.rst.
> > +For general info and legal blurb, please look in :doc:`index`.
> >
> > ------------------------------------------------------------------------------
> >
> > This file contains documentation for the sysctl files in
> > -/proc/sys/kernel/ and is valid for Linux kernel version 2.2.
> > +``/proc/sys/kernel/`` and is valid for Linux kernel version 2.2.
>
> This could be tweaked as well. If, after your work, you think it's still
> not current, a warning to that effect should be put in instead.
>
> There's some other dated stuff below that can go as well. Probably this is
> best done in a separate patch.
Agreed.
Regards,
Stephen
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
next prev parent reply other threads:[~2020-02-13 19:22 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-13 17:46 [PATCH 0/6] docs: sysctl/kernel.rst rework Stephen Kitt
2020-02-13 17:46 ` [PATCH 1/6] docs: pretty up sysctl/kernel.rst Stephen Kitt
2020-02-13 18:52 ` Jonathan Corbet
2020-02-13 19:21 ` Stephen Kitt [this message]
2020-02-13 17:46 ` [PATCH 2/6] docs: merge debugging-modules.txt into sysctl/kernel.rst Stephen Kitt
2020-02-13 18:55 ` Jonathan Corbet
2020-02-13 17:46 ` [PATCH 3/6] docs: drop l2cr from sysctl/kernel.rst Stephen Kitt
2020-02-13 17:46 ` [PATCH 4/6] docs: add missing IPC documentation in sysctl/kernel.rst Stephen Kitt
2020-02-13 17:47 ` [PATCH 5/6] docs: document stop-a " Stephen Kitt
2020-02-13 17:47 ` [PATCH 6/6] docs: document panic fully " Stephen Kitt
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=20200213202146.02ebc959@heffalump.sk2.org \
--to=steve@sk2.org \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+samsung@kernel.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