os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Revert one of my previous changes. Sentences now have two spaces after

Browse source 
the period. Apologies for the repository bloat. This is entirely a
whitespace change.
This commit is contained in:
Nik Clayton 1999-03-04 22:42:55 +00:00
parent 772051fe94
commit fe79ecbe4d
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=4465
88 changed files with 11040 additions and 11040 deletions
Download patch file Download diff file Expand all files Collapse all files

130
en/handbook/contrib/chapter.sgml
View file

@ -6,12 +6,12 @@
<para>So you want to contribute something to FreeBSD? That is great! We
can always use the help, and FreeBSD is one of those systems that
<emphasis>relies</emphasis> on the contributions of its user base in
order to survive. Your contributions are not only appreciated, they
order to survive. Your contributions are not only appreciated, they
are vital to FreeBSD's continued growth!</para>
<para>Contrary to what some people might also have you believe, you do
not need to be a hot-shot programmer or a close personal friend of the
FreeBSD core team in order to have your contributions accepted. The
FreeBSD core team in order to have your contributions accepted. The
FreeBSD Project's development is done by a large and growing number of
international contributors whose ages and areas of technical expertise
vary greatly, and there is always more work to be done than there are
@ -21,16 +21,16 @@
system environment (and its installation) rather than just a kernel or
a few scattered utilities, our <filename>TODO</filename> list also spans a very wide
range of tasks, from documentation, beta testing and presentation to
highly specialized types of kernel development. No matter what your
highly specialized types of kernel development. No matter what your
skill level, there is almost certainly something you can do to help
the project!</para>
<para>Commercial entities engaged in FreeBSD-related enterprises are
also encouraged to contact us. Need a special extension to make your
also encouraged to contact us. Need a special extension to make your
product work? You will find us receptive to your requests, given that
they are not too outlandish. Working on a value-added product?
they are not too outlandish. Working on a value-added product?
Please let us know! We may be able to work cooperatively on some
aspect of it. The free software world is challenging a lot of
aspect of it. The free software world is challenging a lot of
existing assumptions about how software is developed, sold, and
maintained throughout its life cycle, and we urge you to at least give
it a second look.</para>
@ -41,10 +41,10 @@
<para>The following list of tasks and sub-projects represents
something of an amalgam of the various core team <filename>TODO</filename> lists and user
requests we have collected over the last couple of months. Where
possible, tasks have been ranked by degree of urgency. If you are
requests we have collected over the last couple of months. Where
possible, tasks have been ranked by degree of urgency. If you are
interested in working on one of the tasks you see here, send mail to
the coordinator listed by clicking on their names. If no
the coordinator listed by clicking on their names. If no
coordinator has been appointed, maybe you would like to
volunteer?</para>
@ -59,7 +59,7 @@
<orderedlist>
<listitem>
<para>3-stage boot issues. Overall coordination:
<para>3-stage boot issues. Overall coordination:
&a.hackers;</para>
@ -75,7 +75,7 @@
</listitem>
<listitem>
<para>Filesystem problems. Overall coordination: &a.fs;</para>
<para>Filesystem problems. Overall coordination: &a.fs;</para>
<itemizedlist>
<listitem>
@ -88,7 +88,7 @@
</listitem>
<listitem>
<para>Fix the union file system. Coordinator:
<para>Fix the union file system. Coordinator:
&a.dg;</para>
</listitem>
@ -97,12 +97,12 @@
</listitem>
<listitem>
<para>Implement Int13 vm86 disk driver. Coordinator:
<para>Implement Int13 vm86 disk driver. Coordinator:
&a.hackers;</para>
</listitem>
<listitem>
<para>New bus architecture. Coordinator: &a.newbus;</para>
<para>New bus architecture. Coordinator: &a.newbus;</para>
<itemizedlist>
<listitem>
@ -116,7 +116,7 @@
</listitem>
<listitem>
<para>Port PCI subsystem to new architecture. Coordinator:
<para>Port PCI subsystem to new architecture. Coordinator:
&a.dfr;</para>
</listitem>
@ -139,7 +139,7 @@
</listitem>
<listitem>
<para>Kernel issues. Overall coordination: &a.hackers;</para>
<para>Kernel issues. Overall coordination: &a.hackers;</para>
</listitem>
<listitem>
@ -156,7 +156,7 @@
<listitem>
<para>Make the entire kernel use
<literal>suser()</literal> instead of comparing to 0. It
<literal>suser()</literal> instead of comparing to 0. It
is presently using about half of each. Coordinator:
&a.eivind;</para>
</listitem>
@ -164,7 +164,7 @@
<listitem>
<para>Split securelevels into different parts, to allow an
administrator to throw away those privileges he can throw
away. Setting the overall securelevel needs to have the
away. Setting the overall securelevel needs to have the
same effect as now, obviously. Coordinator:
&a.eivind;</para>
</listitem>
@ -196,7 +196,7 @@
<para>Add code to teh NFS layer so that you cannot
<literal>chdir("..")</literal> out of an NFS partition.
E.g., <filename>/usr</filename> is a UFS partition with
<filename>/usr/src</filename> NFS exported. Now it is
<filename>/usr/src</filename> NFS exported. Now it is
possible to use the NFS filehandle for
<filename>/usr/src</filename> to get access to
<filename>/usr</filename>.</para>
@ -230,7 +230,7 @@
</listitem>
<listitem>
<para>PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk;</para>
<para>PCMCIA/PCCARD. Coordinators: &a.msmith; and &a.phk;</para>
<itemizedlist>
<listitem>
@ -267,7 +267,7 @@
</listitem>
<listitem>
<para>Advanced Power Management. Coordinators: &a.msmith; and
<para>Advanced Power Management. Coordinators: &a.msmith; and
&a.phk;</para>
<itemizedlist>
@ -310,7 +310,7 @@
<listitem>
<para>NetWare Server (protected mode ODI driver) loader and
subservices to allow the use of ODI card drivers supplied
with network cards. The same thing for NDIS drivers and
with network cards. The same thing for NDIS drivers and
NetWare SCSI drivers.</para>
</listitem>
@ -327,7 +327,7 @@
<listitem>
<para>A concerted effort at support for portable computers.
This is somewhat handled by changing PCMCIA bridging rules
and power management event handling. But there are things
and power management event handling. But there are things
like detecting internal vs. external display and picking a
different screen resolution based on that fact, not spinning
down the disk if the machine is in dock, and allowing
@ -343,7 +343,7 @@
<para>Most of the tasks listed in the previous sections require
either a considerable investment of time or an in-depth knowledge
of the FreeBSD kernel (or both). However, there are also many
of the FreeBSD kernel (or both). However, there are also many
useful tasks which are suitable for &quot;weekend hackers&quot;,
or people without programming skills.</para>
@ -359,16 +359,16 @@
</listitem>
<listitem>
<para>Read the <email>freebsd-bugs</email> mailing list. There might be a
<para>Read the <email>freebsd-bugs</email> mailing list. There might be a
problem you can comment constructively on or with patches
you can test. Or you could even try to fix one of the
you can test. Or you could even try to fix one of the
problems yourself.</para>
</listitem>
<listitem>
<para>Read through the FAQ and Handbook periodically. If
<para>Read through the FAQ and Handbook periodically. If
anything is badly explained, out of date or even just
completely wrong, let us know. Even better, send us a fix
completely wrong, let us know. Even better, send us a fix
(SGML is not difficult to learn, but there is no objection
to ASCII submissions).</para>
</listitem>
@ -376,7 +376,7 @@
<listitem>
<para>Help translate FreeBSD documentation into your native
language (if not already available) &mdash; just send an email to
&a.doc; asking if anyone is working on it. Note that you
&a.doc; asking if anyone is working on it. Note that you
are not committing yourself to translating every single
FreeBSD document by doing this &mdash; in fact, the documentation
most in need of translation is the installation
@ -386,7 +386,7 @@
<listitem>
<para>Read the freebsd-questions mailing list and &ng.misc
occasionally (or even
regularly). It can be very satisfying to share your
regularly). It can be very satisfying to share your
expertise and help people solve their problems; sometimes
you may even learn something new yourself! These forums can
also be a source of ideas for things to work on.</para>
@ -450,24 +450,24 @@
<title>Bug reports and general commentary</title>
<para>An idea or suggestion of <emphasis>general</emphasis>
technical interest should be mailed to the &a.hackers;. Likewise,
technical interest should be mailed to the &a.hackers;. Likewise,
people with an interest in such things (and a tolerance for a
<emphasis>high</emphasis> volume of mail!) may subscribe to the
hackers mailing list by sending mail to &a.majordomo;. See
hackers mailing list by sending mail to &a.majordomo;. See
<link linkend="eresources-mail">mailing lists</link> for more
information about this and other mailing lists.</para>
<para>If you find a bug or are submitting a specific change, please
report it using the <citerefentry><refentrytitle>send-pr</refentrytitle><manvolnum>1</manvolnum></citerefentry>program or its
<ulink URL="http://www.freebsd.org/send-pr.html">WEB-based
equivalent</ulink>. Try to fill-in each field of the bug report.
equivalent</ulink>. Try to fill-in each field of the bug report.
Unless they exceed 65KB, include any patches directly in the
report. Consider compressing them and using
<citerefentry><refentrytitle>uuencode</refentrytitle><manvolnum>1</manvolnum></citerefentry> if they exceed 20KB. Upload very large submissions to <ulink url="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/">ftp.freebsd.org:/pub/FreeBSD/incoming/</ulink>.</para>
report. Consider compressing them and using
<citerefentry><refentrytitle>uuencode</refentrytitle><manvolnum>1</manvolnum></citerefentry> if they exceed 20KB. Upload very large submissions to <ulink url="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming/">ftp.freebsd.org:/pub/FreeBSD/incoming/</ulink>.</para>
<para>After filing a report, you should receive confirmation along
with a tracking number. Keep this tracking number so that you can
update us with details about the problem by sending mail to <email>bug-followup@FreeBSD.ORG</email>. Use the number as the message subject, e.g. <literal>"Re: kern/3377"</literal>. Additional information for any bug report should be submitted this way.</para>
with a tracking number. Keep this tracking number so that you can
update us with details about the problem by sending mail to <email>bug-followup@FreeBSD.ORG</email>. Use the number as the message subject, e.g. <literal>"Re: kern/3377"</literal>. Additional information for any bug report should be submitted this way.</para>
<para>If you do not receive confirmation in a timely fashion (3 days
to a week, depending on your email connection) or are, for some
@ -480,7 +480,7 @@
<sect2>
<title>Changes to the documentation</title>
<para>Changes to the documentation are overseen by the &a.doc;. Send
<para>Changes to the documentation are overseen by the &a.doc;. Send
submissions and changes (even small ones are welcome!) using
<command>send-pr</command> as described in
<link linkend="contrib-general">Bug Reports and General
@ -503,16 +503,16 @@
<para>Working from older sources unfortunately means that your
changes may sometimes be too obsolete or too divergent for easy
re-integration into FreeBSD. Chances of this can be minimized
re-integration into FreeBSD. Chances of this can be minimized
somewhat by subscribing to the &a.announce; and the &a.current;
lists, where discussions on the current state of the system take
place.</para>
<para>Assuming that you can manage to secure fairly up-to-date
sources to base your changes on, the next step is to produce a set
of diffs to send to the FreeBSD maintainers. This is done with
of diffs to send to the FreeBSD maintainers. This is done with
the <citerefentry><refentrytitle>diff</refentrytitle><manvolnum>1</manvolnum></citerefentry> command, with the &ldquo;context diff&rdquo;
form being preferred. For example:</para>
form being preferred. For example:</para>
<para>
<screen>&prompt.user; <userinput>diff -c oldfile newfile</userinput></screen>
@ -525,15 +525,15 @@
would generate such a set of context diffs for
the given source file or directory hierarchy. See the man page
the given source file or directory hierarchy. See the man page
for <citerefentry><refentrytitle>diff</refentrytitle><manvolnum>1</manvolnum></citerefentry> for more details.</para>
<para>Once you have a set of diffs (which you may test with the
<citerefentry><refentrytitle>patch</refentrytitle><manvolnum>1</manvolnum></citerefentry> command), you should submit them for
inclusion with FreeBSD. Use the <citerefentry><refentrytitle>send-pr</refentrytitle><manvolnum>1</manvolnum></citerefentry>
inclusion with FreeBSD. Use the <citerefentry><refentrytitle>send-pr</refentrytitle><manvolnum>1</manvolnum></citerefentry>
program as described in
<link linkend="contrib-general">Bug Reports and General
Commentary</link>. <emphasis>Do not</emphasis> just send the diffs to
Commentary</link>. <emphasis>Do not</emphasis> just send the diffs to
the &a.hackers; or they will get lost! We greatly appreciate your
submission (this is a volunteer project!); because we are busy, we
may not be able to address it immediately, but it will remain in
@ -541,22 +541,22 @@
<para>If you feel it appropriate (e.g. you have added, deleted, or
renamed files), bundle your changes into a <command>tar</command> file and run the
<citerefentry><refentrytitle>uuencode</refentrytitle><manvolnum>1</manvolnum></citerefentry> program on it. Shar archives are
<citerefentry><refentrytitle>uuencode</refentrytitle><manvolnum>1</manvolnum></citerefentry> program on it. Shar archives are
also welcome.</para>
<para>If your change is of a potentially sensitive nature, e.g. you
are unsure of copyright issues governing its further distribution
or you are simply not ready to release it without a tighter review
first, then you should send it to &a.core; directly rather than
submitting it with <citerefentry><refentrytitle>send-pr</refentrytitle><manvolnum>1</manvolnum></citerefentry>. The core
submitting it with <citerefentry><refentrytitle>send-pr</refentrytitle><manvolnum>1</manvolnum></citerefentry>. The core
mailing list reaches a much smaller group of people who do much of
the day-to-day work on FreeBSD. Note that this group is also
the day-to-day work on FreeBSD. Note that this group is also
<emphasis>very busy</emphasis> and so you should only send mail to
them where it is truly necessary.</para>
<para>Please refer to <command>man 9 intro</command> and
<command>man 9 style</command> for some information on
coding style. We would appreciate it if you were at least aware
coding style. We would appreciate it if you were at least aware
of this information before submitting code.</para>
</sect2>
@ -571,16 +571,16 @@
URL="ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming">ftp://ftp.FreeBSD.ORG/pub/FreeBSD/incoming</ulink>.</para>
<para>When working with large amounts of code, the touchy subject of
copyrights also invariably comes up. Acceptable copyrights for
copyrights also invariably comes up. Acceptable copyrights for
code included in FreeBSD are:</para>
<orderedlist>
<listitem>
<para>The BSD copyright. This copyright is most preferred due
<para>The BSD copyright. This copyright is most preferred due
to its &ldquo;no strings attached&rdquo; nature and general
attractiveness to commercial enterprises. Far from
attractiveness to commercial enterprises. Far from
discouraging such commercial use, the FreeBSD Project
actively encourages such participation by commercial
interests who might eventually be inclined to invest
@ -588,13 +588,13 @@
</listitem>
<listitem>
<para>The GNU Public License, or &ldquo;GPL&rdquo;. This license is not
<para>The GNU Public License, or &ldquo;GPL&rdquo;. This license is not
quite as popular with us due to the amount of extra effort
demanded of anyone using the code for commercial purposes,
but given the sheer quantity of GPL'd code we currently
require (compiler, assembler, text formatter, etc) it would
be silly to refuse additional contributions under this
license. Code under the GPL also goes into a different part
license. Code under the GPL also goes into a different part
of the tree, that being <filename>/sys/gnu</filename> or
<filename>/usr/src/gnu</filename>, and is therefore easily
identifiable to anyone for whom the GPL presents a
@ -606,7 +606,7 @@
<para>Contributions coming under any other type of copyright must be
carefully reviewed before their inclusion into FreeBSD will be
considered. Contributions for which particularly restrictive
considered. Contributions for which particularly restrictive
commercial copyrights apply are generally rejected, though the
authors are always encouraged to make such changes available
through their own channels.</para>
@ -670,7 +670,7 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<para>FreeBSD, Inc. was founded in early 1995 by &a.jkh; and
&a.dg; with the goal of furthering the aims of the FreeBSD
Project and giving it a minimal corporate presence. Any and all
Project and giving it a minimal corporate presence. Any and all
funds donated (as well as any profits that may eventually be
realized by FreeBSD, Inc.) will be used exclusively to further
the project's goals.</para>
@ -709,7 +709,7 @@ box can be opened)</para>
<para>If you do not wish to be listed in our <link
linkend="donors">donors</link> section, please specify this
when making your donation. Thanks!</para>
when making your donation. Thanks!</para>
</sect3>
@ -731,9 +731,9 @@ box can be opened)</para>
<listitem>
<para>Hardware for which ongoing compliance testing is
desired. We are currently trying to put together a testing
desired. We are currently trying to put together a testing
lab of all components that FreeBSD supports so that proper
regression testing can be done with each new release. We
regression testing can be done with each new release. We
are still lacking many important pieces (network cards,
motherboards, etc) and if you would like to make such a
donation, please contact &a.dg; for information on
@ -742,7 +742,7 @@ box can be opened)</para>
<listitem>
<para>Hardware currently unsupported by FreeBSD for which
you would like to see such support added. Please contact
you would like to see such support added. Please contact
the &a.core; before sending such items as we will need to
find a developer willing to take on the task before we can
accept delivery of new hardware.</para>
@ -756,7 +756,7 @@ box can be opened)</para>
<sect3>
<title>Donating Internet access</title>
<para>We can always use new mirror sites for FTP, WWW or <command>cvsup</command>. If
<para>We can always use new mirror sites for FTP, WWW or <command>cvsup</command>. If
you would like to be such a mirror, please contact the FreeBSD project
administrators <email>admin@FreeBSD.ORG</email> for more information.</para>
@ -965,7 +965,7 @@ box can be opened)</para>
</listitem>
<listitem>
<para>Ernst Winter <email>ewinter@lobo.muc.de</email> contributed a 2.88 MB floppy drive to the project. This will hopefully increase the pressure for rewriting the floppy disk driver. <!-- smiley -->;-)</para>
<para>Ernst Winter <email>ewinter@lobo.muc.de</email> contributed a 2.88 MB floppy drive to the project. This will hopefully increase the pressure for rewriting the floppy disk driver. <!-- smiley -->;-)</para>
</listitem>
<listitem>
@ -973,7 +973,7 @@ box can be opened)</para>
Technologies</ulink> sent one each of their DC-390,
DC-390U and DC-390F FAST and ULTRA SCSI host adapter
cards for regression testing of the NCR and AMD drivers
with their cards. They are also to be applauded for
with their cards. They are also to be applauded for
making driver sources for free operating systems
available from their FTP server <ulink
URL="ftp://ftp.tekram.com/scsi/FreeBSD">ftp://ftp.tekram.com/scsi/FreeBSD</ulink>.</para>
@ -1011,12 +1011,12 @@ box can be opened)</para>
CDROM</ulink> has donated almost more than we can say
(see the
<link linkend="history">history</link> document for
more details). In particular, we would like to thank
more details). In particular, we would like to thank
them for the original hardware used for
<hostid role="fqdn">freefall.FreeBSD.ORG</hostid>, our primary
development machine, and for
<hostid role="fqdn">thud.FreeBSD.ORG</hostid>, a testing and
build box. We are also indebted to them for funding
build box. We are also indebted to them for funding
various contributors over the years and providing us
with unrestricted use of their T1 connection to the
Internet.</para>
@ -1110,7 +1110,7 @@ box can be opened)</para>
<para>This software was originally derived from William F. Jolitz's
386BSD release 0.1, though almost none of the original 386BSD
specific code remains. This software has been essentially
specific code remains. This software has been essentially
re-implemented from the 4.4BSD-Lite release provided by the Computer
Science Research Group (CSRG) at the University of California,
Berkeley and associated academic contributors.</para>