Bug 141032 - misleading documentation for rtadvd.conf(5) raflags setting
Summary: misleading documentation for rtadvd.conf(5) raflags setting
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: freebsd-bugs (Nobody)
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-11-30 17:20 UTC by Viktor Štujber
Modified: 2018-04-11 21:15 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Viktor Štujber 2009-11-30 17:20:01 UTC
The documentation for rtadvd.conf (ipv6 router advertisement daemon) contains a section on 'raflags'. This setting controls a bitfield in the RA packet.

The doc explains all of the bits, and to each one it assigns a letter and a hexadecimal value, 0x??.

However, this is very misleading, because as it turns out, the code parsing this config file does not understand hexadecimal numbers.

This works:
:raflags#64:
:raflags="o":

This doesn't work:
:raflags#0x40:

I am not familiar with the syntax, and didn't feel like trying all of the possible variations of #,=,o and 0x40, so I'm only listing the ones above.

Fix: 

I suggest either adding support for hexadecimal numbers to the parser (a code change), or improving/amending the documentation to make it more clear. It would also be useful if the example used a value more complex than '0'.
How-To-Repeat: In my case, I just needed to set the bit 0x40. So I took the example, which says raflags#0, and used

fxp0:\
    :raflags#0x40:
Comment 1 Volker Werth freebsd_committer 2010-08-21 14:55:37 UTC
Responsible Changed
From-To: freebsd-bugs->freebsd-doc

over to the doc team: I think making clear not to use hex values solves the confusion?
Comment 2 Eitan Adler freebsd_committer freebsd_triage 2017-12-31 08:01:09 UTC
For bugs matching the following criteria:

Status: In Progress Changed: (is less than) 2014-06-01

Reset to default assignee and clear in-progress tags.

Mail being skipped