HEADS UP: doc/ slush for 5.4R begins on 2 April, 2005
Hiroki Sato
hrs at FreeBSD.org
Fri Mar 25 03:59:16 UTC 2005
Hi all,
Sorry for such a short notice, but the doc slush will begin on
2 April, 2005 (originally scheduled on 24 March). The 5.4R
schedule for the doc tree on www.FreeBSD.org will be updated soon.
The purpose of the doc slush is to slow down the rate of change
in that tree in order to allow the translation teams time to finalize
their work and to avoid last-minute breakage for the 5.4-RELEASE.
As usual, this is not a real freeze and requires no formal commit
approval procedure for your commit, but you are kindly requested
not to commit large, structural changes during that period.
A list of necessary work for the doc tree is attached below.
Also, it is much appreciated if you would review the FDP docs
such as the handbook and send your suggestion to doc at FreeBSD.org.
Tagging of the doc tree is scheduled to take place
on 11 April, 2005. Thank you for your cooperation and
keep up the good work!
--
| Hiroki SATO
---(begin here)
5.4R TODO list
- Manual page update
* missing manual pages
We need the following manual pages:
gvinum(8)
sx(4)
* RFC derived manual page fix
The following manual pages have to be MFC'd:
gai_strerror(3)
getaddrinfo(3)
getnameinfo(3)
inet6_opt_init(3)
inet6_option_space(3)
inet6_rth_space(3)
inet6_rthdr_space(3)
icmp6(4)
ip6(4)
[volunteer: hrs@]
>> patch:
http://people.allbsd.org/~hrs/FreeBSD/rfc_derived_manpage.diff
* sound(4) related manual page fix
sound(4), pcm(4), snd(4), and snd_*(4) drivers are still
obscure to the users. They will not be simplified (unifying them
to snd(4) and snd_*(4) drivers, for example) in 5.x,
so some rewording of the manual pages which say "this ambiguity
in the naming will be fixed soon" is needed and some explanation
should be added into the handbook.
- Migration Guide update
The FreeBSD Migration Guide should be updated to reflect the
reality of 5.4-RELEASE. I personally think this document is still
needed because the number of people who will try to upgrade their
boxes from 4.11R to 5.4R is not small since some review articles
on the net have said "5.3-RELEASE is unstable".
[volunteer: bmah@ and trhodes@]
>> update committed:
http://www.freebsd.org/cgi/cvsweb.cgi/src/release/doc/en_US.ISO8859-1/early-adopter/Attic/article.sgml.diff?r1=1.21.2.4&r2=1.21.2.5
- IPv6 documentation prefix
APNIC recommends use of IPv6 documentation prefix (2001:0db8::/32)
in technical books, articles, and training material.
Rewriting IPv6 addresses in our docs is needed similarly to
example.{org,net,com} sample domain names.
seealso:
RFC 3849
http://www.apnic.net/info/faq/ipv6-documentation-prefix-faq.html
[volunteer: Brad Davis (so14k at so14k dot com)]
- Handbook update
* disk partitioning and the related utilities
The section 16.3 "adding disks" includes some descriptions on
disk partitions, fdisk, disklabel, and so on. However, it seems
to assume i386 platform and 4.x and early 5.x releases (for example,
we do not have the fdisk program on FreeBSD/sparc64). It needs more
detailed explanations.
* vinum(4) subsystem
vinum(4) subsystem is likely to be replaced with GEOM based version,
but we have both of them as well as gvinum(8) and vinum(8) userland
utilities now. Some rewriting is needed in the section 17.7, 17.8,
and 17.9, for example.
* ntpd(8) program
Some descriptions in the section 23.11 are a bit outdated.
The rc.d/ntpd script is now the recommended way to start the
server, and driftfile directive in the ntp.conf(5) is already
specified as an command line option in $ntpd_flags by default in 5.x.
[volunteer: Brad Davis (so14k at so14k dot com)]
>> comment from martinkov at pobox dot sk:
http://lists.freebsd.org/pipermail/freebsd-doc/2005-March/007442.html
* Kerberos IV and Kerberos 5
We can probably remove (or mark as obsolete) Kerberos IV
in the section 14.8 because it is deprecated and encouraged not to use
due to security issue.
* IPsec
The section 14.10 is based on 4.x and needs to be revised.
* GBDE
The description in the handbook (the section 16.15) is outdated.
Specifically, a sample fstab(5) file and some description of
$gdbe_swap_enable in rc.conf(5) are needed.
* other GEOM-based userland utilities
We need how-to document about geom(8), gmirror(8), gstripe(8),
and graid3(8).
----(end here)
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
URL: <http://lists.freebsd.org/pipermail/freebsd-doc/attachments/20050325/c27b0b87/attachment.sig>
More information about the freebsd-doc
mailing list