Date: Wed, 24 Jul 2013 00:16:06 +0000 (UTC) From: Warren Block <wblock@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42405 - head/en_US.ISO8859-1/articles/contributing Message-ID: <201307240016.r6O0G6EF022372@svn.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: wblock Date: Wed Jul 24 00:16:05 2013 New Revision: 42405 URL: http://svnweb.freebsd.org/changeset/doc/42405 Log: Whitespace-only fixes. Translators, please ignore. Modified: head/en_US.ISO8859-1/articles/contributing/article.xml Modified: head/en_US.ISO8859-1/articles/contributing/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/contributing/article.xml Tue Jul 23 20:38:02 2013 (r42404) +++ head/en_US.ISO8859-1/articles/contributing/article.xml Wed Jul 24 00:16:05 2013 (r42405) @@ -85,8 +85,8 @@ <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 - (Docbook is not difficult to learn, but there is no objection - to ASCII submissions).</para> + (Docbook is not difficult to learn, but there is no + objection to ASCII submissions).</para> </listitem> <listitem> @@ -95,8 +95,8 @@ language, you can help translate additional documents or verify that the translations are up-to-date. First take a look at the <ulink - url="&url.books.fdp-primer;/translations.html">Translations - FAQ</ulink> in the FreeBSD Documentation Project Primer. + url="&url.books.fdp-primer;/translations.html">Translations + FAQ</ulink> in the FreeBSD Documentation Project Primer. You are not committing yourself to translating every single FreeBSD document by doing this — as a volunteer, you can do as much or as little translation as @@ -107,12 +107,12 @@ </listitem> <listitem> - <para>Read the &a.questions; and &ng.misc; - occasionally (or even 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> + <para>Read the &a.questions; and &ng.misc; occasionally (or + even 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> </listitem> </orderedlist> </sect2> @@ -123,24 +123,24 @@ <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> + useful tasks which are suitable for + <quote>weekend hackers</quote>.</para> <orderedlist> <listitem> <para>If you run FreeBSD-CURRENT and have a good Internet - connection, there is a machine <hostid - role="fqdn">current.FreeBSD.org</hostid> which builds a - full release once a day—every now and again, try to - install the latest release from it and report any failures - in the process.</para> + connection, there is a machine + <hostid role="fqdn">current.FreeBSD.org</hostid> which + builds a full release once a day—every now and + again, try to install the latest release from it and + report any failures in the process.</para> </listitem> <listitem> - <para>Read the &a.bugs;. 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 - problems yourself.</para> + <para>Read the &a.bugs;. 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 problems + yourself.</para> </listitem> <listitem> @@ -175,22 +175,22 @@ <listitem> <para>If you have contributed any ports and you had to make - &os;-specific changes, send your patches - back to the original authors (this will make your life - easier when they bring out the next version).</para> + &os;-specific changes, send your patches back to the + original authors (this will make your life easier when + they bring out the next version).</para> </listitem> <listitem> <para>Get copies of formal standards like &posix;. You can - 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 - 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 - wrong, ask the standards body to consider the + 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 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 wrong, ask the standards body to consider the question.</para> </listitem> @@ -232,12 +232,11 @@ page</title> <para>The <ulink url="http://wiki.freebsd.org/IdeasPage">&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> + 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> </sect2> </sect1> @@ -254,33 +253,33 @@ 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 &a.hackers;. - See <ulink - url="&url.books.handbook;/eresources.html#ERESOURCES-MAIL">The - FreeBSD Handbook</ulink> for more information about this and + subscribe to the &a.hackers;. See <ulink + url="&url.books.handbook;/eresources.html#ERESOURCES-MAIL">The + FreeBSD Handbook</ulink> 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 &man.send-pr.1; program or its <ulink url="&url.base;/send-pr.html">WEB-based - equivalent</ulink>. Try to fill-in each field of the bug + equivalent</ulink>. Try to fill-in each field of the bug report. Unless they exceed 65KB, include any patches directly 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> + 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> <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 &a.bugfollowup;. 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> + sending mail to &a.bugfollowup;. 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, @@ -290,7 +289,8 @@ <para>See also <ulink url="&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> @@ -317,14 +317,14 @@ <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 - 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> + date you are with the current state 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> <para>Working from older sources unfortunately means that your changes may sometimes be too obsolete or too divergent for @@ -339,8 +339,8 @@ 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>.</para> + is the unified output format generated by + <command>diff -u</command>.</para> <indexterm> <primary><command>diff</command></primary> @@ -380,14 +380,14 @@ program on it. Archives created with &man.shar.1; are also welcome.</para> - <para>If your change is of a potentially sensitive nature, - such as if you are unsure of copyright issues governing its further - distribution then you should send it to &a.core; - directly rather than submitting it with &man.send-pr.1;. The - &a.core; 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>If your change is of a potentially sensitive nature, such + as if you are unsure of copyright issues governing its further + distribution then you should send it to &a.core; directly + rather than submitting it with &man.send-pr.1;. The &a.core; + 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; for some information on coding style. We would appreciate it if @@ -412,27 +412,27 @@ <orderedlist> <listitem> - <para>The BSD copyright<indexterm><primary>BSD copyright</primary> - </indexterm>. This copyright is most preferred - due to its <quote>no strings attached</quote> nature and - general 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 - something of their own into FreeBSD.</para> + <para>The BSD copyright<indexterm><primary>BSD + copyright</primary></indexterm>. This copyright is most + preferred due to its <quote>no strings attached</quote> + nature and general 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 something of their own into FreeBSD.</para> </listitem> <listitem> <para> - <indexterm> - <primary>GPL</primary> - <see>GNU General Public License</see> - </indexterm> - - <indexterm> - <primary>GNU General Public License</primary> - </indexterm> - The GNU General Public License, or <quote>GPL</quote>. + <indexterm> + <primary>GPL</primary> + <see>GNU General Public License</see> + </indexterm> + + <indexterm> + <primary>GNU General Public License</primary> + </indexterm> + The GNU General Public License, or <quote>GPL</quote>. 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 @@ -536,6 +536,7 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE PO <sect3> <title>Donating Hardware</title> + <indexterm><primary>donations</primary></indexterm> <para>The FreeBSD Project happily accepts donations of @@ -546,5 +547,4 @@ THIS SOFTWARE, EVEN IF ADVISED OF THE PO </sect3> </sect2> </sect1> - </article>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201307240016.r6O0G6EF022372>