linux-kernel - Re: [PATCH 0/6] ReST conversion patches not applied yet

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20190731182729.01c98cd3@coco.lan>
Date:   Wed, 31 Jul 2019 18:27:29 -0300
From:   Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
To:     Mark Brown <broonie@...nel.org>
Cc:     Jonathan Corbet <corbet@....net>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org, alsa-devel@...a-project.org,
        Maxime Ripard <maxime.ripard@...tlin.com>,
        samba-technical@...ts.samba.org, devicetree@...r.kernel.org,
        Liam Girdwood <lgirdwood@...il.com>, linux-iio@...r.kernel.org,
        Lars-Peter Clausen <lars@...afoo.de>,
        Evgeniy Dushistov <dushistov@...l.ru>,
        Jonathan Cameron <jic23@...nel.org>,
        Peter Meerwald-Stadler <pmeerw@...erw.net>,
        Steve French <sfrench@...ba.org>,
        Alexander Shishkin <alexander.shishkin@...ux.intel.com>,
        Chen-Yu Tsai <wens@...e.org>,
        Suzuki K Poulose <suzuki.poulose@....com>,
        linux-cifs@...r.kernel.org, Dave Kleikamp <shaggy@...nel.org>,
        Mark Rutland <mark.rutland@....com>,
        Evgeniy Polyakov <zbr@...emap.net>,
        Mathieu Poirier <mathieu.poirier@...aro.org>,
        Rob Herring <robh+dt@...nel.org>,
        jfs-discussion@...ts.sourceforge.net,
        linux-arm-kernel@...ts.infradead.org,
        Hartmut Knaack <knaack.h@....de>, linux-spi@...r.kernel.org
Subject: Re: [PATCH 0/6] ReST conversion patches not applied yet

Em Wed, 31 Jul 2019 21:37:12 +0100
Mark Brown <broonie@...nel.org> escreveu:

> On Wed, Jul 31, 2019 at 05:26:13PM -0300, Mauro Carvalho Chehab wrote:
> > Mark Brown <broonie@...nel.org> escreveu:  
> 
> > > There were outstanding questions about where it was going to get moved
> > > to but if I read the diff correctly it looks like it didn't actually get
> > > moved in the end?  
> 
> > Yeah, it doesn't have the move. My understanding from our discussions
> > is that we didn't reach a conclusion.  
> 
> Yes, that was my understanding too which was why I was surprised to see
> this going in.  This is OK then, I'd have acked it.
> 
> > In any case, I can send a separate patch with the move part once
> > we reach an agreement about what's the best way to proceed (or you
> > can do it directly, if you prefer so).  
> 
> I'm not likely to do anything without someone sending patches, I'm not
> clear on the utility of the move with the current division of the
> manuals.

Same here: I do see value on having docs focused on their audience.

Yet, I'm not so sure how worth is to break some subsystem documentation 
into books, as, on some cases, this would mean huge efforts.

I'd prefer to see the big picture first, finishing the conversion and
then looking at the resulting docs.

Meanwhile, if someone needs something that it is at the wrong book, he
can just use some search tool to seek what he needs, no matter on
what book the relevant information is stored.

> I don't know if it makes sense to have an embedded developer's
> manual as well?

Yeah, that's a good question. 

Jon is planning todo a documentation track at LPC. One of the things
that should be discussed, IMO, is how we'll organize the books.

I suspect that, once we finish the conversion of the remaining ~300
files to ReST, the next logical step is to check what are the gaps
and have a list of pending tasks.

Thanks,
Mauro