Message-ID: <1481732084.29291.54.camel@perches.com>
Subject: Re: [PATCH 0/2] Add maintainers to the admin guide
From: Joe Perches <joe@perches.com>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Cc: Jonathan Corbet <corbet@lwn.net>,
        Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        Mauro Carvalho Chehab <mchehab@infradead.org>,
        LKML <linux-kernel@vger.kernel.org>,
        Markus Heiser <markus.heiser@darmarit.de>,
        "David S. Miller" <davem@davemloft.net>,
        Andrew Morton <akpm@linux-foundation.org>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        Mauro Carvalho Chehab <mchehab@kernel.org>,
        Geert Uytterhoeven <geert+renesas@glider.be>
Date: Wed, 14 Dec 2016 08:14:44 -0800
In-Reply-To: <20161213073719.0223f2eb@vento.lan>
References: <cover.1480680547.git.mchehab@s-opensource.com>
         <20161212110045.0cd6b16c@lwn.net> <1481576210.1764.41.camel@perches.com>
         <20161213073719.0223f2eb@vento.lan>
Content-Type: text/plain; charset="ISO-8859-1"
Mime-Version: 1.0
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 2042
Lines: 52

On Tue, 2016-12-13 at 07:38 -0200, Mauro Carvalho Chehab wrote:
> Em Mon, 12 Dec 2016 12:56:50 -0800
> Joe Perches <joe@perches.com> escreveu:
> > Does the boxing with the ======= blocks align properly?
> > It it really useful?  Is there another/better way?
> 
> Do you mean those?
> 
>   ===============================	================================
>   ``F:``	``drivers/net/``	all files in and below
> 					``drivers/net``
>   ``F:``	``drivers/net/*``	all files in ``drivers/net``,
> 					but not below
>   ``F:``	``*/net/*``		all files in "any top level
> 					directory" ``/net``
>   ===============================	================================

Yes.

> This is a table. We might instead use a literal block, like:
> 
> ::
> 
>   ``F:``	``drivers/net/``	all files in and below
> 					``drivers/net``
>   ``F:``	``drivers/net/*``	all files in ``drivers/net``,
> 					but not below
>   ``F:``	``*/net/*``		all files in "any top level
> 					directory" ``/net``
> 
> But the result looks uglier when generating LaTeX or HTML, as it won't
> unwrap the continuation lines of the field descriptions.
> 
> Another alternative would be to use ascii artwork, like:
> 
>  +------------------------------------+----------------------------------+
>  | ``F:``   	``drivers/net/``      |	all files in and below		 |
>  | 	    			      |	``drivers/net``			 |
>  +------------------------------------+----------------------------------+
>  | ``F:``   	``drivers/net/*``     |	all files in ``drivers/net``,    |
>  |	    			      |	but not below			 |
>  +------------------------------------+----------------------------------+
>  | ``F:``   	``*/net/*``	      |	all files in "any top level      |
>  |	    			      |	directory" ``/net``		 |
>  +------------------------------------+----------------------------------+

Isn't the ascii art is going to get odd looking
output after the sphinx conversion because of the
doubled quotes being converted to bold?

I suspect the table formatting just isn't necessary
and it could be paragraphed instead.