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

Whitespace-only fixes: wrap long lines, use tabs instead of spaces, fix

Browse source 
indentation.
This commit is contained in:
Warren Block 2012-02-07 22:08:33 +00:00
parent cbc1c2d0dd
commit ae2dddb6b9
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=38411
1 changed files with 95 additions and 79 deletions
Download patch file Download diff file Expand all files Collapse all files

174
en_US.ISO8859-1/articles/contributing/article.sgml
View file

@ -12,8 +12,8 @@
<abstract>
<para>This article describes the different ways in which an
individual or organization may contribute to the FreeBSD
Project.</para>
individual or organization may contribute to the FreeBSD
Project.</para>
</abstract>
<authorgroup>
@ -67,7 +67,7 @@
<sect1 id="contrib-what">
<title>What Is Needed</title>
<para>The following list of tasks and sub-projects represents
something of an amalgam of various <filename>TODO</filename>
lists and user requests.</para>
@ -119,11 +119,13 @@
</sect2>
<sect2 id="ongoing-programmer-tasks">
<title>Ongoing Programmer Tasks</title>
<para>Most of the tasks listed here require either a considerable
investment of time, or an in-depth knowledge of the FreeBSD
kernel, or both. However, there are also many useful tasks
which are suitable for <quote>weekend hackers</quote>.</para>
<title>Ongoing Programmer Tasks</title>
<para>Most of the tasks listed here require either a
considerable investment of time, or an in-depth knowledge of
the FreeBSD kernel, or both. However, there are also many
useful tasks which are suitable for <quote>weekend
hackers</quote>.</para>
<orderedlist>
<listitem>
@ -151,13 +153,14 @@
<listitem>
<para>Move contributed software to
<filename class="directory">src/contrib</filename> in the source
tree.</para>
<filename class="directory">src/contrib</filename> in the
source tree.</para>
</listitem>
<listitem>
<para>Make sure code in <filename class="directory">src/contrib</filename> is
up to date.</para>
<para>Make sure code in
<filename class="directory">src/contrib</filename> is up
to date.</para>
</listitem>
<listitem>
@ -183,8 +186,8 @@
get some links about these standards at the <ulink
url="&url.base;/projects/c99/index.html">FreeBSD
C99 & POSIX Standards Conformance Project</ulink> web
site. Compare FreeBSD's behavior to that required by the
standard. If the behavior differs, particularly in subtle
site. Compare FreeBSD's behavior to that required by the
standard. If the behavior differs, particularly in subtle
or obscure corners of the specification, send in a PR
about it. If you are able, figure out how to fix it and
include a patch in the PR. If you think the standard is
@ -201,11 +204,13 @@
<sect2>
<title>Work through the PR Database</title>
<indexterm><primary>problem reports database</primary></indexterm>
<indexterm>
<primary>problem reports database</primary>
</indexterm>
<para>The <ulink
url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi">FreeBSD
PR list</ulink> shows all the current active problem reports
url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi">FreeBSD
PR list</ulink> shows all the current active problem reports
and requests for enhancement that have been submitted by
FreeBSD users. The PR database includes both programmer and
non-programmer tasks. Look through the open PRs, and see if
@ -224,13 +229,15 @@
</sect2>
<sect2>
<title>Pick one of the items from the <quote>Ideas</quote> page</title>
<title>Pick one of the items from the <quote>Ideas</quote>
page</title>
<para>The <ulink url="&url.base;/projects/ideas/">&os; list of
projects and ideas for volunteers</ulink> is also available for
people willing to contribute to the &os; project. The list is
being regularly updated and contains items for both programmers
and non-programmers with information about each project.</para>
projects and ideas for volunteers</ulink> is also available
for people willing to contribute to the &os; project. The
list is being regularly updated and contains items for both
programmers and non-programmers with information about each
project.</para>
</sect2>
</sect1>
@ -261,11 +268,11 @@
in the report. If the patch is suitable to be applied to the
source tree put <literal>[PATCH]</literal> in the synopsis of
the report. When including patches, <emphasis>do
not</emphasis> use cut-and-paste because cut-and-paste turns
tabs into spaces and makes them unusable. When patches are a lot
larger than 20KB, consider compressing them (eg. with &man.gzip.1;
or &man.bzip2.1;) and using &man.uuencode.1; to include their
compressed form in your problem report.</para>
not</emphasis> use cut-and-paste because cut-and-paste turns
tabs into spaces and makes them unusable. When patches are a
lot larger than 20KB, consider compressing them (eg. with
&man.gzip.1; or &man.bzip2.1;) and using &man.uuencode.1; to
include their compressed form in your problem report.</para>
<para>After filing a report, you should receive confirmation
along with a tracking number. Keep this tracking number so
@ -282,23 +289,25 @@
the &a.bugs;.</para>
<para>See also <ulink
url="&url.articles.problem-reports;/article.html">this
article</ulink> on how to write good problem reports.</para>
url="&url.articles.problem-reports;/article.html">this
article</ulink> on how to write good problem reports.</para>
</sect2>
<sect2>
<title>Changes to the Documentation</title>
<indexterm><primary>documentation submissions</primary></indexterm>
<indexterm>
<primary>documentation submissions</primary>
</indexterm>
<para>Changes to the documentation are overseen by the &a.doc;.
Please look at the <ulink
url="&url.books.fdp-primer;/index.html">FreeBSD Documentation
Project Primer</ulink> for complete instructions. Send
submissions and changes (even small ones are welcome!) using
&man.send-pr.1; as described in <link
linkend="contrib-general">Bug Reports and General
Commentary</link>.</para>
Please look at the
<ulink url="&url.books.fdp-primer;/index.html">FreeBSD
Documentation Project Primer</ulink> for complete
instructions. Send submissions and changes (even small ones
are welcome!) using &man.send-pr.1; as described in
<link linkend="contrib-general">Bug Reports and General
Commentary</link>.</para>
</sect2>
<sect2>
@ -309,13 +318,13 @@
<para>An addition or change to the existing source code is a
somewhat trickier affair and depends a lot on how far out of
date you are with the current state of FreeBSD
development. There is a special on-going release of FreeBSD
development. There is a special on-going release of FreeBSD
known as <quote>FreeBSD-CURRENT</quote> which is made
available in a variety of ways for the convenience of
developers working actively on the system. See <ulink url="
&url.books.handbook;/current-stable.html">The FreeBSD
Handbook</ulink> for more information about getting and using
FreeBSD-CURRENT.</para>
developers working actively on the system. See
<ulink url="&url.books.handbook;/current-stable.html">The
FreeBSD Handbook</ulink> for more information about getting
and using FreeBSD-CURRENT.</para>
<para>Working from older sources unfortunately means that your
changes may sometimes be too obsolete or too divergent for
@ -324,20 +333,20 @@
&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 the &man.diff.1;
command.</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 the &man.diff.1; command.</para>
<para>The preferred &man.diff.1; format for submitting patches
is the unified output format generated by <command>diff
-u</command>. However, for patches that substantially change a
region of code, a context output format diff generated by
<command>diff -c</command> may be more readable and thus
preferable.</para>
is the unified output format generated by <command>diff
-u</command>. However, for patches that substantially
change a region of code, a context output format diff
generated by <command>diff -c</command> may be more readable
and thus preferable.</para>
<indexterm>
<primary><command>diff</command></primary>
<primary><command>diff</command></primary>
</indexterm>
<para>For example:</para>
@ -359,9 +368,11 @@
<screen>&prompt.user; <userinput>diff -u -r olddir newdir</userinput></screen>
<para>would do the same, except in the unified diff format.</para>
<para>would do the same, except in the unified diff
format.</para>
<para>See the manual page for &man.diff.1; for more details.</para>
<para>See the manual page for &man.diff.1; for more
details.</para>
<para>Once you have a set of diffs (which you may test with the
&man.patch.1; command), you should submit them for inclusion
@ -377,13 +388,14 @@
report.</para>
<indexterm>
<primary><command>uuencode</command></primary>
<primary><command>uuencode</command></primary>
</indexterm>
<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 &man.uuencode.1;
program on it. Archives created with &man.shar.1; are also welcome.</para>
program on it. Archives created with &man.shar.1; 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
@ -396,7 +408,7 @@
only send mail to them where it is truly necessary.</para>
<para>Please refer to &man.intro.9; and &man.style.9; for
some information on coding style. We would appreciate it if
some information on coding style. We would appreciate it if
you were at least aware of this information before submitting
code.</para>
</sect2>
@ -417,7 +429,7 @@
copyrights for code included in FreeBSD are:</para>
<orderedlist>
<indexterm><primary>BSD copyright</primary></indexterm>
<indexterm><primary>BSD copyright</primary></indexterm>
<listitem>
<para>The BSD copyright. This copyright is most preferred
due to its <quote>no strings attached</quote> nature and
@ -428,8 +440,12 @@
something of their own into FreeBSD.</para>
</listitem>
<indexterm><primary>GPL</primary><see>GNU General Public License</see></indexterm>
<indexterm><primary>GNU General Public License</primary></indexterm>
<indexterm>
<primary>GPL</primary><see>GNU General Public License</see>
</indexterm>
<indexterm>
<primary>GNU General Public License</primary>
</indexterm>
<listitem>
<para>The GNU General Public License, or <quote>GPL</quote>.
This license is not quite as popular with us due to the
@ -440,9 +456,9 @@
contributions under this license. Code under the GPL also
goes into a different part of the tree, that being
<filename class="directory">/sys/gnu</filename> or
<filename class="directory">/usr/src/gnu</filename>, and is therefore easily
identifiable to anyone for whom the GPL presents a
problem.</para>
<filename class="directory">/usr/src/gnu</filename>, and
is therefore easily identifiable to anyone for whom the
GPL presents a problem.</para>
</listitem>
</orderedlist>
@ -514,34 +530,34 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<address>
The FreeBSD Foundation
<street>7321 Brockway Dr.</street>
<city>Boulder</city>, <state>CO</state> <postcode>80303</postcode>
<city>Boulder</city>,
<state>CO</state> <postcode>80303</postcode>
<country>USA</country>
</address>
</para>
</address></para>
<para>The FreeBSD Foundation is now able to accept donations
through the web with PayPal. To place a donation, please
visit the Foundation <ulink
url="http://www.freebsdfoundation.org">web
site</ulink>.</para>
visit the Foundation
<ulink url="http://www.freebsdfoundation.org">web
site</ulink>.</para>
<para>More information about the FreeBSD Foundation can be
found in <ulink
url="http://people.FreeBSD.org/~jdp/foundation/announcement.html">The
FreeBSD Foundation -- an Introduction</ulink>. To contact
url="http://people.FreeBSD.org/~jdp/foundation/announcement.html">The
FreeBSD Foundation -- an Introduction</ulink>. To contact
the Foundation by email, write to
<email>bod@FreeBSDFoundation.org</email>.</para>
</sect3>
<sect3>
<title>Donating Hardware</title>
<indexterm><primary>donations</primary></indexterm>
<indexterm><primary>donations</primary></indexterm>
<para>The FreeBSD Project happily accepts donations of
hardware that it can find good use for. If you are
interested in donating hardware, please contact the <ulink
url="&url.base;/donations/">Donations Liaison
Office</ulink>.</para>
interested in donating hardware, please contact the
<ulink url="&url.base;/donations/">Donations Liaison
Office</ulink>.</para>
</sect3>
<sect3>
@ -549,16 +565,16 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
<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 see the <ulink
url="&url.articles.hubs;/index.html">Mirroring FreeBSD</ulink>
article for more information.</para>
mirror, please see the
<ulink url="&url.articles.hubs;/index.html">Mirroring
FreeBSD</ulink> article for more information.</para>
</sect3>
</sect2>
</sect1>
</article>
<!--
<!--
Local Variables:
mode: sgml
sgml-indent-data: t