* generated doc "Options" for dhcp command drops last line
@ 2014-07-06 18:59 Robert P. J. Day
2014-07-07 8:07 ` Sascha Hauer
0 siblings, 1 reply; 3+ messages in thread
From: Robert P. J. Day @ 2014-07-06 18:59 UTC (permalink / raw)
To: U-Boot Version 2 (barebox)
[-- Attachment #1: Type: TEXT/PLAIN, Size: 1452 bytes --]
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.
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
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: generated doc "Options" for dhcp command drops last line
2014-07-06 18:59 generated doc "Options" for dhcp command drops last line Robert P. J. Day
@ 2014-07-07 8:07 ` Sascha Hauer
2014-07-07 9:05 ` Robert P. J. Day
0 siblings, 1 reply; 3+ messages in thread
From: Sascha Hauer @ 2014-07-07 8:07 UTC (permalink / raw)
To: Robert P. J. Day; +Cc: U-Boot Version 2 (barebox)
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
^ permalink raw reply [flat|nested] 3+ messages in thread* Re: generated doc "Options" for dhcp command drops last line
2014-07-07 8:07 ` Sascha Hauer
@ 2014-07-07 9:05 ` Robert P. J. Day
0 siblings, 0 replies; 3+ messages in thread
From: Robert P. J. Day @ 2014-07-07 9:05 UTC (permalink / raw)
To: Sascha Hauer; +Cc: U-Boot Version 2 (barebox)
[-- 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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2014-07-07 9:05 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2014-07-06 18:59 generated doc "Options" for dhcp command drops last line Robert P. J. Day
2014-07-07 8:07 ` Sascha Hauer
2014-07-07 9:05 ` Robert P. J. Day
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox