From mboxrd@z Thu Jan 1 00:00:00 1970 From: Jonathan Corbet Subject: Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst Date: Tue, 23 Apr 2019 16:06:40 -0600 Message-ID: <20190423160640.70c9703f@lwn.net> References: <20190423083135.GA11158@hirez.programming.kicks-ass.net> <20190423125519.GA7104@redhat.com> <20190423130132.GT4038@hirez.programming.kicks-ass.net> <20190423103053.07cf2149@lwn.net> <20190423171158.GG12232@hirez.programming.kicks-ass.net> <20190423172006.GD16353@zn.tnic> <20190423170409.7b1370ac@coco.lan> <20190423213816.GE16353@zn.tnic> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <20190423213816.GE16353-Jj63ApZU6fQ@public.gmane.org> List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Sender: iommu-bounces-cunTk1MwBs9QetFLy7KEm3xJsTq8ys+cHZ5vskTnxNA@public.gmane.org Errors-To: iommu-bounces-cunTk1MwBs9QetFLy7KEm3xJsTq8ys+cHZ5vskTnxNA@public.gmane.org To: Borislav Petkov Cc: Mike Snitzer , "Rafael J. Wysocki" , Linus Walleij , Farhan Ali , Will Deacon , dri-devel-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org, Jaroslav Kysela , Mauro Carvalho Chehab , Christoph Hellwig , linux-arch-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, linux-sh-u79uwXL29TY76Z2rM5mHXA@public.gmane.org, James Morris , Halil Pasic , tboot-devel-5NWGOfrQmneRv+LV9MX5uipxlwaOVQ5f@public.gmane.org, Alan Stern , openipmi-developer-5NWGOfrQmneRv+LV9MX5uipxlwaOVQ5f@public.gmane.org, Guenter Roeck , Boqun Feng , Nicholas Piggin , Alex Williamson , Matt Mackall , Thomas Gleixner , Sean Paul , Greg Kroah-Hartman List-Id: linux-gpio@vger.kernel.org On Tue, 23 Apr 2019 23:38:16 +0200 Borislav Petkov wrote: > But exactly this - *having* to do rst formatting would mean a lot of > getting used to and people writing something which is not necessarily > correct rst and someone else fixing up after them. Remember that most of our docs are 99% RST even though they were written by people who had never even heard of RST. I really don't think it's a big deal - a far smaller cognitive load than trying to keep up with any given subsystem's variable-declaration-ordering rules, for example :) > Another pain point is changing the file paths. Without cscope I would've > been cursing each time I'm looking for kernel-parameters.txt, for > example. First of all, it is in Documentation/admin-guide/ now and then > there's Documentation/admin-guide/kernel-parameters.rst too. Moving of files has nothing to do with RST, of course. That you can blame entirely on me trying to bring some order to Documentation/. As a predecessor of mine once put it (https://lkml.org/lkml/2007/7/3/422): Documentation/* is a gigantic mess, currently organized based on where random passers-by put things down last. When other parts of the kernel tree turn out to be organized in less-than-useful ways, we move things around. I'm trying to do the same in Documentation/, with an attempt to be sympathetic toward our readers, sort things by intended audience, and create (someday) a coherent whole. I agree that moving docs is a short-term annoyance, but I'm hoping that it brings a long-term benefit. > So* I'd suggest having as less markup in those files as possible and if > it is needed, automate adding the needed markup, as Jon suggested. Minimal markup is the policy (it's even documented :). Automating stuff that can be automated is an area that has definitely not received enough attention; hopefully some things can be done there in the very near future. Thanks, jon 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=-1.0 required=3.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_PASS,URIBL_BLOCKED autolearn=ham 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 CCC76C282DD for ; Tue, 23 Apr 2019 22:07:11 +0000 (UTC) Received: from mail.linuxfoundation.org (mail.linuxfoundation.org [140.211.169.12]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id A4E9821738 for ; Tue, 23 Apr 2019 22:07:11 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org A4E9821738 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=lwn.net Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=iommu-bounces@lists.linux-foundation.org Received: from mail.linux-foundation.org (localhost [127.0.0.1]) by mail.linuxfoundation.org (Postfix) with ESMTP id 575B3F34; Tue, 23 Apr 2019 22:07:11 +0000 (UTC) Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id 3809AF1A for ; Tue, 23 Apr 2019 22:07:10 +0000 (UTC) X-Greylist: domain auto-whitelisted by SQLgrey-1.7.6 Received: from ms.lwn.net (ms.lwn.net [45.79.88.28]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id A9351829 for ; Tue, 23 Apr 2019 22:07:09 +0000 (UTC) Received: from localhost.localdomain (localhost [127.0.0.1]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ms.lwn.net (Postfix) with ESMTPSA id 7922A2DD; Tue, 23 Apr 2019 22:06:45 +0000 (UTC) Date: Tue, 23 Apr 2019 16:06:40 -0600 From: Jonathan Corbet To: Borislav Petkov Subject: Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst Message-ID: <20190423160640.70c9703f@lwn.net> In-Reply-To: <20190423213816.GE16353@zn.tnic> References: <20190423083135.GA11158@hirez.programming.kicks-ass.net> <20190423125519.GA7104@redhat.com> <20190423130132.GT4038@hirez.programming.kicks-ass.net> <20190423103053.07cf2149@lwn.net> <20190423171158.GG12232@hirez.programming.kicks-ass.net> <20190423172006.GD16353@zn.tnic> <20190423170409.7b1370ac@coco.lan> <20190423213816.GE16353@zn.tnic> Organization: LWN.net X-Mailer: Claws Mail 3.17.3 (GTK+ 2.24.32; x86_64-redhat-linux-gnu) MIME-Version: 1.0 Cc: Mike Snitzer , "Rafael J. Wysocki" , Linus Walleij , Farhan Ali , Will Deacon , dri-devel@lists.freedesktop.org, Jaroslav Kysela , Mauro Carvalho Chehab , Christoph Hellwig , linux-arch@vger.kernel.org, linux-sh@vger.kernel.org, James Morris , Halil Pasic , tboot-devel@lists.sourceforge.net, Alan Stern , openipmi-developer@lists.sourceforge.net, Guenter Roeck , Boqun Feng , Nicholas Piggin , Alex Williamson , Matt Mackall , Thomas Gleixner , Sean Paul , Greg Kroah-Hartman , linux-wireless@vger.kernel.org, linux-kernel@vger.kernel.org, linux-crypto@vger.kernel.org, Mark Rutland , linux-fbdev@vger.kernel.org, linux-ia64@vger.kernel.org, Linux Doc Mailing List , David Airlie , "James E.J. Bottomley" , dm-devel@redhat.com, Harry Wei , Manivannan Sadhasivam , Alasdair Kergon , linux-s390@vger.kernel.org, Alex Shi , Yoshinori Sato , Helge Deller , Sumit Semwal , Bartosz Golaszewski , Changbin Du , Eric Farman , linux-watchdog@vger.kernel.org, Corey Minyard , Mauro Carvalho Chehab , linaro-mm-sig@lists.linaro.org, linux-gpio@vger.kernel.org, Bjorn Helgaas , linux-arm-kernel@lists.infradead.org, Tony Luck , Cornelia Huck , "David S. Miller" , Martin Schwidefsky , Andrea Parri , linux-pci@vger.kernel.org, Akira Yokosawa , Heiko Carstens , platform-driver-x86@vger.kernel.org, "Paul E. McKenney" , Kishon Vijay Abraham I , Peter Zijlstra , Emese Revfy , Darren Hart , Jade Alglave , "Serge E. Hallyn" , Fenghua Yu , Kees Cook , Arnd Bergmann , Bartlomiej Zolnierkiewicz , Ning Sun , Luc Maranget , Kurt Schwemmer , Guan Xuetao , linux-parisc@vger.kernel.org, iommu@lists.linux-foundation.org, Stuart Hayes , Logan Gunthorpe , Andreas =?UTF-8?B?RsOkcmJlcg==?= , Rich Felker , kvm@vger.kernel.org, Maxime Ripard , Jerry Hoemann , David Howells , linux-mm@kvack.org, Kirti Wankhede , kernel-hardening@lists.openwall.com, "H. Peter Anvin" , sparclinux@vger.kernel.org, Steffen Klassert , Herbert Xu , x86@kernel.org, Russell King , Ingo Molnar , devicetree@vger.kernel.org, Daniel Lustig , Maarten Lankhorst , linux-block@vger.kernel.org, Rob Herring , Wim Van Sebroeck , Jens Axboe , netdev@vger.kernel.org, linux-security-module@vger.kernel.org, Daniel Vetter , Johannes Berg , Robin Murphy , Andy Shevchenko X-BeenThere: iommu@lists.linux-foundation.org X-Mailman-Version: 2.1.12 Precedence: list List-Id: Development issues for Linux IOMMU support List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 7bit Sender: iommu-bounces@lists.linux-foundation.org Errors-To: iommu-bounces@lists.linux-foundation.org Message-ID: <20190423220640.8MqK2OOWcm9tvGD1Sixjk4AkEE77vq3fFbRShu1Hsas@z> On Tue, 23 Apr 2019 23:38:16 +0200 Borislav Petkov wrote: > But exactly this - *having* to do rst formatting would mean a lot of > getting used to and people writing something which is not necessarily > correct rst and someone else fixing up after them. Remember that most of our docs are 99% RST even though they were written by people who had never even heard of RST. I really don't think it's a big deal - a far smaller cognitive load than trying to keep up with any given subsystem's variable-declaration-ordering rules, for example :) > Another pain point is changing the file paths. Without cscope I would've > been cursing each time I'm looking for kernel-parameters.txt, for > example. First of all, it is in Documentation/admin-guide/ now and then > there's Documentation/admin-guide/kernel-parameters.rst too. Moving of files has nothing to do with RST, of course. That you can blame entirely on me trying to bring some order to Documentation/. As a predecessor of mine once put it (https://lkml.org/lkml/2007/7/3/422): Documentation/* is a gigantic mess, currently organized based on where random passers-by put things down last. When other parts of the kernel tree turn out to be organized in less-than-useful ways, we move things around. I'm trying to do the same in Documentation/, with an attempt to be sympathetic toward our readers, sort things by intended audience, and create (someday) a coherent whole. I agree that moving docs is a short-term annoyance, but I'm hoping that it brings a long-term benefit. > So* I'd suggest having as less markup in those files as possible and if > it is needed, automate adding the needed markup, as Jon suggested. Minimal markup is the policy (it's even documented :). Automating stuff that can be automated is an area that has definitely not received enough attention; hopefully some things can be done there in the very near future. Thanks, jon _______________________________________________ iommu mailing list iommu@lists.linux-foundation.org https://lists.linuxfoundation.org/mailman/listinfo/iommu From mboxrd@z Thu Jan 1 00:00:00 1970 Date: Tue, 23 Apr 2019 16:06:40 -0600 From: Jonathan Corbet Subject: Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst Message-ID: <20190423160640.70c9703f@lwn.net> In-Reply-To: <20190423213816.GE16353@zn.tnic> References: <20190423083135.GA11158@hirez.programming.kicks-ass.net> <20190423125519.GA7104@redhat.com> <20190423130132.GT4038@hirez.programming.kicks-ass.net> <20190423103053.07cf2149@lwn.net> <20190423171158.GG12232@hirez.programming.kicks-ass.net> <20190423172006.GD16353@zn.tnic> <20190423170409.7b1370ac@coco.lan> <20190423213816.GE16353@zn.tnic> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 8bit To: Borislav Petkov Cc: Mauro Carvalho Chehab , Peter Zijlstra , Mike Snitzer , Linux Doc Mailing List , Mauro Carvalho Chehab , linux-kernel@vger.kernel.org, Johannes Berg , Kurt Schwemmer , Logan Gunthorpe , Bjorn Helgaas , Alasdair Kergon , dm-devel@redhat.com, Kishon Vijay Abraham I , Rob Herring , Mark Rutland , Bartlomiej Zolnierkiewicz , David Airlie , Daniel Vetter , Maarten Lankhorst , Maxime Ripard , Sean Paul , Ning Sun , Ingo Molnar , Will Deacon , Alan Stern , Andrea Parri , Boqun Feng , Nicholas Piggin , David Howells , Jade Alglave , Luc Maranget , "Paul E. McKenney" , Akira Yokosawa , Daniel Lustig , "David S. Miller" , Andreas =?UTF-8?B?RsOkcmJlcg==?= , Manivannan Sadhasivam , Cornelia Huck , Farhan Ali , Eric Farman , Halil Pasic , Martin Schwidefsky , Heiko Carstens , Harry Wei , Alex Shi , Jerry Hoemann , Wim Van Sebroeck , Guenter Roeck , Thomas Gleixner , "H. Peter Anvin" , x86@kernel.org, Russell King , Tony Luck , Fenghua Yu , "James E.J. Bottomley" , Helge Deller , Yoshinori Sato , Rich Felker , Guan Xuetao , Jens Axboe , Greg Kroah-Hartman , "Rafael J. Wysocki" , Arnd Bergmann , Matt Mackall , Herbert Xu , Corey Minyard , Sumit Semwal , Linus Walleij , Bartosz Golaszewski , Darren Hart , Andy Shevchenko , Stuart Hayes , Jaroslav Kysela , Alex Williamson , Kirti Wankhede , Christoph Hellwig , Marek Szyprowski , Robin Murphy , Steffen Klassert , Kees Cook , Emese Revfy , James Morris , "Serge E. Hallyn" , linux-wireless@vger.kernel.org, linux-pci@vger.kernel.org, devicetree@vger.kernel.org, dri-devel@lists.freedesktop.org, linux-fbdev@vger.kernel.org, tboot-devel@lists.sourceforge.net, linux-arch@vger.kernel.org, netdev@vger.kernel.org, linux-arm-kernel@lists.infradead.org, linux-s390@vger.kernel.org, kvm@vger.kernel.org, linux-watchdog@vger.kernel.org, linux-ia64@vger.kernel.org, linux-parisc@vger.kernel.org, linux-sh@vger.kernel.org, sparclinux@vger.kernel.org, linux-block@vger.kernel.org, linux-crypto@vger.kernel.org, openipmi-developer@lists.sourceforge.net, linaro-mm-sig@lists.linaro.org, linux-gpio@vger.kernel.org, platform-driver-x86@vger.kernel.org, iommu@lists.linux-foundation.org, linux-mm@kvack.org, kernel-hardening@lists.openwall.com, linux-security-module@vger.kernel.org, Changbin Du List-ID: On Tue, 23 Apr 2019 23:38:16 +0200 Borislav Petkov wrote: > But exactly this - *having* to do rst formatting would mean a lot of > getting used to and people writing something which is not necessarily > correct rst and someone else fixing up after them. Remember that most of our docs are 99% RST even though they were written by people who had never even heard of RST. I really don't think it's a big deal - a far smaller cognitive load than trying to keep up with any given subsystem's variable-declaration-ordering rules, for example :) > Another pain point is changing the file paths. Without cscope I would've > been cursing each time I'm looking for kernel-parameters.txt, for > example. First of all, it is in Documentation/admin-guide/ now and then > there's Documentation/admin-guide/kernel-parameters.rst too. Moving of files has nothing to do with RST, of course. That you can blame entirely on me trying to bring some order to Documentation/. As a predecessor of mine once put it (https://lkml.org/lkml/2007/7/3/422): Documentation/* is a gigantic mess, currently organized based on where random passers-by put things down last. When other parts of the kernel tree turn out to be organized in less-than-useful ways, we move things around. I'm trying to do the same in Documentation/, with an attempt to be sympathetic toward our readers, sort things by intended audience, and create (someday) a coherent whole. I agree that moving docs is a short-term annoyance, but I'm hoping that it brings a long-term benefit. > So* I'd suggest having as less markup in those files as possible and if > it is needed, automate adding the needed markup, as Jon suggested. Minimal markup is the policy (it's even documented :). Automating stuff that can be automated is an area that has definitely not received enough attention; hopefully some things can be done there in the very near future. Thanks, jon