Page MenuHomeFreeBSD

gifconfig_gif0 no longer works, document replacement
ClosedPublic

Authored by karels on Nov 17 2017, 5:07 AM.

Details

Summary

rc.conf(5) documents the gifconfig_<interface> keyword, which is
no longer implemented. Document the replacement, which works with
cloned_interfaces as well.

Test Plan

tested with FreeBSD 11.1

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint OK
Unit
No Unit Test Coverage
Build Status
Buildable 12837
Build 13101: arc lint + arc unit

Event Timeline

This is a content change, so you need to bump the .Dd to the date of the commit.

wblock added inline comments.
share/man/man5/rc.conf.5
1818–1819

Not yours, I know, but "is assumed to exist" is terrible. Assumed by who? This kind of says "the code makes assumptions that will probably break and we are just letting you know."

Is there any reason this can't be changed to just

variable exists for each value of
share/man/man5/rc.conf.5
1818–1819

Good point. How about "variable should exist for each value"?

share/man/man5/rc.conf.5
1818–1819

Or maybe " variable should be defined for each value of"? The variable needs to be defined in /etc/rc.conf.

share/man/man5/rc.conf.5
1818–1819

Hm, I did not take the wording to mean that the user is supposed to define those variables, but that the system did it. An example of the importance of wording, I guess.

Anyway, let's just say that in an imperative way (roughly paraphrasing):

For each tunnel interface, set a variable named
.Va ifconfig_ Ns Aq Ar interface
to the values desired to configure the link layer of the tunnel with the

A complete example would be good here. The one given does not show an actual example of actual naming of the variable.

1834

And use this for the full example:

For example:
.Bd -literal -offset indent
ifconfig_gif0="blah blah"
.Ed

With real values for the variable name and contents of the quotes. Actually, looking at that, it makes me more confused, and I'm not sure if the name of the variable on line 1820 is correct. All the more reason for a literal example.

1834–1840

End this sentence here:

.Xr ifconfig 8 .

Another attempt to clarify, flesh out example.

share/man/man5/rc.conf.5
1834

Sorry, I hadn't noticed this comment before uploading a new version. I can touch up the macro usage, but will wait for comments on the content.

share/man/man5/rc.conf.5
1834

I tried the suggested macros, and they put a blank line before the display but not after, which looks odd. Suggestions for fixing this welcome; i don't think this is a whole line of space in the typeset version.

share/man/man5/rc.conf.5
1834

Warren (or anyone), suggestions on how to do this display with reasonable spacing (same before and after)? Any comments on the text?

bjk added inline comments.
share/man/man5/rc.conf.5
1834

I've seen some other places that put a '.Pp' after the '.Ed' (on its own line), which seems to add the desired spacing.

Fix macro usage, update text

Update date.

I forgot to update the date in the last update. I'll optimistically
set it to Nov 30 so I might not have to update if the review is approved.

This revision is now accepted and ready to land.Dec 9 2017, 2:15 AM
This revision was automatically updated to reflect the committed changes.