Whitespace diff. No content changes.
This includes a re-justification of the whole document, as many lines were far too long, not just the ones I touched in the last commit.
This commit is contained in:
Michael Lucas
parent
db46fb6953
commit
1ead757eb4
Notes:
svn2git
2020-12-08 03:00:23 +00:00
svn path=/head/; revision=12998
1 changed files with 252 additions and 227 deletions
|
|
@ -13,9 +13,9 @@ FreeBSD Entities//EN"> %freebsd;
|
||||||
<article>
|
<article>
|
||||||
<articleinfo>
|
<articleinfo>
|
||||||
<title>Contributing to FreeBSD</title>
|
<title>Contributing to FreeBSD</title>
|
||||||
|
|
||||||
<pubdate>$FreeBSD$</pubdate>
|
<pubdate>$FreeBSD$</pubdate>
|
||||||
|
|
||||||
<abstract>
|
<abstract>
|
||||||
<para>This article describes the different ways in which an
|
<para>This article describes the different ways in which an
|
||||||
individual or organization may contribute to the FreeBSD
|
individual or organization may contribute to the FreeBSD
|
||||||
|
|
@ -30,14 +30,14 @@ FreeBSD Entities//EN"> %freebsd;
|
||||||
</author>
|
</author>
|
||||||
</authorgroup>
|
</authorgroup>
|
||||||
</articleinfo>
|
</articleinfo>
|
||||||
|
|
||||||
<indexterm><primary>contributing</primary></indexterm>
|
<indexterm><primary>contributing</primary></indexterm>
|
||||||
|
|
||||||
<para>So you want to contribute to FreeBSD? That is great! FreeBSD
|
<para>So you want to contribute to FreeBSD? That is great! FreeBSD
|
||||||
<emphasis>relies</emphasis> on the contributions of its user base
|
<emphasis>relies</emphasis> on the contributions of its user base
|
||||||
to survive. Your contributions are not only appreciated, they are
|
to survive. Your contributions are not only appreciated, they are
|
||||||
vital to FreeBSD's continued growth.</para>
|
vital to FreeBSD's continued growth.</para>
|
||||||
|
|
||||||
<para>Contrary to what some people might have you believe, you do
|
<para>Contrary to what some people might have you believe, you do
|
||||||
not need to be a hot-shot programmer or a close personal friend of
|
not need to be a hot-shot programmer or a close personal friend of
|
||||||
the FreeBSD core team to have your contributions accepted. A
|
the FreeBSD core team to have your contributions accepted. A
|
||||||
|
|
@ -45,7 +45,7 @@ FreeBSD Entities//EN"> %freebsd;
|
||||||
varying ages and areas of technical expertise, develop FreeBSD.
|
varying ages and areas of technical expertise, develop FreeBSD.
|
||||||
There is always more work to be done than there are people
|
There is always more work to be done than there are people
|
||||||
available to do it, and more help is always appreciated.</para>
|
available to do it, and more help is always appreciated.</para>
|
||||||
|
|
||||||
<para>The FreeBSD project is responsible for an entire operating
|
<para>The FreeBSD project is responsible for an entire operating
|
||||||
system environment, rather than just a kernel or a few scattered
|
system environment, rather than just a kernel or a few scattered
|
||||||
utilities. As such, our <filename>TODO</filename> lists span a
|
utilities. As such, our <filename>TODO</filename> lists span a
|
||||||
|
|
@ -53,7 +53,7 @@ FreeBSD Entities//EN"> %freebsd;
|
||||||
presentation, to the system installer and highly specialized types
|
presentation, to the system installer and highly specialized types
|
||||||
of kernel development. People of any skill level, in almost any
|
of kernel development. People of any skill level, in almost any
|
||||||
area, can almost certainly help the project.</para>
|
area, can almost certainly help the project.</para>
|
||||||
|
|
||||||
<para>Commercial entities engaged in FreeBSD-related enterprises are
|
<para>Commercial entities engaged in FreeBSD-related enterprises are
|
||||||
also encouraged to contact us. Do you need a special extension to
|
also encouraged to contact us. Do you need a special extension to
|
||||||
make your product work? You will find us receptive to your
|
make your product work? You will find us receptive to your
|
||||||
|
|
@ -63,17 +63,17 @@ FreeBSD Entities//EN"> %freebsd;
|
||||||
is challenging many existing assumptions about how software is
|
is challenging many existing assumptions about how software is
|
||||||
developed, sold, and maintained, and we urge you to at least give
|
developed, sold, and maintained, and we urge you to at least give
|
||||||
it a second look.</para>
|
it a second look.</para>
|
||||||
|
|
||||||
<sect1 id="contrib-what">
|
<sect1 id="contrib-what">
|
||||||
<title>What Is Needed</title>
|
<title>What Is Needed</title>
|
||||||
|
|
||||||
<para>The following list of tasks and sub-projects represents something of
|
<para>The following list of tasks and sub-projects represents
|
||||||
an amalgam of various <filename>TODO</filename> lists and
|
something of an amalgam of various <filename>TODO</filename>
|
||||||
user requests.</para>
|
lists and user requests.</para>
|
||||||
|
|
||||||
<sect2 id="non-programmer-tasks">
|
<sect2 id="non-programmer-tasks">
|
||||||
<title>Ongoing Non-Programmer Tasks</title>
|
<title>Ongoing Non-Programmer Tasks</title>
|
||||||
|
|
||||||
<para>Many people who are involved in FreeBSD are not
|
<para>Many people who are involved in FreeBSD are not
|
||||||
programmers. The Project includes documentation writers, Web
|
programmers. The Project includes documentation writers, Web
|
||||||
designers, and support people. All that these people need to
|
designers, and support people. All that these people need to
|
||||||
|
|
@ -82,10 +82,11 @@ FreeBSD Entities//EN"> %freebsd;
|
||||||
|
|
||||||
<orderedlist>
|
<orderedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Read through the FAQ and Handbook periodically. If anything
|
<para>Read through the FAQ and Handbook periodically. If
|
||||||
is badly explained, out of date or even just completely wrong, let
|
anything is badly explained, out of date or even just
|
||||||
us know. Even better, send us a fix (SGML is not difficult to
|
completely wrong, let us know. Even better, send us a fix
|
||||||
learn, but there is no objection to ASCII submissions).</para>
|
(SGML is not difficult to learn, but there is no objection
|
||||||
|
to ASCII submissions).</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
|
|
@ -107,58 +108,60 @@ FreeBSD Entities//EN"> %freebsd;
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Read the freebsd-questions mailing list and &ng.misc;
|
<para>Read the freebsd-questions mailing list and &ng.misc;
|
||||||
occasionally (or even regularly). It can be very satisfying to
|
occasionally (or even regularly). It can be very
|
||||||
share your expertise and help people solve their problems;
|
satisfying to share your expertise and help people solve
|
||||||
sometimes you may even learn something new yourself! These forums
|
their problems; sometimes you may even learn something new
|
||||||
can also be a source of ideas for things to work on.</para>
|
yourself! These forums can also be a source of ideas for
|
||||||
|
things to work on.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</orderedlist>
|
</orderedlist>
|
||||||
</sect2>
|
</sect2>
|
||||||
|
|
||||||
<sect2 id="ongoing-programmer-tasks">
|
<sect2 id="ongoing-programmer-tasks">
|
||||||
<title>Ongoing Programmer Tasks</title>
|
<title>Ongoing Programmer Tasks</title>
|
||||||
<para>Most of the tasks listed here require a
|
<para>Most of the tasks listed here require a considerable
|
||||||
considerable investment of time, an in-depth knowledge of the
|
investment of time, an in-depth knowledge of the FreeBSD
|
||||||
FreeBSD kernel, or both. However, there are also many useful tasks
|
kernel, or both. However, there are also many useful tasks
|
||||||
which are suitable for <quote>weekend hackers</quote>.</para>
|
which are suitable for <quote>weekend hackers</quote>.</para>
|
||||||
|
|
||||||
<orderedlist>
|
<orderedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>If you run FreeBSD-current and have a good Internet
|
<para>If you run FreeBSD-current and have a good Internet
|
||||||
connection, there is a machine <hostid
|
connection, there is a machine <hostid
|
||||||
role="fqdn">current.FreeBSD.org</hostid> which builds a full
|
role="fqdn">current.FreeBSD.org</hostid> which builds a
|
||||||
release once a day—every now and again, try to install
|
full release once a day—every now and again, try to
|
||||||
the latest release from it and report any failures in the
|
install the latest release from it and report any failures
|
||||||
process.</para>
|
in the process.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Read the freebsd-bugs mailing list. There might be a
|
<para>Read the freebsd-bugs mailing list. There might be a
|
||||||
problem you can comment constructively on or with patches you
|
problem you can comment constructively on or with patches
|
||||||
can test. Or you could even try to fix one of the problems
|
you can test. Or you could even try to fix one of the
|
||||||
yourself.</para>
|
problems yourself.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>If you know of any bug fixes which have been successfully
|
<para>If you know of any bug fixes which have been
|
||||||
applied to -current but have not been merged into -stable after a
|
successfully applied to -current but have not been merged
|
||||||
decent interval (normally a couple of weeks), send the committer a
|
into -stable after a decent interval (normally a couple of
|
||||||
polite reminder.</para>
|
weeks), send the committer a polite reminder.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Move contributed software to <filename>src/contrib</filename>
|
<para>Move contributed software to
|
||||||
in the source tree.</para>
|
<filename>src/contrib</filename> in the source
|
||||||
|
tree.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Make sure code in <filename>src/contrib</filename> is up to
|
<para>Make sure code in <filename>src/contrib</filename> is
|
||||||
date.</para>
|
up to date.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Build the source tree (or just part of it) with extra warnings
|
<para>Build the source tree (or just part of it) with extra
|
||||||
enabled and clean up the warnings.</para>
|
warnings enabled and clean up the warnings.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
|
|
@ -168,9 +171,9 @@ FreeBSD Entities//EN"> %freebsd;
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>If you have contributed any ports, send your patches back to
|
<para>If you have contributed any ports, send your patches
|
||||||
the original author (this will make your life easier when they
|
back to the original author (this will make your life
|
||||||
bring out the next version)</para>
|
easier when they bring out the next version)</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
|
|
@ -183,114 +186,124 @@ FreeBSD Entities//EN"> %freebsd;
|
||||||
<title>Work through the PR Database</title>
|
<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 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 anything there takes your
|
|
||||||
interest. Some of these might be very simple tasks that just need an
|
|
||||||
extra pair of eyes to look over them and confirm that the fix in the
|
|
||||||
PR is a good one. Others might be much more complex, or might not
|
|
||||||
even have a fix included at all.</para>
|
|
||||||
|
|
||||||
<para>Start with the PRs that have not been assigned to anyone else.
|
<para>The <ulink
|
||||||
If a PR is assigned to someone else, but it looks like something
|
url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi">FreeBSD
|
||||||
you can handle, email the person it is assigned to and ask if you can
|
PR list</ulink> shows all the current active problem reports
|
||||||
work on it—they might already have a patch ready to be tested,
|
and requests for enhancement that have been submitted by
|
||||||
or further ideas that you can discuss with them.</para>
|
FreeBSD users. The PR database includes both programmer and
|
||||||
|
non-programmer tasks. Look through the open PRs, and see if
|
||||||
|
anything there takes your interest. Some of these might be
|
||||||
|
very simple tasks that just need an extra pair of eyes to look
|
||||||
|
over them and confirm that the fix in the PR is a good one.
|
||||||
|
Others might be much more complex, or might not even have a
|
||||||
|
fix included at all.</para>
|
||||||
|
|
||||||
|
<para>Start with the PRs that have not been assigned to anyone
|
||||||
|
else. If a PR is assigned to someone else, but it looks like
|
||||||
|
something you can handle, email the person it is assigned to
|
||||||
|
and ask if you can work on it—they might already have a
|
||||||
|
patch ready to be tested, or further ideas that you can
|
||||||
|
discuss with them.</para>
|
||||||
</sect2>
|
</sect2>
|
||||||
</sect1>
|
</sect1>
|
||||||
|
|
||||||
<sect1 id="contrib-how">
|
<sect1 id="contrib-how">
|
||||||
<title>How to Contribute</title>
|
<title>How to Contribute</title>
|
||||||
|
|
||||||
<para>Contributions to the system generally fall into one or more of the
|
<para>Contributions to the system generally fall into one or more
|
||||||
following 5 categories:</para>
|
of the following 5 categories:</para>
|
||||||
|
|
||||||
<sect2 id="contrib-general">
|
<sect2 id="contrib-general">
|
||||||
<title>Bug Reports and General Commentary</title>
|
<title>Bug Reports and General Commentary</title>
|
||||||
|
|
||||||
<para>An idea or suggestion of <emphasis>general</emphasis> technical
|
<para>An idea or suggestion of <emphasis>general</emphasis>
|
||||||
interest should be mailed to the &a.hackers;. Likewise, people with
|
technical interest should be mailed to the &a.hackers;.
|
||||||
an interest in such things (and a tolerance for a
|
Likewise, people with an interest in such things (and a
|
||||||
<emphasis>high</emphasis> volume of mail!) may subscribe to the
|
tolerance for a <emphasis>high</emphasis> volume of mail!) may
|
||||||
hackers mailing list by sending mail to &a.majordomo;. See <ulink
|
subscribe to the hackers mailing list by sending mail to
|
||||||
|
&a.majordomo;. See <ulink
|
||||||
url="../../books/handbook/eresources.html#ERESOURCES-MAIL">The
|
url="../../books/handbook/eresources.html#ERESOURCES-MAIL">The
|
||||||
FreeBSD Handbook</ulink> for more information
|
FreeBSD Handbook</ulink> for more information about this and
|
||||||
about this and other mailing lists.</para>
|
other mailing lists.</para>
|
||||||
|
|
||||||
<para>If you find a bug or are submitting a specific change, please
|
<para>If you find a bug or are submitting a specific change,
|
||||||
report it using the &man.send-pr.1; program or its <ulink
|
please report it using the &man.send-pr.1; program or its
|
||||||
url="../../../../send-pr.html">WEB-based
|
<ulink url="../../../../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
|
||||||
Unless they exceed 65KB, include any patches directly in the report.
|
report. Unless they exceed 65KB, include any patches directly
|
||||||
If the patch is suitable to be applied to the source tree put
|
in the report. If the patch is suitable to be applied to the
|
||||||
<literal>[PATCH]</literal> in the synopsis of the report.
|
source tree put <literal>[PATCH]</literal> in the synopsis of
|
||||||
When including patches, <emphasis>do not</emphasis> use cut-and-paste
|
the report. When including patches, <emphasis>do
|
||||||
because cut-and-paste turns tabs into spaces and makes them unusable.
|
not</emphasis> use cut-and-paste because cut-and-paste turns
|
||||||
Consider compressing patches and using &man.uuencode.1; if they exceed
|
tabs into spaces and makes them unusable. Consider
|
||||||
|
compressing patches and using &man.uuencode.1; if they exceed
|
||||||
20KB. Upload very large submissions to <ulink
|
20KB. Upload very large submissions to <ulink
|
||||||
url="ftp://ftp.FreeBSD.org/pub/FreeBSD/incoming/">ftp.FreeBSD.org:/pub/FreeBSD/incoming/</ulink>.</para>
|
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
|
<para>After filing a report, you should receive confirmation
|
||||||
a tracking number. Keep this tracking number so that you can update
|
along with a tracking number. Keep this tracking number so
|
||||||
us with details about the problem by sending mail to
|
that you can update us with details about the problem by
|
||||||
<email>bug-followup@FreeBSD.org</email>. Use the number as the
|
sending mail to <email>bug-followup@FreeBSD.org</email>. Use
|
||||||
message subject, e.g. <literal>"Re: kern/3377"</literal>. Additional
|
the number as the message subject, e.g. <literal>"Re:
|
||||||
information for any bug report should be submitted this way.</para>
|
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 reason,
|
<para>If you do not receive confirmation in a timely fashion (3
|
||||||
unable to use the &man.send-pr.1; command, then you may ask
|
days to a week, depending on your email connection) or are,
|
||||||
someone to file it for you by sending mail to the &a.bugs;.</para>
|
for some reason, unable to use the &man.send-pr.1; command,
|
||||||
|
then you may ask someone to file it for you by sending mail to
|
||||||
|
the &a.bugs;.</para>
|
||||||
|
|
||||||
<para>See also <ulink
|
<para>See also <ulink
|
||||||
URL="../../articles/problem-reports/article.html">this
|
URL="../../articles/problem-reports/article.html">this
|
||||||
article</ulink> on how to write good problem reports.</para>
|
article</ulink> on how to write good problem reports.</para>
|
||||||
</sect2>
|
</sect2>
|
||||||
|
|
||||||
<sect2>
|
<sect2>
|
||||||
<title>Changes to the Documentation</title>
|
<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
|
<para>Changes to the documentation are overseen by the &a.doc;.
|
||||||
url="../../books/fdp-primer/index.html">FreeBSD
|
Please look at the <ulink
|
||||||
Documentation Project Primer</ulink> for complete instructions.
|
url="../../books/fdp-primer/index.html">FreeBSD Documentation
|
||||||
Send
|
Project Primer</ulink> for complete instructions. Send
|
||||||
submissions and changes (even small ones are welcome!) using
|
submissions and changes (even small ones are welcome!) using
|
||||||
<command>send-pr</command> as described in <link
|
<command>send-pr</command> as described in <link
|
||||||
linkend="contrib-general">Bug Reports and General
|
linkend="contrib-general">Bug Reports and General
|
||||||
Commentary</link>.</para>
|
Commentary</link>.</para>
|
||||||
</sect2>
|
</sect2>
|
||||||
|
|
||||||
<sect2>
|
<sect2>
|
||||||
<title>Changes to Existing Source Code</title>
|
<title>Changes to Existing Source Code</title>
|
||||||
|
|
||||||
<indexterm><primary>FreeBSD-current</primary></indexterm>
|
<indexterm><primary>FreeBSD-current</primary></indexterm>
|
||||||
<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
|
<para>An addition or change to the existing source code is a
|
||||||
the current state of FreeBSD development. There is a special
|
somewhat trickier affair and depends a lot on how far out of
|
||||||
on-going release of FreeBSD known as <quote>FreeBSD-current</quote>
|
date you are with the current state of FreeBSD
|
||||||
which is made available in a variety of ways for the convenience of
|
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="
|
developers working actively on the system. See <ulink url="
|
||||||
../../books/handbook/current-stable.html">The
|
../../books/handbook/current-stable.html">The FreeBSD
|
||||||
FreeBSD Handbook</ulink> for more
|
Handbook</ulink> for more information about getting and using
|
||||||
information about getting and using FreeBSD-current.</para>
|
FreeBSD-current.</para>
|
||||||
|
|
||||||
<para>Working from older sources unfortunately means that your changes
|
<para>Working from older sources unfortunately means that your
|
||||||
may sometimes be too obsolete or too divergent for easy re-integration
|
changes may sometimes be too obsolete or too divergent for
|
||||||
into FreeBSD. Chances of this can be minimized somewhat by
|
easy re-integration into FreeBSD. Chances of this can be
|
||||||
subscribing to the &a.announce; and the &a.current; lists, where
|
minimized somewhat by subscribing to the &a.announce; and the
|
||||||
discussions on the current state of the system take place.</para>
|
&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
|
<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
|
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;
|
send to the FreeBSD maintainers. This is done with the &man.diff.1;
|
||||||
command, with the <quote>context diff</quote> form
|
command, with the <quote>context diff</quote> form
|
||||||
being preferred. For example:</para>
|
being preferred. For example:</para>
|
||||||
|
|
||||||
<indexterm>
|
<indexterm>
|
||||||
<primary><command>diff</command></primary>
|
<primary><command>diff</command></primary>
|
||||||
</indexterm>
|
</indexterm>
|
||||||
|
|
@ -300,100 +313,107 @@ FreeBSD Entities//EN"> %freebsd;
|
||||||
or
|
or
|
||||||
|
|
||||||
<screen>&prompt.user; <userinput>diff -c -r olddir newdir</userinput></screen>
|
<screen>&prompt.user; <userinput>diff -c -r olddir newdir</userinput></screen>
|
||||||
|
|
||||||
would generate such a set of context diffs for the given source file
|
would generate such a set of context diffs for the given
|
||||||
or directory hierarchy. See the man page for &man.diff.1; for more
|
source file or directory hierarchy. See the man page for
|
||||||
details.</para>
|
&man.diff.1; for more details.</para>
|
||||||
|
|
||||||
<para>Once you have a set of diffs (which you may test with the
|
<para>Once you have a set of diffs (which you may test with the
|
||||||
&man.patch.1; command), you should submit them for inclusion with
|
&man.patch.1; command), you should submit them for inclusion
|
||||||
FreeBSD. Use the &man.send-pr.1; program as described in <link
|
with FreeBSD. Use the &man.send-pr.1; program as described in
|
||||||
linkend="contrib-general">Bug Reports and General Commentary</link>.
|
<link linkend="contrib-general">Bug Reports and General
|
||||||
<emphasis>Do not</emphasis> just send the diffs to the &a.hackers; or
|
Commentary</link>. <emphasis>Do not</emphasis> just send the
|
||||||
they will get lost! We greatly appreciate your submission (this is a
|
diffs to the &a.hackers; or they will get lost! We greatly
|
||||||
volunteer project!); because we are busy, we may not be able to
|
appreciate your submission (this is a volunteer project!);
|
||||||
address it immediately, but it will remain in the PR database until we
|
because we are busy, we may not be able to address it
|
||||||
do. Indicate your submission by including <literal>[PATCH]</literal>
|
immediately, but it will remain in the PR database until we
|
||||||
in the synopsis of the report.</para>
|
do. Indicate your submission by including
|
||||||
|
<literal>[PATCH]</literal> in the synopsis of the
|
||||||
|
report.</para>
|
||||||
|
|
||||||
<indexterm>
|
<indexterm>
|
||||||
<primary><command>uuencode</command></primary>
|
<primary><command>uuencode</command></primary>
|
||||||
</indexterm>
|
</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. Shar archives are also
|
|
||||||
welcome.</para>
|
|
||||||
|
|
||||||
<para>If your change is of a potentially sensitive nature, e.g. you are
|
<para>If you feel it appropriate (e.g. you have added, deleted,
|
||||||
unsure of copyright issues governing its further distribution or you
|
or renamed files), bundle your changes into a
|
||||||
are simply not ready to release it without a tighter review first,
|
<command>tar</command> file and run the &man.uuencode.1;
|
||||||
then you should send it to &a.core; directly rather than submitting it
|
program on it. Shar archives are also welcome.</para>
|
||||||
with &man.send-pr.1;. The core mailing list reaches a much smaller
|
|
||||||
group of people who do much of the day-to-day work on FreeBSD. Note
|
<para>If your change is of a potentially sensitive nature,
|
||||||
that this group is also <emphasis>very busy</emphasis> and so you
|
e.g. you are unsure of copyright issues governing its further
|
||||||
should only send mail to them where it is truly necessary.</para>
|
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 &man.send-pr.1;. 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 <emphasis>very busy</emphasis> and so you should
|
||||||
|
only send mail to them where it is truly necessary.</para>
|
||||||
|
|
||||||
<para>Please refer to &man.intro.9; and &man.style.9; style for
|
<para>Please refer to &man.intro.9; and &man.style.9; style for
|
||||||
some information on coding style. We would appreciate it if you
|
some information on coding style. We would appreciate it if
|
||||||
were at least aware of this information before submitting
|
you were at least aware of this information before submitting
|
||||||
code.</para>
|
code.</para>
|
||||||
</sect2>
|
</sect2>
|
||||||
|
|
||||||
<sect2>
|
<sect2>
|
||||||
<title>New Code or Major Value-Added Packages</title>
|
<title>New Code or Major Value-Added Packages</title>
|
||||||
|
|
||||||
<para>In the case of a significant contribution of a large body
|
<para>In the case of a significant contribution of a large body
|
||||||
work, or the addition of an important new feature to FreeBSD, it
|
work, or the addition of an important new feature to FreeBSD,
|
||||||
becomes almost always necessary to either send changes as uuencoded
|
it becomes almost always necessary to either send changes as
|
||||||
tar files or upload them to a web or FTP site for other people to
|
uuencoded tar files or upload them to a web or FTP site for
|
||||||
access. If you do not have access to a web or FTP site, ask on an
|
other people to access. If you do not have access to a web or
|
||||||
appropriate FreeBSD mailing list for someone to host the changes for
|
FTP site, ask on an appropriate FreeBSD mailing list for
|
||||||
you.</para>
|
someone to host the changes for you.</para>
|
||||||
|
|
||||||
<para>When working with large amounts of code, the touchy subject of
|
<para>When working with large amounts of code, the touchy
|
||||||
copyrights also invariably comes up. Acceptable copyrights for code
|
subject of copyrights also invariably comes up. Acceptable
|
||||||
included in FreeBSD are:</para>
|
copyrights for code included in FreeBSD are:</para>
|
||||||
|
|
||||||
<orderedlist>
|
<orderedlist>
|
||||||
<indexterm><primary>BSD copyright</primary></indexterm>
|
<indexterm><primary>BSD copyright</primary></indexterm>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>The BSD copyright. This copyright is most preferred due to
|
<para>The BSD copyright. This copyright is most preferred
|
||||||
its <quote>no strings attached</quote> nature and general
|
due to its <quote>no strings attached</quote> nature and
|
||||||
attractiveness to commercial enterprises. Far from discouraging
|
general attractiveness to commercial enterprises. Far
|
||||||
such commercial use, the FreeBSD Project actively encourages such
|
from discouraging such commercial use, the FreeBSD Project
|
||||||
participation by commercial interests who might eventually be
|
actively encourages such participation by commercial
|
||||||
inclined to invest something of their own into FreeBSD.</para>
|
interests who might eventually be inclined to invest
|
||||||
|
something of their own into FreeBSD.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<indexterm><primary>GPL</primary><see>GNU General Public License</see></indexterm>
|
<indexterm><primary>GPL</primary><see>GNU General Public License</see></indexterm>
|
||||||
<indexterm><primary>GNU General Public License</primary></indexterm>
|
<indexterm><primary>GNU General Public License</primary></indexterm>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>The GNU General Public License, or <quote>GPL</quote>.
|
<para>The GNU General Public License, or <quote>GPL</quote>.
|
||||||
This license is not quite as popular with us due to the amount
|
This license is not quite as popular with us due to the
|
||||||
of extra effort demanded of anyone using the code for
|
amount of extra effort demanded of anyone using the code
|
||||||
commercial purposes, but given the sheer quantity of GPL'd code
|
for commercial purposes, but given the sheer quantity of
|
||||||
we currently require (compiler, assembler, text formatter, etc)
|
GPL'd code we currently require (compiler, assembler, text
|
||||||
it would be silly to refuse additional contributions under this
|
formatter, etc) it would be silly to refuse additional
|
||||||
license. Code under the GPL also goes into a different part of
|
contributions under this license. Code under the GPL also
|
||||||
the tree, that being <filename>/sys/gnu</filename> or
|
goes into a different part of the tree, that being
|
||||||
|
<filename>/sys/gnu</filename> or
|
||||||
<filename>/usr/src/gnu</filename>, and is therefore easily
|
<filename>/usr/src/gnu</filename>, and is therefore easily
|
||||||
identifiable to anyone for whom the GPL presents a
|
identifiable to anyone for whom the GPL presents a
|
||||||
problem.</para>
|
problem.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</orderedlist>
|
</orderedlist>
|
||||||
|
|
||||||
<para>Contributions coming under any other type of copyright must be
|
<para>Contributions coming under any other type of copyright
|
||||||
carefully reviewed before their inclusion into FreeBSD will be
|
must be carefully reviewed before their inclusion into FreeBSD
|
||||||
considered. Contributions for which particularly restrictive
|
will be considered. Contributions for which particularly
|
||||||
commercial copyrights apply are generally rejected, though the authors
|
restrictive commercial copyrights apply are generally
|
||||||
are always encouraged to make such changes available through their own
|
rejected, though the authors are always encouraged to make
|
||||||
channels.</para>
|
such changes available through their own channels.</para>
|
||||||
|
|
||||||
<para>To place a <quote>BSD-style</quote> copyright on your work, include
|
<para>To place a <quote>BSD-style</quote> copyright on your
|
||||||
the following text at the very beginning of every source code file you
|
work, include the following text at the very beginning of
|
||||||
wish to protect, replacing the text between the <literal>%%</literal>
|
every source code file you wish to protect, replacing the text
|
||||||
with the appropriate information.</para>
|
between the <literal>%%</literal> with the appropriate
|
||||||
|
information.</para>
|
||||||
|
|
||||||
<programlisting>Copyright (c) %%proper_years_here%%
|
<programlisting>Copyright (c) %%proper_years_here%%
|
||||||
%%your_name_here%%, %%your_state%% %%your_zip%%.
|
%%your_name_here%%, %%your_state%% %%your_zip%%.
|
||||||
All rights reserved.
|
All rights reserved.
|
||||||
|
|
@ -418,31 +438,32 @@ DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
||||||
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
$Id$</programlisting>
|
$Id$</programlisting>
|
||||||
|
|
||||||
<para>For your convenience, a copy of this text can be found in
|
<para>For your convenience, a copy of this text can be found in
|
||||||
<filename>/usr/share/examples/etc/bsd-style-copyright</filename>.</para>
|
<filename>/usr/share/examples/etc/bsd-style-copyright</filename>.</para>
|
||||||
</sect2>
|
</sect2>
|
||||||
|
|
||||||
<sect2>
|
<sect2>
|
||||||
<title>Money, Hardware or Internet Access</title>
|
<title>Money, Hardware or Internet Access</title>
|
||||||
|
|
||||||
<para>We are always very happy to accept donations to further the cause
|
<para>We are always very happy to accept donations to further
|
||||||
of the FreeBSD Project and, in a volunteer effort like ours, a little
|
the cause of the FreeBSD Project and, in a volunteer effort
|
||||||
can go a long way! Donations of hardware are also very important to
|
like ours, a little can go a long way! Donations of hardware
|
||||||
expanding our list of supported peripherals since we generally lack
|
are also very important to expanding our list of supported
|
||||||
the funds to buy such items ourselves.</para>
|
peripherals since we generally lack the funds to buy such
|
||||||
|
items ourselves.</para>
|
||||||
|
|
||||||
<sect3>
|
<sect3>
|
||||||
<title><anchor id="donations">Donating Funds</title>
|
<title><anchor id="donations">Donating Funds</title>
|
||||||
|
|
||||||
<para>The FreeBSD Foundation is a non-profit, tax-exempt
|
<para>The FreeBSD Foundation is a non-profit, tax-exempt
|
||||||
foundation established to further the goals of the FreeBSD
|
foundation established to further the goals of the FreeBSD
|
||||||
Project. As a 501(c)3 entity, the Foundation is generally
|
Project. As a 501(c)3 entity, the Foundation is generally
|
||||||
exempt from US federal income tax as well as Colorado
|
exempt from US federal income tax as well as Colorado State
|
||||||
State income tax. Donations to a tax-exempt entity are
|
income tax. Donations to a tax-exempt entity are often
|
||||||
often deductible from taxable federal income.</para>
|
deductible from taxable federal income.</para>
|
||||||
|
|
||||||
<para>Donations may be sent in check form to:
|
<para>Donations may be sent in check form to:
|
||||||
<address>
|
<address>
|
||||||
|
|
@ -466,38 +487,41 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
the Foundation by email, write to
|
the Foundation by email, write to
|
||||||
<email>bod@FreeBSDFoundation.org</email>.</para>
|
<email>bod@FreeBSDFoundation.org</email>.</para>
|
||||||
</sect3>
|
</sect3>
|
||||||
|
|
||||||
<sect3>
|
<sect3>
|
||||||
<title>Donating Hardware</title>
|
<title>Donating Hardware</title>
|
||||||
<indexterm><primary>donations</primary></indexterm>
|
<indexterm><primary>donations</primary></indexterm>
|
||||||
|
|
||||||
<para>Donations of hardware in any of the 3 following categories are
|
<para>Donations of hardware in any of the 3 following
|
||||||
also gladly accepted by the FreeBSD Project:</para>
|
categories are also gladly accepted by the FreeBSD
|
||||||
|
Project:</para>
|
||||||
|
|
||||||
<itemizedlist>
|
<itemizedlist>
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>General purpose hardware such as disk drives, memory or
|
<para>General purpose hardware such as disk drives, memory
|
||||||
complete systems should be sent to the FreeBSD, Inc. address
|
or complete systems should be sent to the FreeBSD,
|
||||||
listed in the <emphasis>donating funds</emphasis>
|
Inc. address listed in the <emphasis>donating
|
||||||
section.</para>
|
funds</emphasis> section.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Hardware for which ongoing compliance testing is desired.
|
<para>Hardware for which ongoing compliance testing is
|
||||||
We are currently trying to put together a testing lab of all
|
desired. We are currently trying to put together a
|
||||||
components that FreeBSD supports so that proper regression
|
testing lab of all components that FreeBSD supports so
|
||||||
testing can be done with each new release. We are still lacking
|
that proper regression testing can be done with each new
|
||||||
many important pieces (network cards, motherboards, etc) and if
|
release. We are still lacking many important pieces
|
||||||
you would like to make such a donation, please contact &a.dg;
|
(network cards, motherboards, etc) and if you would like
|
||||||
for information on which items are still required.</para>
|
to make such a donation, please contact &a.dg; for
|
||||||
|
information on which items are still required.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
|
|
||||||
<listitem>
|
<listitem>
|
||||||
<para>Hardware currently unsupported by FreeBSD for which you
|
<para>Hardware currently unsupported by FreeBSD for which
|
||||||
would like to see such support added. Please contact the
|
you would like to see such support added. Please
|
||||||
&a.core; before sending such items as we will need to find a
|
contact the &a.core; before sending such items as we
|
||||||
developer willing to take on the task before we can accept
|
will need to find a developer willing to take on the
|
||||||
delivery of new hardware.</para>
|
task before we can accept delivery of new
|
||||||
|
hardware.</para>
|
||||||
</listitem>
|
</listitem>
|
||||||
</itemizedlist>
|
</itemizedlist>
|
||||||
</sect3>
|
</sect3>
|
||||||
|
|
@ -506,12 +530,13 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
<title>Donating Internet Access</title>
|
<title>Donating Internet Access</title>
|
||||||
|
|
||||||
<para>We can always use new mirror sites for FTP, WWW or
|
<para>We can always use new mirror sites for FTP, WWW or
|
||||||
<command>cvsup</command>. If you would like to be such a mirror,
|
<command>cvsup</command>. If you would like to be such a
|
||||||
please contact the &a.hubs; for more information.</para>
|
mirror, please contact the &a.hubs; for more
|
||||||
|
information.</para>
|
||||||
</sect3>
|
</sect3>
|
||||||
</sect2>
|
</sect2>
|
||||||
</sect1>
|
</sect1>
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue