381 lines
10 KiB
Text
381 lines
10 KiB
Text
<!DOCTYPE HTML PUBLIC "-//FreeBSD//DTD HTML 4.01 Transitional-Based Extension//EN" [
|
|
<!ENTITY base CDATA "..">
|
|
<!ENTITY email 'freebsd-doc'>
|
|
<!ENTITY date "$FreeBSD: www/en/docproj/todo.sgml,v 1.17 2006/08/29 21:02:16 danger Exp $">
|
|
<!ENTITY title "FreeBSD Documentation Project TODO list">
|
|
<!ENTITY % navinclude.docs "INCLUDE">
|
|
<!ENTITY % developers SYSTEM "../developers.sgml"> %developers;
|
|
<!-- Status levels -->
|
|
<!ENTITY status.na "<font color=green>N/A</font>">
|
|
<!ENTITY status.done "<font color=green>Done</font>">
|
|
<!ENTITY status.wip "<font color=blue>In progress</font>">
|
|
<!ENTITY status.untested "<font color=orange>Needs testing</font>">
|
|
<!ENTITY status.new "<font color=red>Not done</font>">
|
|
<!ENTITY status.unknown "<font color=red>Unknown</font>">
|
|
<!ENTITY status.deferred "<font color=gray>Deferred for future release</font>">
|
|
|
|
<!ENTITY url.cvsweb "http://www.freebsd.org/cgi/cvsweb.cgi">
|
|
<!ENTITY url.mid "http://docs.freebsd.org/cgi/mid.cgi?">
|
|
<!ENTITY url.pr "http://www.freebsd.org/cgi/query-pr.cgi?">
|
|
|
|
]>
|
|
|
|
<!--
|
|
|
|
Changes to this list MUST NOT be committed without approval of
|
|
Documentation Engineering Team (doceng@FreeBSD.org).
|
|
|
|
-->
|
|
|
|
<html>
|
|
&header;
|
|
|
|
<p>This is a list of documentation issues that need to be resolved.
|
|
If you have any updates for this list, please e-mail
|
|
doceng@FreeBSD.org.</p>
|
|
|
|
<ul>
|
|
<li><a href="#handbook">Handbook Items</a></li>
|
|
<li><a href="#www">Website</a></li>
|
|
<li><a href="#manpage">Manual Pages</a></li>
|
|
<li><a href="#other">Other Documentation Needs</a></li>
|
|
<li><a href="#toolchain">Documentation Toolchain Items</a></li>
|
|
</ul>
|
|
|
|
|
|
<h3>Handbook Items</h3>
|
|
|
|
<a name="handbook"></a>
|
|
<table class="tblbasic">
|
|
<tr class="heading">
|
|
<th>Issue</th>
|
|
<th>Status</th>
|
|
<th>Responsible</th>
|
|
<th>Desired Deadline</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Installation chapter needs to be updated</td>
|
|
<td>&status.new;</td>
|
|
<td>&a.keramida;</td>
|
|
<td> </td>
|
|
<td>The installation chapter mostly covers FreeBSD 4.X
|
|
installation. The current information is often outdated and not
|
|
accurate for 5.X, 6.X and 7.X. We also have to think about
|
|
installation on various platforms. This should be done under
|
|
re@ team responsability since the installation notes have to be
|
|
updated as well.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Printing chapter lacks a quick and easy setup example</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>While this chapter covers in a very accurate way the
|
|
configuration of a printer under FreeBSD, a quick and easy printer
|
|
setup should be documented, i.e., something describing the
|
|
installation and use of apsfilter or equivalent.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>USB printers</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>Nowadays printers use the USB interface, the printing chapter
|
|
may need to be updated on this point.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Wireless</td>
|
|
<td>&status.new;</td>
|
|
<td>&a.murray;, &a.blackend;</td>
|
|
<td> </td>
|
|
<td>The merge of <a
|
|
href="http://www.freebsdmall.com/~loader/en_US.ISO8859-1/articles/wireless/article.html">this article</a>
|
|
in the current wireless section should be done quickly.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>IPsec section</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>This section still shows the use of gifconfig(4) which is 4.X
|
|
only.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>USB audio</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>One should check if we need to update the sound section for
|
|
USB devices or if the current guidances are still correct with
|
|
these devices.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>The Emergency Restore Procedure section (16.12.8)</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>This section is really outdated and needs a serious
|
|
"facelifting." We must show how to restore a system using the
|
|
livefs from disc1. The rescue system should also be
|
|
covered.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Backup Basics (16.12)</td>
|
|
<td>&status.new;</td>
|
|
<td>&a.murray;</td>
|
|
<td> </td>
|
|
<td>Backing up on optical media (CD/DVD) should be presented.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Electronic mail chapter</td>
|
|
<td>&status.new;</td>
|
|
<td>&a.jcamou;</td>
|
|
<td> </td>
|
|
<td>The use of Makefile facilities should be introduced for the
|
|
sendmail configuration instead of the old outdated way.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>inetd</td>
|
|
<td>&status.done;</td>
|
|
<td>&a.ceri;</td>
|
|
<td>For 6.1-RELEASE</td>
|
|
<td>The configuration of inetd changed a bit in 6.X, one should
|
|
check if the related section is still correct.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>bsnmpd</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>The bsnmpd daemon is quite new and its configuration may be
|
|
complex. The minimal common settings should be introduced in a
|
|
section of the Network Servers chapter.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>The handbook needs to be updated to match 5.X and beyond</td>
|
|
<td>&status.done;</td>
|
|
<td>&a.trhodes;</td>
|
|
<td> </td>
|
|
<td>The handbook covers a lot of 4.X material and has 5.X
|
|
information on the background. The handbook should be
|
|
updated to remove 4.X material where possible.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Website</h3>
|
|
|
|
<a name="website"></a>
|
|
<table class="tblbasic">
|
|
<tr class="heading">
|
|
<th>Issue</th>
|
|
<th>Status</th>
|
|
<th>Responsible</th>
|
|
<th>Desired Deadline</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>New logo</td>
|
|
<td>&status.done;</td>
|
|
<td>&a.kuriyama;</td>
|
|
<td> </td>
|
|
<td>Add the new logo on our web site layout and create a logo
|
|
page displaying, and providing information on right logo
|
|
usage.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Rendering issue</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>After the introduction of new layout, many persons reported a
|
|
font size or rendering problems under some browsers configurations
|
|
and screen resolutions. These problems should be investigated
|
|
and fixed. Reference:
|
|
<a
|
|
href="http://www.freebsd.org/cgi/query-pr.cgi?pr=91539">www/91539</a>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Manual Pages</h3>
|
|
|
|
<a name="manpage"></a>
|
|
<table class="tblbasic">
|
|
<tr class="heading">
|
|
<th>Issue</th>
|
|
<th>Status</th>
|
|
<th>Responsible</th>
|
|
<th>Desired Deadline</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>bs(4)</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>New manual page needed for the WD33C93 SCSI driver</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>nss(4)</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>New manual page needed for the NEC PC-98 sound support</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>ofwcons(4)</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>New manual page needed for the IEEE-1275 / Open Firmware</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>wds(4)</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>New manual page needed for the WD7000 SCSI driver</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>xrpu(4)</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>New manual page needed for the Xilinx FPGA/RPU driver</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>zs(4)</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>New manual page needed for the Zilog UART driver</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Write section 9 manual pages</td>
|
|
<td>&status.new;</td>
|
|
<td>&a.trhodes; and &a.hmp;</td>
|
|
<td> </td>
|
|
<td>Document kernel interfaces and functions.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Documenting FreeBSD Tunables</td>
|
|
<td>&status.new;</td>
|
|
<td>&a.trhodes;</td>
|
|
<td> </td>
|
|
<td>Many FreeBSD tunables are undocumented. Everyone knows how
|
|
difficult it can be to use an undocumented system, and thus this
|
|
project was formed. The initial goal here is to create a tool
|
|
which can generate a manual page with the tunables. Hence we need
|
|
to generate this list from the source code.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Other Documentations Needs</h3>
|
|
|
|
<a name="other"></a>
|
|
<table class="tblbasic">
|
|
<tr class="heading">
|
|
<th>Issue</th>
|
|
<th>Status</th>
|
|
<th>Responsible</th>
|
|
<th>Desired Deadline</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>CUPS</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>The CUPS system is more and more used, it would be interesting
|
|
to have an extensive article in our documentation set. This
|
|
article should cover CUPS installation and configuration (with
|
|
examples of local and network printers).</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>NanoBSD</td>
|
|
<td>&status.done;</td>
|
|
<td>&a.keramida;</td>
|
|
<td> </td>
|
|
<td>&a.danger; contributed both manpage and article for
|
|
NanoBSD framework.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>Architecture Handbook</td>
|
|
<td>&status.new;</td>
|
|
<td> </td>
|
|
<td> </td>
|
|
<td>The FreeBSD Architecture Handbook is lacking in content,
|
|
please help us finish this book in writing or updating some
|
|
chapters.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h3>Documentation Toolchain Items</h3>
|
|
|
|
<a name="toolchain"></a>
|
|
<table class="tblbasic">
|
|
<tr class="heading">
|
|
<th>Issue</th>
|
|
<th>Status</th>
|
|
<th>Responsible</th>
|
|
<th>Desired Deadline</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SGML/XML infrastructure update</td>
|
|
<td>&status.wip;</td>
|
|
<td>&a.hrs;</td>
|
|
<td> </td>
|
|
<td>Add more localization support for XML documentation in the doc
|
|
and www tree.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SGML/XML infrastructure update</td>
|
|
<td>&status.wip;</td>
|
|
<td>&a.hrs;</td>
|
|
<td> </td>
|
|
<td>Use SGML/XML catalog for external file reference for
|
|
consistency.</td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td>SGML/XML infrastructure update</td>
|
|
<td>&status.wip;</td>
|
|
<td>&a.hrs;</td>
|
|
<td> </td>
|
|
<td>Add standard entity reference (such as &agrave;) support in
|
|
XML/XSLT documentation.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
&footer;
|
|
</body>
|
|
</html>
|