linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Guenter Roeck <linux@roeck-us.net>
To: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Andrew Jeffery <andrew@aj.id.au>,
	Benjamin Herrenschmidt <benh@kernel.crashing.org>,
	Jean Delvare <jdelvare@suse.com>, Joel Stanley <joel@jms.id.au>,
	linux-arm-kernel@lists.infradead.org,
	linux-aspeed@lists.ozlabs.org, linux-hwmon@vger.kernel.org,
	linuxppc-dev@lists.ozlabs.org, Liviu Dudau <liviu.dudau@arm.com>,
	Lorenzo Pieralisi <lorenzo.pieralisi@arm.com>,
	Michael Ellerman <mpe@ellerman.id.au>,
	Paul Mackerras <paulus@samba.org>,
	Sudeep Holla <sudeep.holla@arm.com>
Subject: Re: [PATCH v2 00/21] Convert hwmon documentation to ReST
Date: Fri, 12 Apr 2019 17:52:01 -0700	[thread overview]
Message-ID: <f1b5ebcd-bd8c-817f-1394-fd2742c5d8b3@roeck-us.net> (raw)
In-Reply-To: <20190412212541.0cde9452@coco.lan>

On 4/12/19 5:25 PM, Mauro Carvalho Chehab wrote:
> Em Fri, 12 Apr 2019 09:12:52 -0700
> Guenter Roeck <linux@roeck-us.net> escreveu:
> 
>> On 4/12/19 9:04 AM, Jonathan Corbet wrote:
>>> On Thu, 11 Apr 2019 14:07:31 -0700
>>> Guenter Roeck <linux@roeck-us.net> wrote:
>>>    
>>>>> While nobody does such split, IMHO, the best would be to keep the
>>>>> information outside Documentation/admin-guide. But hey! You're
>>>>> the Doc maintainer. If you prefer to move, I'm perfectly fine
>>>>> with that.
>>>>>       
>>>>
>>>> Same here, but please don't move the files which are kernel facing only.
>>>
>>> Well, let's step back and think about this.  Who is the audience for
>>> these documents?  That will tell us a lot about where they should really
>>> be.
>>>    
>>
>> Most of them are for users, some of them are for driver developers. A few
>> are for both, though that is generally not the intention (and one may argue
>> that driver internal documentation should be moved into the respective
>> driver source).
> 
> The big issue is really those files that contain both kernel internals
> and userspace stuff.
> 
> This is a common pattern. I just finishing converting a lot more
> documents to ReST and I found the same thing on almost all document
> directories I touched.
> 
>>> What I would prefer to avoid is the status quo where *everything* is in
>>> the top-level directory, and where documents are organized for the
>>> convenience of their maintainers rather than of their readers.  But
>>> sometimes I feel like I'm alone in that desire...:)
>>>    
>> I am fine with separating user pointing from kernel API/driver developer
>> guides, and I agree that it would make a lot of sense. As I said, please
>> just make sure that kernel facing files don't end up in the wrong directory.
> 
> I like the idea of splitting user faced documents from the rest, but
> this is not an easy task. On several cases, there are just a couple
> of paragraphs with things like sysfs entries in the middle of a big
> file with Kernel internals.
> 

Yes, I know. I don't think that cleanup is going to happen anytime soon.

Guenter


  reply	other threads:[~2019-04-13  0:52 UTC|newest]

