Bug 41826

Summary: documentation update to bridging section in handbook
Product: Documentation Reporter: steve <steve>
Component: Books & ArticlesAssignee: Ceri Davies <ceri>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
chapter.sgml.diff none

Description steve 2002-08-20 21:50:01 UTC 
	Updates to bridge module require change to handbook section.

Fix: This patch is for
/doc/en_US.ISO8859-1/books/handbook/advanced-networking/chapter.sgml rev 1.1459
Comment 1 Ceri Davies freebsd_committer freebsd_triage 2002-08-20 21:54:50 UTC 
Responsible Changed
From-To: freebsd-doc->ceri

I seem to remember volunteering to commit this.
Comment 2 Ceri Davies freebsd_committer freebsd_triage 2002-08-27 17:43:38 UTC 
On Tue, Aug 20, 2002 at 08:41:10PM -0000, steve@zpfe.com wrote:

> !       <programlisting>net.link.ether.bridge_cfg=&lt;--if1--&gt; &lt;--if2&gt;</programlisting>

According to the manpage for bridge(4), this should look something like :

	net.link.ether.bridge_cfg=if1,if2

With your patch, this is coming out as :

	net.link.ether.bridge_cfg=<--if1--> <--if2>

What was the intention ?
If you wanted to add emphasis that the tokens if1 and if2 should be replaced
then we can use <replaceable> markup here.

Otherwise, can you let me know how you wanted this to be displayed ?

I'm all for the change, but can't see what you wanted here.

Thanks,

Ceri

-- 
you can't see when light's so strong
you can't see when light is gone
Comment 3 Ceri Davies freebsd_committer freebsd_triage 2002-08-27 17:43:58 UTC 
State Changed
From-To: open->feedback

Waiting to hear from originator.
Comment 4 steve 2002-08-27 20:08:47 UTC 
I think your proposed change is fine.

The goal is to have the user replace:

<--if1-->

with the actual name of their interface.

I thought that the <--...--> was a standard, but with a closer look at the 
page I took it from 
(http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/routing.html), 
it's now clear that it isn't.

S
Comment 5 Ceri Davies freebsd_committer freebsd_triage 2002-08-27 20:19:37 UTC 
State Changed
From-To: feedback->closed

The revised change has been committed. 
Thanks for your contribution.