mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Sascha Hauer <s.hauer@pengutronix.de>
To: "Robert P. J. Day" <rpjday@crashcourse.ca>
Cc: barebox@lists.infradead.org
Subject: Re: New Documentation for barebox
Date: Thu, 26 Jun 2014 20:56:37 +0200	[thread overview]
Message-ID: <20140626185637.GD14257@pengutronix.de> (raw)
In-Reply-To: <alpine.LFD.2.11.1406260622060.14712@localhost>

On Thu, Jun 26, 2014 at 06:31:10AM -0400, Robert P. J. Day wrote:
> On Thu, 26 Jun 2014, Sascha Hauer wrote:
> 
> 
>   ... snip ...
> 
>   couple quick observations before i put on my editor hat and go
> through all this. first, on my fedora rawhide system, running "make
> docs" generates quite a few warnings, although the HTML is eventually
> built. is it worth digging into the doc generation warnings and trying
> to clean them up? anyone else building the docs on fedora rawhide and
> see what i'm talking about?
> 
>   and just from the main page, a couple very pedantic questions:
> 
> * should the name "Barebox" be italicized or not? it seems even that
> single page bounces back and forth using and not using "@a" in front
> of the word "Barebox".
> 
> * the "Directory layout" section inserts a space on either side of the
> "/" in directory names, as in:
> 
>   arch / * /
> 
> that just looks ... weird.
> 
> * oh, final note regarding name "Barebox", i notice some pages (like
> the x86_bootloader page) use the uncapitalized name "barebox" -- this
> really should be consistent throughout all the docs.

It seems you are talking about the old doxygen docs. Please checkout
the doc branch on:

git://git.pengutronix.de/git/barebox.git

There should be only one match for Barebox with a capital 'B' in

Documentation/boards/omap.rst:36:exactly behaves like an external dongle. Barebox does not automatically detect

All others are lowercase.

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

      reply	other threads:[~2014-06-26 18:57 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-06-26  8:51 Sascha Hauer
2014-06-26  8:51 ` [PATCH 1/7] ubiformat: avoid macros in help text Sascha Hauer
2014-06-26  8:51 ` [PATCH 2/7] automount: fix description typo Sascha Hauer
2014-06-26  8:51 ` [PATCH 3/7] commands: addpart: Improve description Sascha Hauer
2014-06-26  8:51 ` [PATCH 4/7] Documentation: remove doxygen documentation Sascha Hauer
2014-06-26  8:51 ` [PATCH 5/7] Documentation: remove remaining documentation Sascha Hauer
2014-06-26  8:51 ` [PATCH 6/7] Documentation: remove devicetree docs Sascha Hauer
2014-06-26  8:51 ` [PATCH 7/7] Documentation: Add new sphinxs docs Sascha Hauer
2014-06-26  9:02 ` New Documentation for barebox Holger Schurig
2014-06-26  9:09   ` Sascha Hauer
2014-06-26  9:36 ` Holger Schurig
2014-06-26 18:17   ` Sascha Hauer
2014-06-26  9:54 ` Holger Schurig
2014-06-26 10:01   ` Lucas Stach
2014-06-26 10:11     ` Holger Schurig
2014-06-26 10:28 ` Antony Pavlov
2014-06-26 15:36   ` Sascha Hauer
2014-06-26 10:31 ` Robert P. J. Day
2014-06-26 18:56   ` Sascha Hauer [this message]

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=20140626185637.GD14257@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