Re: [PATCH v2 14/24] docs: cpu-freq: convert index.txt to ReST

["Rafael J. Wysocki" <rafael@kernel.org>]

On Mon, Feb 17, 2020 at 5:20 PM Mauro Carvalho Chehab
<mchehab+huawei@kernel.org> wrote:
>
> most of the stuff there can be re-used with ReST format,
> but we need to add an empty TOC and remove the existing
> entries, as the following conversion patches will be re-adding
> them, as they're converted.

I see a very little value in converting the files in the cpu-freq
directory from .txt to .rst, which I have told you at least twice.

They are just old-style driver API documents for cpufreq, but moving
them under driver-api/ as they are would not be a good idea IMO,
because at least some of them are outdated (note that the admin-guide
part of the cpufreq documentation, in the .rst format, is located
under admin-guide/).

I haven't had the time to write a proper replacement for them yet and
honestly I find it quite obnoxious to see these reoccurring attempts
to blindly convert them to .rst without taking care of their contents
and location.

I will take care of these files at one point as promised, but that's
not going to happen today or tomorrow and please just leave them alone
if that is not a big deal.

Thanks!

> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  Documentation/cpu-freq/index.rst | 35 ++++++++++++++++++++
>  Documentation/cpu-freq/index.txt | 56 --------------------------------
>  Documentation/index.rst          |  1 +
>  3 files changed, 36 insertions(+), 56 deletions(-)
>  create mode 100644 Documentation/cpu-freq/index.rst
>  delete mode 100644 Documentation/cpu-freq/index.txt
>
> diff --git a/Documentation/cpu-freq/index.rst b/Documentation/cpu-freq/index.rst
> new file mode 100644
> index 000000000000..1bff3dfddd23
> --- /dev/null
> +++ b/Documentation/cpu-freq/index.rst
> @@ -0,0 +1,35 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +==============================================================================
> +Linux CPUFreq - CPU frequency and voltage scaling code in the Linux(TM) kernel
> +==============================================================================
> +
> +Author: Dominik Brodowski  <linux@brodo.de>
> +
> +   Clock scaling allows you to change the clock speed of the CPUs on the
> +   fly. This is a nice method to save battery power, because the lower
> +   the clock speed, the less power the CPU consumes.
> +
> +
> +.. toctree::
> +   :maxdepth: 1
> +
> +Mailing List
> +------------
> +There is a CPU frequency changing CVS commit and general list where
> +you can report bugs, problems or submit patches. To post a message,
> +send an email to linux-pm@vger.kernel.org.
> +
> +Links
> +-----
> +the FTP archives:
> +* ftp://ftp.linux.org.uk/pub/linux/cpufreq/
> +
> +how to access the CVS repository:
> +* http://cvs.arm.linux.org.uk/
> +
> +the CPUFreq Mailing list:
> +* http://vger.kernel.org/vger-lists.html#linux-pm
> +
> +Clock and voltage scaling for the SA-1100:
> +* http://www.lartmaker.nl/projects/scaling
> diff --git a/Documentation/cpu-freq/index.txt b/Documentation/cpu-freq/index.txt
> deleted file mode 100644
> index c15e75386a05..000000000000
> --- a/Documentation/cpu-freq/index.txt
> +++ /dev/null
> @@ -1,56 +0,0 @@
> -     CPU frequency and voltage scaling code in the Linux(TM) kernel
> -
> -
> -                        L i n u x    C P U F r e q
> -
> -
> -
> -
> -                   Dominik Brodowski  <linux@brodo.de>
> -
> -
> -
> -   Clock scaling allows you to change the clock speed of the CPUs on the
> -    fly. This is a nice method to save battery power, because the lower
> -            the clock speed, the less power the CPU consumes.
> -
> -
> -
> -Documents in this directory:
> -----------------------------
> -
> -amd-powernow.txt -     AMD powernow driver specific file.
> -
> -core.txt       -       General description of the CPUFreq core and
> -                       of CPUFreq notifiers.
> -
> -cpu-drivers.txt -      How to implement a new cpufreq processor driver.
> -
> -cpufreq-nforce2.txt -  nVidia nForce2 platform specific file.
> -
> -cpufreq-stats.txt -    General description of sysfs cpufreq stats.
> -
> -index.txt      -       File index, Mailing list and Links (this document)
> -
> -pcc-cpufreq.txt -      PCC cpufreq driver specific file.
> -
> -
> -Mailing List
> -------------
> -There is a CPU frequency changing CVS commit and general list where
> -you can report bugs, problems or submit patches. To post a message,
> -send an email to linux-pm@vger.kernel.org.
> -
> -Links
> ------
> -the FTP archives:
> -* ftp://ftp.linux.org.uk/pub/linux/cpufreq/
> -
> -how to access the CVS repository:
> -* http://cvs.arm.linux.org.uk/
> -
> -the CPUFreq Mailing list:
> -* http://vger.kernel.org/vger-lists.html#linux-pm
> -
> -Clock and voltage scaling for the SA-1100:
> -* http://www.lartmaker.nl/projects/scaling
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index e99d0bd2589d..4cf37ad1cd1d 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -99,6 +99,7 @@ needed).
>     accounting/index
>     block/index
>     cdrom/index
> +   cpu-freq/index
>     ide/index
>     fb/index
>     fpga/index
> --
> 2.24.1
>