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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Fri, Feb 28, 2020 at 10:14 AM Mauro Carvalho Chehab
<mchehab+huawei@xxxxxxxxxx> wrote:
>
> Hi Rafael,
>
> Em Mon, 17 Feb 2020 21:06:20 +0100
> "Rafael J. Wysocki" <rafael@xxxxxxxxxx> escreveu:
>
> > On Mon, Feb 17, 2020 at 5:20 PM Mauro Carvalho Chehab
> > <mchehab+huawei@xxxxxxxxxx> 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.
>
> Sorry, I completely forgot that you asked to skip the old cpufreq docs.
> My bad!
>
> The thing is that I have now fully converted all docs to ReST (with a
> handful exceptions for things that may not make sense to convert, like
> configuration files that ends with .txt).

And I have this patch:

https://patchwork.kernel.org/patch/11411035/

so at least please drop the commits converting the three files affected by it.

> As a matter of helping those (like me) that are trying to finish this
> huge conversion/reorganize task, I would very much prefer to keep those
> files converted somewhere (or trashed, if their contents is now completely
> garbage).
>
> One of the things we discussed at linux-doc ML is to create a "staging"
> area where we can place:
>
> - things that aren't ready to be at the main documentation body yet;
> - too obsolete docs that may require major work;
> - things that we didn't find a good place to put yet.
>
> From the last discussions, it seems we reach a consensus about creating that.

So the other files in Documentation/cpu-freq/ can be converted to .rst
as far as I'm concerned (even though I still don't see much value in
doing that, just for the record).

They will be going away anyway in the future, regardless of the format
in which they are at that time. :-)

Cheers!



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux