From: "Robert P. J. Day" <rpjday@crashcourse.ca>
To: Sascha Hauer <s.hauer@pengutronix.de>
Cc: "U-Boot Version 2 (barebox)" <barebox@lists.infradead.org>
Subject: Re: generated doc "Options" for dhcp command drops last line
Date: Mon, 7 Jul 2014 05:05:31 -0400 (EDT) [thread overview]
Message-ID: <alpine.LFD.2.11.1407070503470.27781@localhost> (raw)
In-Reply-To: <20140707080738.GM23235@pengutronix.de>
[-- Attachment #1: Type: TEXT/PLAIN, Size: 2115 bytes --]
On Mon, 7 Jul 2014, Sascha Hauer wrote:
> On Sun, Jul 06, 2014 at 02:59:09PM -0400, Robert P. J. Day wrote:
> >
> > just noticed that the sphinx-generated doc page for the "dhcp"
> > command doesn't display the final line because of this in
> > net/dhcp.c:
> >
> > BAREBOX_CMD_HELP_START(dhcp)
> > BAREBOX_CMD_HELP_TEXT("Options:")
> > BAREBOX_CMD_HELP_OPT ("-H HOSTNAME", "hostname to send to the DHCP server")
> > BAREBOX_CMD_HELP_OPT ("-v ID\t", "DHCP Vendor ID (code 60) submitted in DHCP requests")
> > BAREBOX_CMD_HELP_OPT ("-c ID\t", "DHCP Client ID (code 61) submitted in DHCP requests")
> > BAREBOX_CMD_HELP_OPT ("-u UUID\t", "DHCP Client UUID (code 97) submitted in DHCP requests")
> > BAREBOX_CMD_HELP_OPT ("-U CLASS", "DHCP User class (code 77) submitted in DHCP requests")
> > BAREBOX_CMD_HELP_OPT ("-r RETRY", "retry limit (default "__stringify(DHCP_DEFAULT_RETRY)")");
> > BAREBOX_CMD_HELP_END
> >
> > it's that trailing semicolon on the second last line there,
> > which i suspect shouldn't be there, but if i take it out, the
> > generated line now literally includes
> > "__stringify(DHCP_DEFAULT_RETRY)”, and i'm not sure what to do
> > about that, so if someone wants to fix it, go wild.
>
> I assume that even with the semicolon the sphinx documentation
> doesn't have the correct value for the retry limit, right?
right ... even after removing that semicolon so that the last line
shows up, it literally contains that "__stringify" stuff.
> We should remove these macro tricks from the command documentation
> defines. In this special case DHCP_DEFAULT_RETRY isn't even
> configurable.
i'll let someone higher up the food chain decide how to resolve
that.
rday
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
[-- Attachment #2: Type: text/plain, Size: 149 bytes --]
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
prev parent reply other threads:[~2014-07-07 9:05 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-07-06 18:59 Robert P. J. Day
2014-07-07 8:07 ` Sascha Hauer
2014-07-07 9:05 ` Robert P. J. Day [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=alpine.LFD.2.11.1407070503470.27781@localhost \
--to=rpjday@crashcourse.ca \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox