mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: Holger Schurig <holgerschurig@gmail.com>
Cc: "U-Boot Version 2 (barebox)" <barebox@lists.infradead.org>
Subject: Re: generated command references sometimes render a solid blob of text
Date: Tue, 1 Jul 2014 11:58:08 -0400 (EDT)	[thread overview]
Message-ID: <alpine.LFD.2.11.1407011155220.30744@localhost> (raw)
In-Reply-To: <CAOpc7mHhFazCDMQqq8w3hUkRjzovvtSBksYdjwDdkV+LEDb7bA@mail.gmail.com>

On Tue, 1 Jul 2014, Holger Schurig wrote:

> The Kconfig help entries (the source of the generated command
> reference) have been written before python-sphinx have been
> selected.
>
> So basically we need to go over all of them and make sure that they
> render correctly. From my point of view, it doesn't harm if you see
> raw ReST formatting while inside "make xconfig".

  normally, i wouldn't be a big fan of deliberately mangling help info
for the sake of how it will *eventually* be rendered but, in this
case, it seems reasonable.

  and on that note, is it a ReST thing that renders two regular
hyphens as a single, long hyphen? as far as i can tell, that is an
issue only in the let.c command help.

rday

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                        http://crashcourse.ca

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox

  reply	other threads:[~2014-07-01 16:02 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-07-01 12:43 Robert P. J. Day
2014-07-01 14:26 ` Holger Schurig
2014-07-01 15:58   ` Robert P. J. Day [this message]
2014-07-02 10:41   ` Jan Lübbe
2014-07-02 11:45     ` Holger Schurig
2014-07-02 18:34       ` Robert P. J. Day
2014-07-02  7:00 ` Sascha Hauer

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=alpine.LFD.2.11.1407011155220.30744@localhost \
    --to=rpjday@crashcourse.ca \
    --cc=barebox@lists.infradead.org \
    --cc=holgerschurig@gmail.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