Bug 196343

Summary: ipsec gif0 setup missing netmask
Product: Documentation Reporter: ari
Component: DocumentationAssignee: freebsd-doc mailing list <doc>
Status: New ---    
Severity: Affects Many People CC: ae
Priority: ---    
Version: Latest   
Hardware: Any   
OS: Any   

Description ari 2014-12-29 00:14:47 UTC
The IPSec documentation may contain a bug.


In particular, the command is given as:

    # ifconfig gif0 internal1 internal2

and then the resulting gif0 interface looks like

    inet --> netmask 0xffffff00

It would appear that the mask is missing from the command like so:

    # ifconfig gif0 internal1 netmask internal2

Even better, since example IP addresses are used in these docs, write it like this:

    # ifconfig gif0 netmask

and it will be much clearer as to which IP address you are supposed to put where. The documentation never explains which end of the link is supposed to be internal1 and which is internal2. At the very least, rename them as external_remote and external_local.
Comment 1 Andrey V. Elsukov freebsd_committer 2014-12-29 13:53:42 UTC
Also, it will be good to specify 'inet' or 'inet6' keyword in examples.
Comment 2 ari 2014-12-29 15:06:40 UTC
I've just now discovered that the whole gif interface thing is optional for ipsec and not really needed unless you are doing advanced routing things. It would be good if the documentation made that clear.