Thread overview: 73+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-10 19:22 [PATCH v2 00/21] Convert hwmon documentation to ReST Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 01/21] docs: hwmon: k10temp: convert to ReST format Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-11 13:05   ` Liviu Dudau
2019-04-10 19:22 ` [PATCH v2 03/21] docs: hwmon: menf21bmc: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 04/21] docs: hwmon: sch5627: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 05/21] docs: hwmon: emc2103: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 06/21] docs: hwmon: pc87360: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 07/21] docs: hwmon: fam15h_power: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 08/21] docs: hwmon: w83791d: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 09/21] docs: hwmon: coretemp: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 10/21] docs: hwmon: aspeed-pwm-tacho: " Mauro Carvalho Chehab
2019-04-11  0:27   ` Andrew Jeffery
2019-04-10 19:22 ` [PATCH v2 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 13/21] docs: hwmon: ads1015: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 14/21] docs: hwmon: dme1737, vt1211: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 15/21] docs: hwmon: wm831x, wm8350: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 16/21] docs: hwmon: da9052, da9055: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 17/21] docs: hwmon: k8temp, w83793: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 18/21] docs: hwmon: pmbus files: " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 19/21] docs: hwmon: misc " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 20/21] docs: hwmon: convert remaining files " Mauro Carvalho Chehab
2019-04-10 19:22 ` [PATCH v2 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-11 13:07   ` Liviu Dudau
2019-04-11 18:43 ` [PATCH v2 00/21] Convert hwmon documentation to ReST Jonathan Corbet
2019-04-11 20:43   ` Mauro Carvalho Chehab
2019-04-11 21:07     ` Guenter Roeck
2019-04-11 23:54       ` Mauro Carvalho Chehab
2019-04-12 16:04       ` Jonathan Corbet
2019-04-12 16:12         ` Guenter Roeck
2019-04-13  0:25           ` Mauro Carvalho Chehab
2019-04-13  0:52             ` Guenter Roeck [this message]
2019-04-13  3:09         ` Guenter Roeck
2019-04-16 20:19           ` Jonathan Corbet
2019-04-16 20:31             ` Guenter Roeck
2019-04-17  1:58               ` Mauro Carvalho Chehab
2019-04-17  3:49                 ` Guenter Roeck
2019-04-17  9:46                   ` [PATCH v3 00/21]Convert " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 01/21] docs: hwmon: k10temp: convert to ReST format Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 02/21] docs: hwmon: vexpress: " Mauro Carvalho Chehab
2019-04-17 10:24                       ` Liviu Dudau
2019-04-17 10:31                         ` Mauro Carvalho Chehab
2019-04-17 11:29                       ` Liviu Dudau
2019-04-17  9:46                     ` [PATCH v3 03/21] docs: hwmon: menf21bmc: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 04/21] docs: hwmon: sch5627: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 05/21] docs: hwmon: emc2103: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 06/21] docs: hwmon: pc87360: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 07/21] docs: hwmon: fam15h_power: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 08/21] docs: hwmon: w83791d: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 09/21] docs: hwmon: coretemp: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 10/21] docs: hwmon: aspeed-pwm-tacho: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 11/21] docs: hwmon: ibmpowernv: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 12/21] docs: hwmon: asc7621: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 13/21] docs: hwmon: ads1015: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 14/21] docs: hwmon: dme1737, vt1211: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 15/21] docs: hwmon: wm831x, wm8350: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 16/21] docs: hwmon: da9052, da9055: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 17/21] docs: hwmon: k8temp, w83793: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 18/21] docs: hwmon: pmbus files: " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 19/21] docs: hwmon: misc " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 20/21] docs: hwmon: convert remaining files " Mauro Carvalho Chehab
2019-04-17  9:46                     ` [PATCH v3 21/21] docs: hwmon: Add an index file and rename docs to *.rst Mauro Carvalho Chehab
2019-04-17 11:31                       ` Liviu Dudau
2019-04-17 16:47                       ` Guenter Roeck
2019-04-17 16:54                         ` Guenter Roeck
2019-04-17 17:13                         ` Mauro Carvalho Chehab
2019-04-17 17:22                           ` Mauro Carvalho Chehab
2019-04-17 17:43                             ` Guenter Roeck
2019-04-17 17:47                               ` Guenter Roeck
2019-04-18  9:44                                 ` Mauro Carvalho Chehab
2019-04-18 13:36                                   ` Guenter Roeck
2019-04-17  9:47                   ` [PATCH v2 00/21] Convert hwmon documentation to ReST Mauro Carvalho Chehab

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=f1b5ebcd-bd8c-817f-1394-fd2742c5d8b3@roeck-us.net \
    --to=linux@roeck-us.net \
    --cc=andrew@aj.id.au \
    --cc=benh@kernel.crashing.org \
    --cc=corbet@lwn.net \
    --cc=jdelvare@suse.com \
    --cc=joel@jms.id.au \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-aspeed@lists.ozlabs.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=liviu.dudau@arm.com \
    --cc=lorenzo.pieralisi@arm.com \
    --cc=mchehab+samsung@kernel.org \
    --cc=mchehab@infradead.org \
    --cc=mpe@ellerman.id.au \
    --cc=paulus@samba.org \
    --cc=sudeep.holla@arm.com \
    /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;
as well as URLs for NNTP newsgroup(s).