From nobody@FreeBSD.org  Mon Nov 30 17:11:08 2009
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id 067761065676
	for <freebsd-gnats-submit@FreeBSD.org>; Mon, 30 Nov 2009 17:11:08 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from www.freebsd.org (www.freebsd.org [IPv6:2001:4f8:fff6::21])
	by mx1.freebsd.org (Postfix) with ESMTP id E9E828FC49
	for <freebsd-gnats-submit@FreeBSD.org>; Mon, 30 Nov 2009 17:11:07 +0000 (UTC)
Received: from www.freebsd.org (localhost [127.0.0.1])
	by www.freebsd.org (8.14.3/8.14.3) with ESMTP id nAUHB7i3097889
	for <freebsd-gnats-submit@FreeBSD.org>; Mon, 30 Nov 2009 17:11:07 GMT
	(envelope-from nobody@www.freebsd.org)
Received: (from nobody@localhost)
	by www.freebsd.org (8.14.3/8.14.3/Submit) id nAUHB7dI097888;
	Mon, 30 Nov 2009 17:11:07 GMT
	(envelope-from nobody)
Message-Id: <200911301711.nAUHB7dI097888@www.freebsd.org>
Date: Mon, 30 Nov 2009 17:11:07 GMT
From: "Viktor &#352;tujber" <viktor.stujber@gmail.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: misleading documentation for rtadvd.conf's raflags setting
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         141032
>Category:       docs
>Synopsis:       misleading documentation for rtadvd.conf(5) raflags setting
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Mon Nov 30 17:20:01 UTC 2009
>Closed-Date:    
>Last-Modified:  Sat Aug 21 13:56:52 UTC 2010
>Originator:     Viktor &#352;tujber
>Release:        8.0
>Organization:
>Environment:
FreeBSD poring.netvor.sk 8.0-STABLE FreeBSD 8.0-STABLE #1: Fri Nov 27 15:12:20 CET 2009     umage@poring.netvor.sk:/usr/obj/usr/src/sys/PORING  i386

>Description:
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.

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

>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'.

>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-bugs->freebsd-doc 
Responsible-Changed-By: vwe 
Responsible-Changed-When: Sat Aug 21 13:55:37 UTC 2010 
Responsible-Changed-Why:  
over to the doc team: I think making clear not to use hex values solves the confusion? 

http://www.freebsd.org/cgi/query-pr.cgi?pr=141032 
>Unformatted:
