From: Baruch Siach <baruch@tkos.co.il>
To: Sascha Hauer <s.hauer@pengutronix.de>
Cc: barebox@lists.infradead.org
Subject: Re: barebox Documentation
Date: Tue, 13 May 2014 20:45:02 +0300 [thread overview]
Message-ID: <20140513174502.GF4096@tarshish> (raw)
In-Reply-To: <20140513141835.GT5858@pengutronix.de>
Hi Sascha,
On Tue, May 13, 2014 at 04:18:35PM +0200, Sascha Hauer wrote:
> On Tue, May 13, 2014 at 04:01:07PM +0200, Holger Schurig wrote:
> > If wiki and doxygen are not updated, than this is a sign that they
> > should probably be outphased.
> >
> > Instead, I'd prefer to have text files in the Documentation/ tree. So
> > changes to them pass the normal review process.
>
> +1
>
> > > Plain text files
> > > - no links
> > > - no pictures
> >
> > If we use some special format for them, e.g. Markdown or *.rst, then
> > the files can still converted to HTML, and links and images could
> > still be possible. That would mean that wiki.barebox.org probably goes
> > away, but that (part) of www.barebox.org is generated from the
> > *.rst/Markdown files.
>
> This sounds like the best of two worlds. Do you know an example of a
> project with markdown/rst documentation?
Buildroot generates its manual from in-tree AsciiDoc formatted files under
docs/manual/. PDF, HTML, epub, and text output formats are supported. See
http://buildroot.net/docs.html for the generated result. See
docs/manual/manual.mk (included from the top level Makefile) for the build
recipes.
baruch
--
http://baruch.siach.name/blog/ ~. .~ Tk Open Systems
=}------------------------------------------------ooO--U--Ooo------------{=
- baruch@tkos.co.il - tel: +972.2.679.5364, http://www.tkos.co.il -
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
next prev parent reply other threads:[~2014-05-13 17:45 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-05-13 13:42 barebox Documentation Sascha Hauer
2014-05-13 13:50 ` Robert P. J. Day
2014-05-15 12:29 ` Sascha Hauer
2014-05-13 13:55 ` Jean-Christophe PLAGNIOL-VILLARD
2014-05-13 14:01 ` Holger Schurig
2014-05-13 14:18 ` Sascha Hauer
2014-05-13 14:32 ` Holger Schurig
2014-05-13 17:45 ` Baruch Siach [this message]
2014-05-13 15:44 ` Antony Pavlov
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=20140513174502.GF4096@tarshish \
--to=baruch@tkos.co.il \
--cc=barebox@lists.infradead.org \
--cc=s.hauer@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.