Bug 234249 - rc.conf(5): incorrect sentence parallelism in description of ip6addrctl_policy
Summary: rc.conf(5): incorrect sentence parallelism in description of ip6addrctl_policy
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Chris Rees
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-12-21 15:15 UTC by David Fiander
Modified: 2019-09-09 20:48 UTC (History)
3 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description David Fiander 2018-12-21 15:15:26 UTC 
The description of the rc.conf variable ip6addrctl_enable contains the only documentation for the variable ip6addrctl_policy (which is another problem, but I'm not going to open a but report for that).

The description of the ip6addrctl_policy says:

If ``ipv4_prefer'' or ``ipv6_prefer'' is specified, ip6addrctl(8) installs a pre-defined policy table described in Section 2.1 (IPv6-preferred) or 10.3 (IPv4-preferred) of RFC 3484.

A strict reading of this suggests that setting ip6addrctl_policy to "ipv4_prefer" will install a "pre-defined policy table described in Section 2.1 (IPv6-preferred)". The second part of this sentence needs to be reversed so that the correct tables correspond to the correct policy values.
Comment 1 Chris Rees freebsd_committer freebsd_triage 2018-12-26 20:16:28 UTC 
I'll take it.
Comment 2 commit-hook freebsd_committer freebsd_triage 2019-09-09 20:48:30 UTC 
A commit references this bug:

Author: crees
Date: Mon Sep  9 20:48:12 UTC 2019
New revision: 352107
URL: https://svnweb.freebsd.org/changeset/base/352107

Log:
  Reverse the referenced tables.

  If ipv4_prefer is specified, Section 10.3 is relevant.
  If ipv6_prefer is specified, Section  2.1 is relevant.

  This change makes the corresponding options/sections 'respective'

  PR:		docs/234249
  Submitted by:	David Fiander <david@fiander.info>

Changes:
  head/share/man/man5/rc.conf.5
Comment 3 Chris Rees freebsd_committer freebsd_triage 2019-09-09 20:48:39 UTC 
Thanks, and I'm sorry this trivial change took so long.