man page/link on handbook page error
boo
Michael Lucas
Thanks for mentioning this.
Well, -doc team, this one looks somewhat interesting.
The entity for devfs(5) points to the releng_4 man pages. The
reference in the page specifically discusses devfs(5) from -current.
What's the proper way to handle this?
==ml
--
Michael Lucas
mwl...@blackhelicopters.org
http://www.blackhelicopters.org/~mwlucas/
Big Scary Daemons: http://www.oreillynet.com/pub/q/Big_Scary_Daemons
To Unsubscribe: send mail to majo...@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message
Michael Lucas
> ++ 20/11/01 15:45 -0500 - Michael Lucas:
> | Well, -doc team, this one looks somewhat interesting.
> |
> | The entity for devfs(5) points to the releng_4 man pages. The
> | reference in the page specifically discusses devfs(5) from -current.
> |
> | What's the proper way to handle this?
>
>
> http://www.freebsd.org/cgi/man.cgi?query=devfs&sektion=5&manpath=FreeBSD+5.0-current
>
> You can see the different options availabe by just going to
> http://www.freebsd.org/cgi/man.cgi.
True, but that kind of violates the "use entities everywhere" rule we
have going.
Is there a precedent for how this should be done? Surely somewhere in
the docs there's something similar...
Pete Fritchman
| Well, -doc team, this one looks somewhat interesting.
|
| The entity for devfs(5) points to the releng_4 man pages. The
| reference in the page specifically discusses devfs(5) from -current.
|
| What's the proper way to handle this?
How about:
http://www.freebsd.org/cgi/man.cgi?query=devfs&sektion=5&manpath=FreeBSD+5.0-current
You can see the different options availabe by just going to
http://www.freebsd.org/cgi/man.cgi.
-pete
--
Pete Fritchman [petef@(databits.net|freebsd.org|csh.rit.edu)]
finger pe...@databits.net for PGP key
Bruce A. Mah
> On Tue, Nov 20, 2001 at 03:49:13PM -0500, Pete Fritchman wrote:
> > ++ 20/11/01 15:45 -0500 - Michael Lucas:
> > | Well, -doc team, this one looks somewhat interesting.
> > |
> > | The entity for devfs(5) points to the releng_4 man pages. The
> > | reference in the page specifically discusses devfs(5) from -current.
> > |
> > | What's the proper way to handle this?
> >
> > How about:
> >
> > http://www.freebsd.org/cgi/man.cgi?query=devfs&sektion=5&manpath=FreeBSD+5.
> 0-current
> >
> > You can see the different options availabe by just going to
> > http://www.freebsd.org/cgi/man.cgi.
>
> True, but that kind of violates the "use entities everywhere" rule we
> have going.
>
> Is there a precedent for how this should be done? Surely somewhere in
> the docs there's something similar...
We might need to just special-case this...I presume it's a pretty rare
occurance, at least for the normal doc/ tree.
BTW, the manpage references in the 5.0-CURRENT and 4.4-STABLE release
documentation all point to the wrong place (same problem). In this
case, it should be pretty easy to fix in the stylesheet since they *all*
need to be changed.
Bruce.
Nik Clayton
> On Tue, Nov 20, 2001 at 03:49:13PM -0500, Pete Fritchman wrote:
> > ++ 20/11/01 15:45 -0500 - Michael Lucas:
> > | Well, -doc team, this one looks somewhat interesting.
> > |
> > | The entity for devfs(5) points to the releng_4 man pages. The
> > | reference in the page specifically discusses devfs(5) from -current.
> > |
> > | What's the proper way to handle this?
> >
> > How about:
> >
> > http://www.freebsd.org/cgi/man.cgi?query=devfs&sektion=5&manpath=FreeBSD+5.0-current
> >
> > You can see the different options availabe by just going to
> > http://www.freebsd.org/cgi/man.cgi.
>
> True, but that kind of violates the "use entities everywhere" rule we
> have going.
>
> Is there a precedent for how this should be done? Surely somewhere in
> the docs there's something similar...
No, but this has come up before.
Here's a replacement for the create-refentry-xref-link function in
doc/en_US.ISO8859-1/share/sgml/freebsd.dsl. This uses the vendor
attribute to extend the URL.
<!-- Specify how to generate the man page link HREF -->
(define ($create-refentry-xref-link$ #!optional (n (current-node)))
(let* ((r (select-elements (children n) (normalize "refentrytitle")))
(m (select-elements (children n) (normalize "manvolnum")))
(v (attribute-string (normalize "vendor") n))
(u (string-append "http://www.FreeBSD.org/cgi/man.cgi?query="
(data r) "&" "sektion=" (data m))))
(case v
(("xfree86") (string-append u "&" "manpath=XFree86+4.0.2"))
(("netbsd") (string-append u "&" "manpath=NetBSD+1.5"))
(else u))))
This really ought to be committed, with a case for "freebsd-5.0.0" or
similar that adds the appropriate manpath to the URL. Then you could
write
<citerefentry vendor="freebsd-5.0.0"><refentrytitle>devfs</refentrytitle>
<manvolnum>5</manvolnum></citerefentry>
or similar, create entities for it, and so forth.
Thoughts?
N
--
FreeBSD: The Power to Serve http://www.freebsd.org/
FreeBSD Documentation Project http://www.freebsd.org/docproj/
--- 15B8 3FFC DDB4 34B0 AA5F 94B7 93A8 0764 2C37 E375 ---
Michael Lucas
> <citerefentry vendor="freebsd-5.0.0"><refentrytitle>devfs</refentrytitle>
> <manvolnum>5</manvolnum></citerefentry>
It seems that we're looking at a search-and-replace-fest with every
release.
I suppose it could be far worse, though.
--
Michael Lucas
mwl...@blackhelicopters.org
http://www.blackhelicopters.org/~mwlucas/
Big Scary Daemons: http://www.oreillynet.com/pub/q/Big_Scary_Daemons
To Unsubscribe: send mail to majo...@FreeBSD.org
Nik Clayton
> On Mon, Nov 26, 2001 at 01:17:28PM +0000, Nik Clayton wrote:
> > <citerefentry vendor="freebsd-5.0.0"><refentrytitle>devfs</refentrytitle>
> > <manvolnum>5</manvolnum></citerefentry>
>
> It seems that we're looking at a search-and-replace-fest with every
> release.
Not necessarily. Only when you're referring to a feature of a specific
release.
99.9% of the time you just need to refer to ls(1). It's that remaining
0.1% of the time when you need to refer to (for example) colour support,
that was introduced in a specific version.