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 11:53:49 -0600 Message-ID: <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> Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Return-path: In-Reply-To: <20190423171158.GG12232-Nxj+rRp3nVydTX5a5knrm8zTDFooKrT+cvkQGrU6aU0@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: Peter Zijlstra 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 19:11:58 +0200 Peter Zijlstra wrote: > When writing, I now have to be bothered about this format crap over just > trying to write a coherent document. Just write text, it'll all work out in the end :) > 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. 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 38672C10F03 for ; Tue, 23 Apr 2019 17:54:21 +0000 (UTC) Received: from kanga.kvack.org (kanga.kvack.org [205.233.56.17]) by mail.kernel.org (Postfix) with ESMTP id E6AA720651 for ; Tue, 23 Apr 2019 17:54:20 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org E6AA720651 Authentication-Results: mail.kernel.org; dmarc=none (p=none dis=none) header.from=lwn.net Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=owner-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix) id 8A2FA6B0003; Tue, 23 Apr 2019 13:54:20 -0400 (EDT) Received: by kanga.kvack.org (Postfix, from userid 40) id 82BA36B0005; Tue, 23 Apr 2019 13:54:20 -0400 (EDT) X-Delivered-To: int-list-linux-mm@kvack.org Received: by kanga.kvack.org (Postfix, from userid 63042) id 6A5AF6B000A; Tue, 23 Apr 2019 13:54:20 -0400 (EDT) X-Delivered-To: linux-mm@kvack.org Received: from mail-pl1-f198.google.com (mail-pl1-f198.google.com [209.85.214.198]) by kanga.kvack.org (Postfix) with ESMTP id 2A2776B0003 for ; Tue, 23 Apr 2019 13:54:20 -0400 (EDT) Received: by mail-pl1-f198.google.com with SMTP id x9so10781228pln.0 for ; Tue, 23 Apr 2019 10:54:20 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-original-authentication-results:x-gm-message-state:date:from:to :cc:subject:message-id:in-reply-to:references:organization :mime-version:content-transfer-encoding; bh=ti8PeUs+SEtcVpT4jkp4p9ziOXOkaOIVi5KzTFKptXo=; b=GmaSrBGdEx4hzvFVTLBRM8grRlebWZ6f13HzpHzopYqkwh9Hel4tsPha8opNrL/F2R 6lWBDDzRsSmSEbrmSegS6R+q1+K0bsFlACWQaR4xE2lB6sL+VXHnW/iO4eKOpXsvVd+y K4WY0guZkGmX2AwQvneS++428PUkRuphlZNGeawNMYC7QcvvFGAfvCqQnMZO+b6ykGuG Cy0n1dzgWSPbh8QjminMtkdL1k1eX5shoFcAD+2ymPlYH9KiRC40euIG/TjB1M8jHIzX qmyPMu+4arW4hnTDMKaAmUBuQOmQ/35xO8ZQDbVNvpHhZCsKKskafdOlPJM1t6cIXRQW hYlg== X-Original-Authentication-Results: mx.google.com; spf=pass (google.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net X-Gm-Message-State: APjAAAW87SsRNYODjZMm5RqSEY2UvLrZWjLOj7rxFq/2V4CoKtoykoK0 Q3t/GrraPANatkkBLYkP+DmmpB7kJSBC0MJVXND6QVuhq7cggKKCDpUv1+mST7yzw42vncoAJd6 mHsrzz2K6Nn7ClFz9vCvY6NoH4AmVChl92ZH13NtizrZ0wpAGVBNswooXcblcjpC3tQ== X-Received: by 2002:a62:6e05:: with SMTP id j5mr28389993pfc.5.1556042059809; Tue, 23 Apr 2019 10:54:19 -0700 (PDT) X-Google-Smtp-Source: APXvYqxqC/bVP+SOse78uVOou6buew7weUg4UvIgfJ/ILzBEVor6mQWNSuH22VXGaai2WopYJ9+E X-Received: by 2002:a62:6e05:: with SMTP id j5mr28389923pfc.5.1556042059007; Tue, 23 Apr 2019 10:54:19 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1556042059; cv=none; d=google.com; s=arc-20160816; b=yURrGCJ1wogRcLNLYdSRkaZ31NVR6ES/6s4krM1WPDB8IH2wpXYaLQmpTq9y8T/Sv4 NerSZGAK6nRaspEUWwDimwLl0vAYb+EHOewTT4uAqYLi94AYuLkzUd1LsrZHHbhn7mCf NIZ7so6sPQXuf8DG7o0yfgEZf/rHKdgGvqWzW5BnrHzpJWaqDXlSWhvWbdpELpZyMacd g7PBli6beFRT5Cq592feuC8wdwKFDGsNQKdE4FJ9KVPTwPE450vRjOtGxmPYcU1SRc9j O0roq094ck37KaJT7ErnRXhNM1Lw1SEDF9ivp1ZyWm6cLgl/al3rdimH4p/MNilDZp6C 4V0Q== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:organization:references :in-reply-to:message-id:subject:cc:to:from:date; bh=ti8PeUs+SEtcVpT4jkp4p9ziOXOkaOIVi5KzTFKptXo=; b=W95ZqM9nHl9gVGvsnqauu/dnC+9FLHj1CpalNXVyDHya+24prawq0A2yyTuk10OuKb HjCVHAgA111ragUznQ1eBYQIfXCm0A7u9LV6iWxlolLFLJqgFZfocTg3okhX4I5PuPEN SmbTR2etVdnHNwEP/8FgTmN9mXzLCWwlHGq/qgy6layf5G0zSC+2zGDEbNhPTCMDNaYe swb4l/oNBHCp7oNdgG3zcpzIaipsUMMn5USWjBhd5wPlEz9FyL0g7EEWb2/CBfJMpNyg TMwhEqj3SAp3lpMBKiNVtBalR238eJiQ/Pmd8T0e5gQgoLEo+c3p+lP7JoYASHEpI47Z whpA== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net Received: from ms.lwn.net (ms.lwn.net. [45.79.88.28]) by mx.google.com with ESMTPS id l59si16071592plb.298.2019.04.23.10.54.18 for (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 23 Apr 2019 10:54:18 -0700 (PDT) Received-SPF: pass (google.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) client-ip=45.79.88.28; Authentication-Results: mx.google.com; spf=pass (google.com: domain of corbet@lwn.net designates 45.79.88.28 as permitted sender) smtp.mailfrom=corbet@lwn.net 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 77A672DD; Tue, 23 Apr 2019 17:53:53 +0000 (UTC) Date: Tue, 23 Apr 2019 11:53:49 -0600 From: Jonathan Corbet To: Peter Zijlstra Cc: Mike Snitzer , Mauro Carvalho Chehab , 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 Subject: Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst Message-ID: <20190423115349.589c3d50@lwn.net> In-Reply-To: <20190423171158.GG12232@hirez.programming.kicks-ass.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> Organization: LWN.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: 8bit X-Bogosity: Ham, tests=bogofilter, spamicity=0.000000, version=1.2.4 Sender: owner-linux-mm@kvack.org Precedence: bulk X-Loop: owner-majordomo@kvack.org List-ID: On Tue, 23 Apr 2019 19:11:58 +0200 Peter Zijlstra wrote: > When writing, I now have to be bothered about this format crap over just > trying to write a coherent document. Just write text, it'll all work out in the end :) > 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. 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 81DA0C282E1 for ; Tue, 23 Apr 2019 17:54:21 +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 5B94520651 for ; Tue, 23 Apr 2019 17:54:21 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org 5B94520651 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 187B5CAD; Tue, 23 Apr 2019 17:54:21 +0000 (UTC) Received: from smtp1.linuxfoundation.org (smtp1.linux-foundation.org [172.17.192.35]) by mail.linuxfoundation.org (Postfix) with ESMTPS id A4D6EC96 for ; Tue, 23 Apr 2019 17:54:19 +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 24650F4 for ; Tue, 23 Apr 2019 17:54:19 +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 77A672DD; Tue, 23 Apr 2019 17:53:53 +0000 (UTC) Date: Tue, 23 Apr 2019 11:53:49 -0600 From: Jonathan Corbet To: Peter Zijlstra Subject: Re: [PATCH v2 56/79] docs: Documentation/*.txt: rename all ReST files to *.rst Message-ID: <20190423115349.589c3d50@lwn.net> In-Reply-To: <20190423171158.GG12232@hirez.programming.kicks-ass.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> 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 , 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 , 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 , 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: <20190423175349.Lw1anIMrBMsrWvfgdUfazV8umnebCrfMpQ2JIEE5Auw@z> On Tue, 23 Apr 2019 19:11:58 +0200 Peter Zijlstra wrote: > When writing, I now have to be bothered about this format crap over just > trying to write a coherent document. Just write text, it'll all work out in the end :) > 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. jon _______________________________________________ iommu mailing list iommu@lists.linux-foundation.org https://lists.linuxfoundation.org/mailman/listinfo/iommu