From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-6.1 required=3.0 tests=DKIMWL_WL_HIGH,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,MAILING_LIST_MULTI,MENTIONS_GIT_HOSTING,SPF_PASS, URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 8B401C282CE for ; Thu, 11 Apr 2019 23:54:35 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by mail.kernel.org (Postfix) with ESMTP id 5D2FC20869 for ; Thu, 11 Apr 2019 23:54:35 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=default; t=1555026875; bh=iDk7VPNMjyytc6vtXDUph5TANBR9kngZfJ1wQSMo1RE=; h=Date:From:To:Cc:Subject:In-Reply-To:References:List-ID:From; b=DOliM6CUYSqu/E+u1tR1YPQU+F/Toj23QOC/nDbcySw1bl+hnfSh7X+dn2YSB9a8C 5aJaV14XnLnFf6VHs48OhlC88kE+htusKwBTIG2Gr/pdO7KeL4mHsWUAsELBIdUWFx R/cVh6yb2rLLXr4b7RVw/gfa+mIqDIGui1p4KGfA= Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1727170AbfDKXye (ORCPT ); Thu, 11 Apr 2019 19:54:34 -0400 Received: from casper.infradead.org ([85.118.1.10]:47202 "EHLO casper.infradead.org" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1726778AbfDKXyd (ORCPT ); Thu, 11 Apr 2019 19:54:33 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=infradead.org; s=casper.20170209; h=Content-Transfer-Encoding:Content-Type: MIME-Version:References:In-Reply-To:Message-ID:Subject:Cc:To:From:Date:Sender :Reply-To:Content-ID:Content-Description:Resent-Date:Resent-From: Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID:List-Id:List-Help: List-Unsubscribe:List-Subscribe:List-Post:List-Owner:List-Archive; bh=5+tH/MOpUFSidIY9WhSFyEPUDHOXXaJKp7Fz0cd8hdM=; b=ePP6Db/DLudz1vlMEo/ff/KUH5 OqIIhxDmQ5npakBG0WwaLJRr/hxePnhmsXGFwPXcxVRFB2xCAa1wjqQFPEgJ8E4iFw+Z3OmsG3tVQ FRti79d0KGc3O0/B1/F1j3HZk8C/gWPCHLOlyVvkbEJ3Wel9ntoME3ghT9JVauUcmnTu7Bo1SlJPP 8KF0sbpgUTXpRCaDIUl9dfzF1WMVTubdsMz0W9ACuGbff+7jKZ2hQHvRheIRgivLzVJtqUHfgghuD K9eFeM+TdFLYi9bZ1i2IOC559xIxUykO5u/frgkzO6gFr0YH3TeZ7iQynn2f2tU5Rs3d7wyZlDJqO 82tOS35Q==; Received: from 201.86.162.146.dynamic.adsl.gvt.net.br ([201.86.162.146] helo=coco.lan) by casper.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1hEjWT-0006at-9F; Thu, 11 Apr 2019 23:54:25 +0000 Date: Thu, 11 Apr 2019 20:54:17 -0300 From: Mauro Carvalho Chehab To: Guenter Roeck Cc: Jonathan Corbet , Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Andrew Jeffery , Benjamin Herrenschmidt , Jean Delvare , Joel Stanley , linux-arm-kernel@lists.infradead.org, linux-aspeed@lists.ozlabs.org, linux-hwmon@vger.kernel.org, linuxppc-dev@lists.ozlabs.org, Liviu Dudau , Lorenzo Pieralisi , Michael Ellerman , Paul Mackerras , Sudeep Holla Subject: Re: [PATCH v2 00/21] Convert hwmon documentation to ReST Message-ID: <20190411205417.187f9565@coco.lan> In-Reply-To: <20190411210731.GA29378@roeck-us.net> References: <20190411124324.3ed62fad@lwn.net> <20190411174357.251904f5@coco.lan> <20190411210731.GA29378@roeck-us.net> X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Em Thu, 11 Apr 2019 14:07:31 -0700 Guenter Roeck escreveu: > On Thu, Apr 11, 2019 at 05:43:57PM -0300, Mauro Carvalho Chehab wrote: > > Em Thu, 11 Apr 2019 12:43:24 -0600 > > Jonathan Corbet escreveu: > > > > > On Wed, 10 Apr 2019 16:22:37 -0300 > > > Mauro Carvalho Chehab wrote: > > > > > > > This series converts the contents of Documentation/hwmon to ReST > > > > format. > > > > > > > > PS.: I opted to group the conversion files per groups of maintainer > > > > set, as, if I were to generate one patch per file, it would give around > > > > 160 patches. > > > > > > > > I also added those patches to my development tree at: > > > > https://git.linuxtv.org/mchehab/experimental.git/log/?h=hwmon > > > > > > > > If you want to see the results, they're at: > > > > https://www.infradead.org/~mchehab/hwmon/ > > > > > > This set seems generally good and could probably be applied as-is. But I > > > have to ask...is there a reason to not take the last step and actually > > > bring this stuff into the Sphinx doc tree? > > > > > > We seem to be mostly documenting sysfs files and such. I am *guessing* > > > that perhaps the set should move to Documentation/admin-guide/hwmon? Or > > > have I misunderstood the intended audience here? > > > > :-) > > > > Yeah, I'd say that 80% of the contents there are user-faced. > > > > Yet, the main issue with this (and other driver subsystems) is that there's > > a mix of userspace and Kernelspace stuff. One somewhat simple case is > > the abituguru: it has a "datasheet" file: > > > > abituguru-datasheet > > > > This contains programming information for the corresponding drivers, > > while abituguru and abituguru3 contains mostly userspace > > stuff (still, it also contains the I2C address, with shouldn't mean > > anything for the user). > > > > However, if you take a look at w83781d, you'll see a mix of both > > userspace and driver developer info there... it has a chapter called > > "Data sheet updates", for example, with is probably meaningless for > > anyone but the hwmon driver developers. > > > > That's, btw, a pattern that happens a lot inside device driver > > documents on almost all subsystems I checked: driver-specific > > documentation is usually not split into user-facing/kernel-facing. > > > > 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. > > How do you want to handle this series ? Do you expect it to be pushed > through hwmon, or through Documentation, or do you plan to push yourself ? > > If the series isn't pushed through hwmon, we'll likely have a couple of > conflicts against hwmon-next. Guenter, I won't be pushing it myself. IMO, it makes more sense to apply it at hwmon-next, except if it would cause some conflicts against docs-next. Regards, Mauro