From: Sascha Hauer <s.hauer@pengutronix.de>
To: "Robert P. J. Day" <rpjday@crashcourse.ca>
Cc: "U-Boot Version 2 (barebox)" <barebox@lists.infradead.org>
Subject: Re: in sphinx docs, what is "@b barebox" markup supposed to do?
Date: Mon, 30 Jun 2014 14:56:32 +0200 [thread overview]
Message-ID: <20140630125632.GF14257@pengutronix.de> (raw)
In-Reply-To: <alpine.LFD.2.11.1406300555100.18619@localhost>
On Mon, Jun 30, 2014 at 05:56:37AM -0400, Robert P. J. Day wrote:
> On Mon, 30 Jun 2014, Holger Schurig wrote:
>
> > I found a Sphinx cheat sheet:
> > http://openalea.gforge.inria.fr/doc/openalea/doc/_build/html/source/sphinx/rest_syntax.html
> > (where you have all the important things on just one page).
> >
> > So you can convert "This is @b foo bar" to "This is **foo** bar".
>
> except the standard *seems* to be to not mark up the name "barebox"
> at all, so it would seem more appropriate to just remove the doxygen
> markup for the word "barebox" entirely.
Yes.
IMO it doesn't help the reader if every occurrence of the word
**barebox** in a **barebox** manual is in bold letters just because we
like **barebox** so much.
Sascha
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
next prev parent reply other threads:[~2014-06-30 12:56 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-06-28 13:06 Robert P. J. Day
2014-06-30 6:01 ` Sascha Hauer
2014-06-30 9:38 ` Holger Schurig
2014-06-30 9:56 ` Robert P. J. Day
2014-06-30 12:56 ` Sascha Hauer [this message]
2014-06-30 12:50 ` Robert P. J. Day
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=20140630125632.GF14257@pengutronix.de \
--to=s.hauer@pengutronix.de \
--cc=barebox@lists.infradead.org \
--cc=rpjday@crashcourse.ca \
/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