[PATCH 1/1] Documentation/sysctl/kernel.txt: header

[PATCH 1/1] Documentation/sysctl/kernel.txt: header

[Heinrich Schuchardt]

The header of Documentation/sysctl/kernel.txt should not refer to
Linux 2.2 because most of the lines were changed after that
release.

The authors that placed a copyright notice produced less than
half of the lines. So give credit to the other authors.

Replace "legal blurb" by a more precise term.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
---
 Documentation/sysctl/kernel.txt | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/Documentation/sysctl/kernel.txt b/Documentation/sysctl/kernel.txt
index 83ab256..999df6b 100644
--- a/Documentation/sysctl/kernel.txt
+++ b/Documentation/sysctl/kernel.txt
@@ -1,13 +1,16 @@
-Documentation for /proc/sys/kernel/*	kernel version 2.2.10
+Documentation for /proc/sys/kernel/*
+
 	(c) 1998, 1999,  Rik van Riel <riel@nl.linux.org>
 	(c) 2009,        Shen Feng<shen@cn.fujitsu.com>
 
-For general info and legal blurb, please look in README.
+For other authors see the commit history.
+
+For general info and disclaimer, please look in README.
 
 ==============================================================
 
 This file contains documentation for the sysctl files in
-/proc/sys/kernel/ and is valid for Linux kernel version 2.2.
+/proc/sys/kernel/.
 
 The files in this directory can be used to tune and monitor
 miscellaneous and general things in the operation of the Linux
-- 
2.1.4

Re: [PATCH 1/1] Documentation/sysctl/kernel.txt: header

[Kees Cook]

On Wed, Feb 25, 2015 at 10:43 AM, Heinrich Schuchardt
<xypron.glpk@gmx.de> wrote:
> The header of Documentation/sysctl/kernel.txt should not refer to
> Linux 2.2 because most of the lines were changed after that
> release.
>
> The authors that placed a copyright notice produced less than
> half of the lines. So give credit to the other authors.
>
> Replace "legal blurb" by a more precise term.
>
> Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

Seems right to me. :)

Acked-by: Kees Cook <keescook@chromium.org>

Thanks!

-Kees

> ---
>  Documentation/sysctl/kernel.txt | 9 ++++++---
>  1 file changed, 6 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/sysctl/kernel.txt b/Documentation/sysctl/kernel.txt
> index 83ab256..999df6b 100644
> --- a/Documentation/sysctl/kernel.txt
> +++ b/Documentation/sysctl/kernel.txt
> @@ -1,13 +1,16 @@
> -Documentation for /proc/sys/kernel/*   kernel version 2.2.10
> +Documentation for /proc/sys/kernel/*
> +
>         (c) 1998, 1999,  Rik van Riel <riel@nl.linux.org>
>         (c) 2009,        Shen Feng<shen@cn.fujitsu.com>
>
> -For general info and legal blurb, please look in README.
> +For other authors see the commit history.
> +
> +For general info and disclaimer, please look in README.
>
>  ==============================================================
>
>  This file contains documentation for the sysctl files in
> -/proc/sys/kernel/ and is valid for Linux kernel version 2.2.
> +/proc/sys/kernel/.
>
>  The files in this directory can be used to tune and monitor
>  miscellaneous and general things in the operation of the Linux
> --
> 2.1.4
>



-- 
Kees Cook
Chrome OS Security

Re: [PATCH 1/1] Documentation/sysctl/kernel.txt: header

[Jonathan Corbet]

On Wed, 25 Feb 2015 19:43:17 +0100
Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:

> +For other authors see the commit history.
> +
> +For general info and disclaimer, please look in README.

It generally seems fine, but the above text could just as reasonably be
put into every file in the tree.  How about if we just take it out?

Thanks,

jon

Re: [PATCH 1/1] Documentation/sysctl/kernel.txt: header

[Heinrich Schuchardt]

On 25.02.2015 20:01, Jonathan Corbet wrote:
> On Wed, 25 Feb 2015 19:43:17 +0100
> Heinrich Schuchardt <xypron.glpk@gmx.de> wrote:
> 
>> +For other authors see the commit history.

Yes I can delete it.

>> +
>> +For general info and disclaimer, please look in README.
> 
> It generally seems fine, but the above text could just as reasonably be
> put into every file in the tree.  How about if we just take it out?
> 
> Thanks,
> 
> jon
> 
Most directories in Documentation do not have a README. So refering to
it seems ok.

I guess the chapter "Legal blurb" could be deleted from README. That
information is already in /COPYING.

So maybe we should replace
-For general info and legal blurb, please look in README.
by
+For an overview of sysctl, please look in README.
and in a separate patch remove the "Legal blurb" section from README.

Best regards

Heinrich