From mboxrd@z Thu Jan 1 00:00:00 1970 From: Mauro Carvalho Chehab Subject: Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst Date: Tue, 23 Apr 2019 17:19:44 -0300 Message-ID: <20190423171944.7ac6db54@coco.lan> 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> <20190423115349.589c3d50@lwn.net> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <20190423115349.589c3d50-T1hC0tSOHrs@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: Jonathan Corbet Cc: Mike Snitzer , "Rafael J. Wysocki" , Linus Walleij , Farhan Ali , Will Deacon , dri-devel-PD4FTy7X32lNgt0PjOBp9y5qC8QIuHrW@public.gmane.org, Jaroslav Kysela , kernel-hardening-ZwoEplunGu1jrUoiu81ncdBPR1lH4CV8@public.gmane.org, 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 , linux-wireless@v List-Id: linux-gpio@vger.kernel.org Em Tue, 23 Apr 2019 11:53:49 -0600 Jonathan Corbet escreveu: > On Tue, 23 Apr 2019 19:11:58 +0200 > Peter Zijlstra wrote: > > > Look at crap like this: > > > > "The memory allocations via :c:func:`kmalloc`, :c:func:`vmalloc`, > > :c:func:`kmem_cache_alloc` and" > > > > That should've been written like: > > > > "The memory allocations via kmalloc(), vmalloc(), kmem_cache_alloc() > > and" > > Yeah, I get it. That markup generates cross-references, which can be > seriously useful for readers - we want that. But I do wonder if we > couldn't do it automatically with just a little bit of scripting work. > It's not to hard to recognize this_is_a_function(), after all. I'll look > into that, it would definitely help to remove some gunk from the source > docs. While on it, one thing that I noticed on several documents is that they reference other documents by their names. On this conversion, I avoided replacing that by a :ref:`` tag or a :doc:`` tag. I only added cross references on two cases: - a latex file that got converted to ReST and had such cross-references already; - one of the document sets that seemed to be using some other markup language very close to ReST, but with a different cross-reference markup. So, I just converted it to use the syntax that Sphinx would recognize. Anyway, one of the things that occurred to me is that maybe some scripting work or a ReST extension could do something to parse "Documentation/foo" as :doc:`Documentation/foo` without needing to explicitly use any ReST specific tags. Thanks, Mauro 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=-0.8 required=3.0 tests=DKIM_INVALID,DKIM_SIGNED, 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 6EA47C10F03 for ; Tue, 23 Apr 2019 20:22:45 +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 3A6C421850 for ; Tue, 23 Apr 2019 20:22:45 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=fail reason="signature verification failed" (2048-bit key) header.d=infradead.org header.i=@infradead.org header.b="b6rVC2Ik" DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 3A6C421850 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=kernel.org 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 10740F0D; Tue, 23 Apr 2019 20:22:45 +0000 (UTC) Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id F2CD2EF2 for ; Tue, 23 Apr 2019 20:22:43 +0000 (UTC) X-Greylist: from auto-whitelisted by SQLgrey-1.7.6 Received: from casper.infradead.org (casper.infradead.org [85.118.1.10]) by smtp1.linuxfoundation.org (Postfix) with ESMTPS id 4D971F4 for ; Tue, 23 Apr 2019 20:22:43 +0000 (UTC) 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=s8LBNQQt8Pkzt9ldRuS2ZgT6tZZkHFD1+1kZIjqY7N8=; b=b6rVC2IkZDSMInja7N+siqmYU5 sbPHg+WiOSWOgPqDhvnX0vfT7iBYVcW2NF2PkGG0ufaLk0aqbFu6XCUURkWmHiwysAYKZjkCoSLHe B4eqg9rIXq6DTkTlFFt8NSaggyM9OUL2hk6s2b6Cz0ut/H2eQJ4eDh63NLBQaRsZVmVuf9L8cr8uO I1nyLUxpZeXTLEDJNAVuNYgAPvExbrtsdVq7vWm2owXSVRoy664g2wyFfugfOtDOSQxPGJCEGX2uh IZUdafAAyRhRUKvVEMG3w6cFAmaD9lNHixPdrZWMg0N4t5FBeIyPun/fBq/YvSA/gSV8IvLdlbpS1 KN5CVBjA==; Received: from 177.17.136.231.dynamic.adsl.gvt.net.br ([177.17.136.231] helo=coco.lan) by casper.infradead.org with esmtpsa (Exim 4.90_1 #2 (Red Hat Linux)) id 1hJ1tl-0001et-Dp; Tue, 23 Apr 2019 20:20:14 +0000 Date: Tue, 23 Apr 2019 17:19:44 -0300 From: Mauro Carvalho Chehab To: Jonathan Corbet Subject: Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst Message-ID: <20190423171944.7ac6db54@coco.lan> In-Reply-To: <20190423115349.589c3d50@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> <20190423115349.589c3d50@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 , kernel-hardening@lists.openwall.com, 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 , 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 , Borislav Petkov , 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 , "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: <20190423201944.TYW9udkztxKN5CUqdeZwkLfax4Fv4bnkZpfOqd770X4@z> Em Tue, 23 Apr 2019 11:53:49 -0600 Jonathan Corbet escreveu: > On Tue, 23 Apr 2019 19:11:58 +0200 > Peter Zijlstra wrote: > > > Look at crap like this: > > > > "The memory allocations via :c:func:`kmalloc`, :c:func:`vmalloc`, > > :c:func:`kmem_cache_alloc` and" > > > > That should've been written like: > > > > "The memory allocations via kmalloc(), vmalloc(), kmem_cache_alloc() > > and" > > Yeah, I get it. That markup generates cross-references, which can be > seriously useful for readers - we want that. But I do wonder if we > couldn't do it automatically with just a little bit of scripting work. > It's not to hard to recognize this_is_a_function(), after all. I'll look > into that, it would definitely help to remove some gunk from the source > docs. While on it, one thing that I noticed on several documents is that they reference other documents by their names. On this conversion, I avoided replacing that by a :ref:`` tag or a :doc:`` tag. I only added cross references on two cases: - a latex file that got converted to ReST and had such cross-references already; - one of the document sets that seemed to be using some other markup language very close to ReST, but with a different cross-reference markup. So, I just converted it to use the syntax that Sphinx would recognize. Anyway, one of the things that occurred to me is that maybe some scripting work or a ReST extension could do something to parse "Documentation/foo" as :doc:`Documentation/foo` without needing to explicitly use any ReST specific tags. Thanks, Mauro _______________________________________________ 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 17:19:44 -0300 From: Mauro Carvalho Chehab Subject: Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst Message-ID: <20190423171944.7ac6db54@coco.lan> In-Reply-To: <20190423115349.589c3d50@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> <20190423115349.589c3d50@lwn.net> MIME-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit To: Jonathan Corbet Cc: 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 , Borislav Petkov , "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 List-ID: Em Tue, 23 Apr 2019 11:53:49 -0600 Jonathan Corbet escreveu: > On Tue, 23 Apr 2019 19:11:58 +0200 > Peter Zijlstra wrote: > > > Look at crap like this: > > > > "The memory allocations via :c:func:`kmalloc`, :c:func:`vmalloc`, > > :c:func:`kmem_cache_alloc` and" > > > > That should've been written like: > > > > "The memory allocations via kmalloc(), vmalloc(), kmem_cache_alloc() > > and" > > Yeah, I get it. That markup generates cross-references, which can be > seriously useful for readers - we want that. But I do wonder if we > couldn't do it automatically with just a little bit of scripting work. > It's not to hard to recognize this_is_a_function(), after all. I'll look > into that, it would definitely help to remove some gunk from the source > docs. While on it, one thing that I noticed on several documents is that they reference other documents by their names. On this conversion, I avoided replacing that by a :ref:`` tag or a :doc:`` tag. I only added cross references on two cases: - a latex file that got converted to ReST and had such cross-references already; - one of the document sets that seemed to be using some other markup language very close to ReST, but with a different cross-reference markup. So, I just converted it to use the syntax that Sphinx would recognize. Anyway, one of the things that occurred to me is that maybe some scripting work or a ReST extension could do something to parse "Documentation/foo" as :doc:`Documentation/foo` without needing to explicitly use any ReST specific tags. Thanks, Mauro