public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
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>
Subject: Re: [PATCH 0/2] Add maintainers to the admin guide
Date: Wed, 14 Dec 2016 08:14:44 -0800	[thread overview]
Message-ID: <1481732084.29291.54.camel@perches.com> (raw)
In-Reply-To: <20161213073719.0223f2eb@vento.lan>

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.

  reply	other threads:[~2016-12-14 16:14 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-12-02 12:15 [PATCH 0/2] Add maintainers to the admin guide Mauro Carvalho Chehab
2016-12-02 12:15 ` [PATCH 1/2] MAINTAINERS: convert first part to ReST markup Mauro Carvalho Chehab
2016-12-02 12:15 ` [PATCH 2/2] MAINTAINERS: add it to the admin-guide Mauro Carvalho Chehab
2016-12-07 15:47 ` [PATCH 0/2] Add maintainers to the admin guide Daniel Vetter
2016-12-12 18:00 ` Jonathan Corbet
2016-12-12 20:56   ` Joe Perches
2016-12-13  9:38     ` Mauro Carvalho Chehab
2016-12-14 16:14       ` Joe Perches [this message]
2016-12-14 16:43         ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1481732084.29291.54.camel@perches.com \
    --to=joe@perches.com \
    --cc=akpm@linux-foundation.org \
    --cc=corbet@lwn.net \
    --cc=davem@davemloft.net \
    --cc=geert+renesas@glider.be \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=markus.heiser@darmarit.de \
    --cc=mchehab@infradead.org \
    --cc=mchehab@kernel.org \
    --cc=mchehab@s-opensource.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox