Subject: bin/36947: incorrect information in symlink(7)
To: None <gnats-admin@netbsd.org, netbsd-bugs@netbsd.org>
From: None <lloyd@archangel.must-have-coffee.gen.nz>
List: netbsd-bugs
Date: 09/07/2007 22:10:00
>Number:         36947
>Category:       bin
>Synopsis:       symlink(7) refers to MNT_MAGICLINKS instead if sysctl
>Confidential:   no
>Severity:       serious
>Priority:       medium
>Responsible:    bin-bug-people
>State:          open
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Fri Sep 07 22:10:00 +0000 2007
>Originator:     Lloyd Parkes
>Release:        NetBSD 4.0_RC1
>Organization:
Must Have Coffee
>Environment:
System: NetBSD archangel.must-have-coffee.gen.nz 4.0_RC1 NetBSD 4.0_RC1 (GENERIC) #30: Thu Sep 6 06:40:54 NZST 2007 lloyd@thallid.must-have-coffee.gen.nz:/vol/scratch/obj/sparc64/sys/arch/sparc64/compile/GENERIC sparc64
Architecture: sparc64
Machine: sparc64
>Description:

Symlink(7) says that MNT_MAGICLINKS flag must be set on the filesystem
for magic symlinks to be expanded. Mount(8) doesn't refer to any such page,
but "sysctl -a" prints out a variable caled vfs.generic.magiclinks. This
variable is not listed in the sysctl page.

I know this is a little used feature, but the doco really ought to be fixed 
in 4.0_RC2. 

>How-To-Repeat:

Read symlink(7) and then read mount(8) and become confused. 

>Fix:

Replace the first sentence in the *MAGIC SYMLINKS* section with:
Symlinks have ``magic'' patterns in them expanded when the sysctl(8) variable
vfs.generic.magiclinks is set to 1.

I've referred to sysctl(8) rather than sysctl(3) because that's a more
useful page for someone who is in the middle of making magic symlinks
work.