mail archive of the barebox mailing list
 help / color / mirror / Atom feed
From: Holger Schurig <holgerschurig@gmail.com>
To: Lucas Stach <l.stach@pengutronix.de>
Cc: "barebox@lists.infradead.org" <barebox@lists.infradead.org>
Subject: Re: New Documentation for barebox
Date: Thu, 26 Jun 2014 12:11:15 +0200	[thread overview]
Message-ID: <CAOpc7mHRhpOGesqi-K+8huVJbop+hEV=d1LK=-_-Q4OEDdn9MQ@mail.gmail.com> (raw)
In-Reply-To: <1403776882.4254.7.camel@weser.hi.pengutronix.de>

> No, we would like to clearly separate user docs

But still it is unfortunate that two "Getting Barebox" chapters are
there at all, and that they are very near to each.

Also, I think that (necessarily!) the design desicions are now mostly
in the user manual, e.g. device parameters. In the non-user-manual
parts there is hardly contents at all. And most, e.g. the file system
descriptions or the glossary, could very well be moved into the user
manual. Which will lead us to ... the user-manual containing all of
the current HTML docs.

So, let me rephrase it: I also think that long term the whole current
(!) HTML documentation should be part of the user manual.

Simply because there's no developer documentation in the current (!)
HTML, e.g. "How to start a new board" type docs, or an introduction
into the file system structure.

Maybe the PBL chapter is developer documentation, but that is (sic!)
in the user manual ...

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

  reply	other threads:[~2014-06-26 10:12 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 [this message]
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

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='CAOpc7mHRhpOGesqi-K+8huVJbop+hEV=d1LK=-_-Q4OEDdn9MQ@mail.gmail.com' \
    --to=holgerschurig@gmail.com \
    --cc=barebox@lists.infradead.org \
    --cc=l.stach@pengutronix.de \
    /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