From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: Holger Schurig <holgerschurig@gmail.com>
Cc: "barebox@lists.infradead.org" <barebox@lists.infradead.org>
Subject: Re: generated command references sometimes render a solid blob of text
Date: Wed, 2 Jul 2014 14:34:23 -0400 (EDT) [thread overview]
Message-ID: <alpine.LFD.2.11.1407021427020.3327@localhost> (raw)
In-Reply-To: <CAOpc7mGjpe+EGtuHgvDOkWXW4Dvn1BXSrCeWznV9k_M_nNS69g@mail.gmail.com>
On Wed, 2 Jul 2014, Holger Schurig wrote:
> > I don't think that the Kconfig entries need to contain the full command
> > documentation.
>
> Probably not.
>
> Currently, too many Kconfig options don't have help texts. When I was
> new to Barebox, I was puzzled about wether to select an option or not.
> Having the complete docs (manually done or auto-generated, doesn't
> matter) can be a good help for that.
>
> It's unfortunate that we have now actually 3 places for the help: via
> macros in the source, in the Kconfig, and in the *.rst files. The one
> in the source code also have an additional property: that options to
> commands can depend on Kconfig entries (e.g. "bootm" depends on
> CONFIG_CMD_BOOTM_INITRD, CONFIG_OFTREE and CONFIG_CMD_BOOTM_VERBOSE).
> That complicates matters even more. Sigh.
gosh, i didn't mean to open quite this can of worms. i'll let those
higher up the food chain decide how to deal with this. i have more
patches to the user manual coming shortly.
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
next prev parent reply other threads:[~2014-07-02 18:34 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-07-01 12:43 Robert P. J. Day
2014-07-01 14:26 ` Holger Schurig
2014-07-01 15:58 ` Robert P. J. Day
2014-07-02 10:41 ` Jan Lübbe
2014-07-02 11:45 ` Holger Schurig
2014-07-02 18:34 ` Robert P. J. Day [this message]
2014-07-02 7:00 ` 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=alpine.LFD.2.11.1407021427020.3327@localhost \
--to=rpjday@crashcourse.ca \
--cc=barebox@lists.infradead.org \
--cc=holgerschurig@gmail.com \
/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