From: Antony Pavlov <antonynpavlov@gmail.com>
To: Sascha Hauer <s.hauer@pengutronix.de>
Cc: barebox@lists.infradead.org
Subject: Re: barebox Documentation
Date: Tue, 13 May 2014 19:44:12 +0400 [thread overview]
Message-ID: <20140513194412.511dcdb932138aa0dcb14d46@gmail.com> (raw)
In-Reply-To: <20140513134228.GQ5858@pengutronix.de>
On Tue, 13 May 2014 15:42:28 +0200
Sascha Hauer <s.hauer@pengutronix.de> wrote:
> Hi,
>
> As we all know the barebox documentation sucks. We @Pengutronix will
> have our internal techweek next month. One of the goals will be to
> improve the documentation situation for barebox.
>
> What are your opinions in which form the documentation should be?
>
> We currently have plain text files under Documentation/, a wiki on
> http://wiki.barebox.org/doku.php and doxygen. None of the documentation
> sets is complete and all are outdated.
>
> Some pros and cons of the existing approaches are:
>
> Plain text files
> + Easy to write
> + no extra step to generate docs, wysiwyg ;)
> - no links
> - no pictures
>
> Wiki
> - not contained in the repository, so may be out of sync
http://en.wikipedia.org/wiki/Gitit_%28software%29 ?
> + links
> + nice markup language
>
> doxygen
> + contained in the repository
> + easy html doc generation
> + links
> - extra step to generate the docs
- not trivail board documentation adding (e.g. there is Documentation/boards.dox, and
there is arch/arm/mach-omap/arch-omap.dox too)
--
Best regards,
Antony Pavlov
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
prev parent reply other threads:[~2014-05-13 15:33 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
2014-05-13 15:44 ` Antony Pavlov [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=20140513194412.511dcdb932138aa0dcb14d46@gmail.com \
--to=antonynpavlov@gmail.com \
--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.