generated doc "Options" for dhcp command drops last line

[Robert P. J. Day]

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
========================================================================