mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: "U-Boot Version 2 (barebox)" <barebox@lists.infradead.org>
Subject: generated command references sometimes render a solid blob of text
Date: Tue, 1 Jul 2014 08:43:34 -0400 (EDT)	[thread overview]
Message-ID: <alpine.LFD.2.11.1407010832100.28138@localhost> (raw)

[-- Attachment #1: Type: TEXT/PLAIN, Size: 1445 bytes --]


  i'm sure everyone else already knows this, but some of the HTML
files generated for the command reference list sometimes render the
synopsis or description as a single, unbroken blob of text. for
example, the reference page for "addpart" has a single line for the
entire Description field. another example: the Synopsis field for the
"let" command. and so on.

  it's easy to see that the .rst files that are created don't properly
handle paragraph breaks or lists. so is that just a known issue?

  oh, and one more oddity. if you look at the generated page for the
"let" command, it appears that the the double hyphen is replaced by a
longer "em" hyphen. here's part of the generated let.rst file:

Synopsis
^^^^^^^^
Supported operations are in order of decreasing precedence:
X++, X--
++X, --X
+X, -X
!X, ~X
...

but look what shows up in the generated HTML file:

  X++, X– ++X, –X +X, -X

notice how occurrences of "--" in the .rst file are replaced by the
longer hyphen in the HTML file. just an observation.

rday

-- 

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

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

[-- Attachment #2: Type: text/plain, Size: 149 bytes --]

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

             reply	other threads:[~2014-07-01 12:48 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-07-01 12:43 Robert P. J. Day [this message]
2014-07-01 14:26 ` Holger Schurig
2014-07-01 15:58   ` Robert P. J. Day
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.1407010832100.28138@localhost \
    --to=rpjday@crashcourse.ca \
    --cc=barebox@lists.infradead.org \
    /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