From owner-freebsd-doc@FreeBSD.ORG  Thu May 28 21:42:06 2015
Return-Path: <owner-freebsd-doc@FreeBSD.ORG>
Delivered-To: freebsd-doc@FreeBSD.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits))
 (No client certificate requested)
 by hub.freebsd.org (Postfix) with ESMTPS id 2741D9D4
 for <freebsd-doc@FreeBSD.org>; Thu, 28 May 2015 21:42:06 +0000 (UTC)
 (envelope-from bugzilla-noreply@freebsd.org)
Received: from kenobi.freebsd.org (kenobi.freebsd.org
 [IPv6:2001:1900:2254:206a::16:76])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id 10FFCEE5
 for <freebsd-doc@FreeBSD.org>; Thu, 28 May 2015 21:42:06 +0000 (UTC)
 (envelope-from bugzilla-noreply@freebsd.org)
Received: from bugs.freebsd.org ([127.0.1.118])
 by kenobi.freebsd.org (8.14.9/8.14.9) with ESMTP id t4SLg5Bh096391
 for <freebsd-doc@FreeBSD.org>; Thu, 28 May 2015 21:42:05 GMT
 (envelope-from bugzilla-noreply@freebsd.org)
From: bugzilla-noreply@freebsd.org
To: freebsd-doc@FreeBSD.org
Subject: [Bug 200501] Clarity improvement in section "31.9.2 Configuring IPv6"
Date: Thu, 28 May 2015 21:42:06 +0000
X-Bugzilla-Reason: AssignedTo
X-Bugzilla-Type: new
X-Bugzilla-Watch-Reason: None
X-Bugzilla-Product: Documentation
X-Bugzilla-Component: Documentation
X-Bugzilla-Version: Latest
X-Bugzilla-Keywords: 
X-Bugzilla-Severity: Affects Only Me
X-Bugzilla-Who: pablo@pablobm.com
X-Bugzilla-Status: New
X-Bugzilla-Priority: ---
X-Bugzilla-Assigned-To: freebsd-doc@FreeBSD.org
X-Bugzilla-Target-Milestone: ---
X-Bugzilla-Flags: 
X-Bugzilla-Changed-Fields: bug_id short_desc product version rep_platform
 op_sys bug_status bug_severity priority component assigned_to reporter
Message-ID: <bug-200501-9@https.bugs.freebsd.org/bugzilla/>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit
X-Bugzilla-URL: https://bugs.freebsd.org/bugzilla/
Auto-Submitted: auto-generated
MIME-Version: 1.0
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.20
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <http://lists.freebsd.org/mailman/options/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc/>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <http://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Thu, 28 May 2015 21:42:06 -0000

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=200501

            Bug ID: 200501
           Summary: Clarity improvement in section "31.9.2 Configuring
                    IPv6"
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Documentation
          Assignee: freebsd-doc@FreeBSD.org
          Reporter: pablo@pablobm.com

I was recently configuring IPv6 on a FreeBSD, following the Handbook. I found
something that could be made clearer for a novice like me (coming to FreeBSD
from Linux). I hope it makes sense.

In the section 31.9.2 (Configuring IPv6) the configured network device is first
referred to as "em0", but then as "fxp0" immediately after. I understand that
these are shown in italics, denoting a changeable parameter, but I think many
people may be confused by this.

I would suggest phrasing the section slightly differently. For example, the
first paragraph could start by saying "Let's assume that your network device is
named 'em0'". Then the examples further below could refer to 'em0' instead of
'fxp0', maintaining consistency.

I would have provided a patch for the appropriate Docbook source, but after
spending an hour with it, I find myself unable to compile the source :-( Sorry!

-- 
You are receiving this mail because:
You are the assignee for the bug.