From: Sascha Hauer <s.hauer@pengutronix.de>
To: "Robert P. J. Day" <rpjday@crashcourse.ca>
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 10:07:38 +0200 [thread overview]
Message-ID: <20140707080738.GM23235@pengutronix.de> (raw)
In-Reply-To: <alpine.LFD.2.11.1407061455580.16512@localhost>
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?
We should remove these macro tricks from the command documentation
defines. In this special case DHCP_DEFAULT_RETRY isn't even
configurable.
Sascha
--
Pengutronix e.K. | |
Industrial Linux Solutions | http://www.pengutronix.de/ |
Peiner Str. 6-8, 31137 Hildesheim, Germany | Phone: +49-5121-206917-0 |
Amtsgericht Hildesheim, HRA 2686 | Fax: +49-5121-206917-5555 |
_______________________________________________
barebox mailing list
barebox@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/barebox
next prev parent reply other threads:[~2014-07-07 8:08 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 [this message]
2014-07-07 9:05 ` Robert P. J. Day
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=20140707080738.GM23235@pengutronix.de \
--to=s.hauer@pengutronix.de \
--cc=barebox@lists.infradead.org \
--cc=rpjday@crashcourse.ca \
/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