From owner-p4-projects@FreeBSD.ORG Sun Feb 12 11:07:28 2012 Return-Path: Delivered-To: p4-projects@freebsd.org Received: by hub.freebsd.org (Postfix, from userid 32767) id DB25C1065673; Sun, 12 Feb 2012 11:07:27 +0000 (UTC) Delivered-To: perforce@FreeBSD.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id 91072106564A for ; Sun, 12 Feb 2012 11:07:27 +0000 (UTC) (envelope-from rene@FreeBSD.org) Received: from skunkworks.freebsd.org (skunkworks.freebsd.org [IPv6:2001:4f8:fff6::2d]) by mx1.freebsd.org (Postfix) with ESMTP id 7BE2B8FC12 for ; Sun, 12 Feb 2012 11:07:27 +0000 (UTC) Received: from skunkworks.freebsd.org (localhost [127.0.0.1]) by skunkworks.freebsd.org (8.14.4/8.14.4) with ESMTP id q1CB7RZA055226 for ; Sun, 12 Feb 2012 11:07:27 GMT (envelope-from rene@FreeBSD.org) Received: (from perforce@localhost) by skunkworks.freebsd.org (8.14.4/8.14.4/Submit) id q1CB7RKF055223 for perforce@freebsd.org; Sun, 12 Feb 2012 11:07:27 GMT (envelope-from rene@FreeBSD.org) Date: Sun, 12 Feb 2012 11:07:27 GMT Message-Id: <201202121107.q1CB7RKF055223@skunkworks.freebsd.org> X-Authentication-Warning: skunkworks.freebsd.org: perforce set sender to rene@FreeBSD.org using -f From: Rene Ladan To: Perforce Change Reviews Precedence: bulk Cc: Subject: PERFORCE change 206164 for review X-BeenThere: p4-projects@freebsd.org X-Mailman-Version: 2.1.5 List-Id: p4 projects tree changes List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Sun, 12 Feb 2012 11:07:28 -0000 http://p4web.freebsd.org/@@206164?ac=10 Change 206164 by rene@rene_acer on 2012/02/12 11:06:49 IFC Affected files ... .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/contributing/article.sgml#4 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/contributors/contrib.additional.sgml#125 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/contributors/contrib.committers.sgml#75 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/cups/article.sgml#5 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/dialup-firewall/article.sgml#3 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/articles/releng/article.sgml#10 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/book.sgml#5 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml#3 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/sgml-primer/chapter.sgml#6 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/tools/chapter.sgml#6 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/book.sgml#9 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/boot/chapter.sgml#10 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/bsdinstall/chapter.sgml#12 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/desktop/chapter.sgml#33 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/disks/chapter.sgml#24 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/filesystems/chapter.sgml#10 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/geom/chapter.sgml#12 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/install/chapter.sgml#26 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/kernelconfig/chapter.sgml#16 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/linuxemu/chapter.sgml#12 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/mail/chapter.sgml#9 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/printing/chapter.sgml#9 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/handbook/x11/chapter.sgml#22 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/books/porters-handbook/book.sgml#129 integrate .. //depot/projects/docproj_nl/en_US.ISO8859-1/share/sgml/authors.ent#68 integrate .. //depot/projects/docproj_nl/share/mk/doc.common.mk#3 integrate .. //depot/projects/docproj_nl/share/pgpkeys/hrs.key#2 integrate .. //depot/projects/docproj_nl/share/pgpkeys/matthew.key#1 branch .. //depot/projects/docproj_nl/share/pgpkeys/pgpkeys-developers.sgml#69 integrate .. //depot/projects/docproj_nl/share/pgpkeys/pgpkeys.ent#66 integrate .. //depot/projects/docproj_nl/www/en/developers.sgml#69 integrate .. //depot/projects/docproj_nl/www/en/ports/index.sgml#2 integrate .. //depot/projects/docproj_nl/www/en/ports/references.sgml#2 integrate .. //depot/projects/docproj_nl/www/share/sgml/news.xml#130 integrate Differences ... ==== //depot/projects/docproj_nl/en_US.ISO8859-1/articles/contributing/article.sgml#4 (text+ko) ==== @@ -8,12 +8,12 @@ Contributing to FreeBSD - $FreeBSD: doc/en_US.ISO8859-1/articles/contributing/article.sgml,v 1.511 2009/05/13 02:05:11 keramida Exp $ + $FreeBSD: doc/en_US.ISO8859-1/articles/contributing/article.sgml,v 1.512 2012/02/07 22:08:33 wblock Exp $ This article describes the different ways in which an - individual or organization may contribute to the FreeBSD - Project. + individual or organization may contribute to the FreeBSD + Project. @@ -67,7 +67,7 @@ What Is Needed - + The following list of tasks and sub-projects represents something of an amalgam of various TODO lists and user requests. @@ -119,11 +119,13 @@ - Ongoing Programmer Tasks - 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 weekend hackers. + Ongoing Programmer Tasks + + 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 weekend + hackers. @@ -151,13 +153,14 @@ Move contributed software to - src/contrib in the source - tree. + src/contrib in the + source tree. - Make sure code in src/contrib is - up to date. + Make sure code in + src/contrib is up + to date. @@ -183,8 +186,8 @@ get some links about these standards at the FreeBSD C99 & POSIX Standards Conformance Project 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 @@ Work through the PR Database - problem reports database + + problem reports database + The FreeBSD - PR list shows all the current active problem reports + url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi">FreeBSD + PR list 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 @@ - Pick one of the items from the <quote>Ideas</quote> page + Pick one of the items from the <quote>Ideas</quote> + page The &os; list of - projects and ideas for volunteers 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. + projects and ideas for volunteers 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. @@ -261,11 +268,11 @@ in the report. If the patch is suitable to be applied to the source tree put [PATCH] in the synopsis of the report. When including patches, do - not 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. + not 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. 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;. See also this - article on how to write good problem reports. + url="&url.articles.problem-reports;/article.html">this + article on how to write good problem reports. Changes to the Documentation - documentation submissions + + documentation submissions + Changes to the documentation are overseen by the &a.doc;. - Please look at the FreeBSD Documentation - Project Primer for complete instructions. Send - submissions and changes (even small ones are welcome!) using - &man.send-pr.1; as described in Bug Reports and General - Commentary. + Please look at the + FreeBSD + Documentation Project Primer for complete + instructions. Send submissions and changes (even small ones + are welcome!) using &man.send-pr.1; as described in + Bug Reports and General + Commentary. @@ -309,13 +318,13 @@ 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 FreeBSD-CURRENT which is made available in a variety of ways for the convenience of - developers working actively on the system. See The FreeBSD - Handbook for more information about getting and using - FreeBSD-CURRENT. + developers working actively on the system. See + The + FreeBSD Handbook for more information about getting + and using FreeBSD-CURRENT. 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. - 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. + 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. The preferred &man.diff.1; format for submitting patches - is the unified output format generated by diff - -u. However, for patches that substantially change a - region of code, a context output format diff generated by - diff -c may be more readable and thus - preferable. + is the unified output format generated by diff + -u. However, for patches that substantially + change a region of code, a context output format diff + generated by diff -c may be more readable + and thus preferable. - diff + diff For example: @@ -359,9 +368,11 @@ &prompt.user; diff -u -r olddir newdir - would do the same, except in the unified diff format. + would do the same, except in the unified diff + format. - See the manual page for &man.diff.1; for more details. + See the manual page for &man.diff.1; for more + details. 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. - uuencode + uuencode If you feel it appropriate (e.g. you have added, deleted, or renamed files), bundle your changes into a tar file and run the &man.uuencode.1; - program on it. Archives created with &man.shar.1; are also welcome. + program on it. Archives created with &man.shar.1; are also + welcome. 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. 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. @@ -417,7 +429,7 @@ copyrights for code included in FreeBSD are: - BSD copyright + BSD copyright The BSD copyright. This copyright is most preferred due to its no strings attached nature and @@ -428,8 +440,12 @@ something of their own into FreeBSD. - GPLGNU General Public License - GNU General Public License + + GPLGNU General Public License + + + GNU General Public License + The GNU General Public License, or GPL. 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 /sys/gnu or - /usr/src/gnu, and is therefore easily - identifiable to anyone for whom the GPL presents a - problem. + /usr/src/gnu, and + is therefore easily identifiable to anyone for whom the + GPL presents a problem. @@ -514,34 +530,34 @@
The FreeBSD Foundation 7321 Brockway Dr. - Boulder, CO 80303 + Boulder, + CO 80303 USA -
- + The FreeBSD Foundation is now able to accept donations through the web with PayPal. To place a donation, please - visit the Foundation web - site. + visit the Foundation + web + site. More information about the FreeBSD Foundation can be found in The - FreeBSD Foundation -- an Introduction. To contact + url="http://people.FreeBSD.org/~jdp/foundation/announcement.html">The + FreeBSD Foundation -- an Introduction. To contact the Foundation by email, write to bod@FreeBSDFoundation.org. Donating Hardware - donations + donations 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 Donations Liaison - Office. + interested in donating hardware, please contact the + Donations Liaison + Office. @@ -549,16 +565,16 @@ We can always use new mirror sites for FTP, WWW or cvsup. If you would like to be such a - mirror, please see the Mirroring FreeBSD - article for more information. + mirror, please see the + Mirroring + FreeBSD article for more information. - + + - FreeBSD Documentation Project Primer for New Contributors - + FreeBSD Documentation Project Primer for New + Contributors + The FreeBSD Documentation Project - + 1998 1999 @@ -60,24 +61,24 @@ DocEng - $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/book.sgml,v 1.33 2009/01/21 23:52:53 pgj Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/book.sgml,v 1.34 2012/02/08 22:48:06 wblock Exp $ - $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/book.sgml,v 1.33 2009/01/21 23:52:53 pgj Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/book.sgml,v 1.34 2012/02/08 22:48:06 wblock Exp $ &bookinfo.legalnotice; - + Thank you for becoming a part of the FreeBSD Documentation - Project. Your contribution is extremely valuable. + Project. Your contribution is extremely valuable. - This primer covers everything you will need to know in order - to start contributing to the FreeBSD Documentation Project, from - the tools and software you will be using (both mandatory and - recommended) to the philosophy behind the Documentation - Project. + This primer covers everything you will need to know in + order to start contributing to the FreeBSD Documentation + Project, from the tools and software you will be using (both + mandatory and recommended) to the philosophy behind the + Documentation Project. - This document is a work in progress, and is not complete. Sections - that are known to be incomplete are indicated with a + This document is a work in progress, and is not complete. + Sections that are known to be incomplete are indicated with a * in their name. @@ -87,10 +88,11 @@ Shell Prompts - - The following table shows the default system prompt and superuser - prompt. The examples will use this prompt to indicate which user you - should be running the example as. + + The following table shows the default system prompt and + superuser prompt. The examples will use this prompt to + indicate which user you should be running the example + as. @@ -100,7 +102,7 @@ Prompt - + Normal user @@ -115,12 +117,12 @@ - + Typographic Conventions - The following table describes the typographic conventions used in - this book. + The following table describes the typographic conventions + used in this book. @@ -134,12 +136,14 @@ The names of commands. - Use ls -l to list all files. + Use ls -l to list all + files. The names of files. - Edit your .login file. + Edit your .login + file. @@ -148,8 +152,8 @@ - What you type, when contrasted with on-screen computer - output. + What you type, when contrasted with on-screen + computer output. &prompt.user; su Password: @@ -157,35 +161,31 @@ Manual page references. - - Use - &man.su.1; - to change user names. + Use &man.su.1; to change user names. User and group names - - Only root can do this. + Only root can do + this. Emphasis - You must do this. - Command line variables; replace with the real name or - variable. - - To delete a file, type rm filename + Command line variables; replace with the real + name or variable. + To delete a file, type rm + filename Environment variables - - $HOME is your home directory. + $HOME is your home + directory. @@ -193,52 +193,57 @@ - Notes, Tips, Important Information, Warnings, and Examples + Notes, Tips, Important Information, Warnings, and + Examples - Within the text appear notes, warnings, and examples. + Within the text appear notes, warnings, and + examples. - Notes are represented like this, and contain information that - you should take note of, as it may affect what you do. + Notes are represented like this, and contain information + that you should take note of, as it may affect what you + do. - Tips are represented like this, and contain information that you - might find useful, or lead to an easier way to do something. + Tips are represented like this, and contain information + that you might find useful, or lead to an easier way to do + something. - Important information is represented like this. Typically they - flag extra steps you may need to carry out. + Important information is represented like this. + Typically they flag extra steps you may need to carry + out. - Warnings are represented like this, and contain information - warning you about possible damage if you do not follow the - instructions. This damage may be physical, to your hardware or to - you, or it may be non-physical, such as the inadvertent deletion of - important files. + Warnings are represented like this, and contain + information warning you about possible damage if you do not + follow the instructions. This damage may be physical, to + your hardware or to you, or it may be non-physical, such as + the inadvertent deletion of important files. A Sample Example - Examples are represented like this, and typically contain - examples you should walk through, or show you what the results of a - particular action should be. + Examples are represented like this, and typically + contain examples you should walk through, or show you what + the results of a particular action should be. Acknowledgments - My thanks to Sue Blake, Patrick Durusau, Jon Hamilton, Peter - Flynn, and Christopher Maden, who took the time to read early drafts - of this document and offer many valuable comments and - criticisms. + My thanks to Sue Blake, Patrick Durusau, Jon Hamilton, + Peter Flynn, and Christopher Maden, who took the time to read + early drafts of this document and offer many valuable comments + and criticisms. - + &chap.overview; &chap.tools; &chap.sgml-primer; @@ -255,7 +260,7 @@ &app.examples; ==== //depot/projects/docproj_nl/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml#3 (text+ko) ==== @@ -27,51 +27,53 @@ ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml,v 1.24 2008/12/07 22:03:48 pgj Exp $ + $FreeBSD: doc/en_US.ISO8859-1/books/fdp-primer/overview/chapter.sgml,v 1.27 2012/02/08 23:10:59 wblock Exp $ --> Overview - + Welcome to the FreeBSD Documentation Project. Good quality documentation is very important to the success of FreeBSD, and the - FreeBSD Documentation Project (FDP) is how a lot of that documentation - is produced. Your contributions are very valuable. - - This document's main purpose is to clearly explain how - the FDP is organized, how to write and submit - documentation to the FDP, and how to - effectively use the tools available to you when writing - documentation. - - - Membership - - Everyone is welcome to join the FDP. There is no minimum + FreeBSD Documentation Project (FDP) is how a lot of that + documentation is produced. Your contributions are very + valuable. + + This document's main purpose is to clearly explain + how the FDP is organized, how to + write and submit documentation to the FDP, and + how to effectively use the tools available to you when + writing documentation. + + + Membership + + Everyone is welcome to join the FDP. There is no minimum membership requirement, no quota of documentation you need to produce per month. All you need to do is subscribe to the &a.doc;. - After you have finished reading this document you should: - + After you have finished reading this document you + should: + - + Know which documentation is maintained by the FDP. - + - Be able to read and understand the SGML source code for the - documentation maintained by the FDP. + Be able to read and understand the SGML source code for + the documentation maintained by the FDP. - - + + Be able to make changes to the documentation. - + - Be able to submit your changes back for review and eventual - inclusion in the FreeBSD documentation. - + Be able to submit your changes back for review and + eventual inclusion in the FreeBSD documentation. + @@ -79,63 +81,65 @@ The FDP is responsible for four categories of FreeBSD documentation. - + - Manual pages + Manual pages - - The English language system manual pages are not written by - the FDP, as they are part of the base system. However, the FDP can - (and has) re-worded parts of existing manual pages to make them - clearer, or to correct inaccuracies. + + The English language system manual pages are not + written by the FDP, as they are part of the base system. + However, the FDP can (and has) re-worded parts of existing + manual pages to make them clearer, or to correct + inaccuracies. - The translation teams are responsible for translating the - system manual pages into different languages. These translations - are kept within the FDP. - + The translation teams are responsible for translating + the system manual pages into different languages. These + translations are kept within the FDP. + - FAQ - - - The FAQ aims to address (in short question and answer format) - questions that are asked, or should be asked, on the various - mailing lists and newsgroups devoted to FreeBSD. The format does - not permit long and comprehensive answers. - + FAQ + + + The FAQ aims to address (in short question and answer + format) questions that are asked, or should be asked, on + the various mailing lists and newsgroups devoted to + FreeBSD. The format does not permit long and + comprehensive answers. + - Handbook + Handbook - - The Handbook aims to be the comprehensive on-line resource and - reference for FreeBSD users. - + + The Handbook aims to be the comprehensive on-line + resource and reference for FreeBSD users. + - + - Web site - - - This is the main FreeBSD presence on the World Wide Web, - visible at Web site + + + This is the main FreeBSD presence on the World Wide + Web, visible at http://www.FreeBSD.org/ - and many mirrors around the world. The web site is many people's - first exposure to FreeBSD. + and many mirrors around the world. The web site is many + people's first exposure to FreeBSD. - + These four groups of documentation are all available in the FreeBSD CVS tree. This means that the logs of changes to these - files are visible to anyone, and anyone can use a program such as - CVSup or - CTM to keep local copies of - this documentation. - + files are visible to anyone, and anyone can use a program such + as CVSup or + CTM to keep local copies of this + documentation. + In addition, many people have written tutorials or other web sites relating to FreeBSD. Some of these are stored in the CVS repository as well (where the author has agreed to this). In @@ -143,15 +147,15 @@ separate from the main FreeBSD repository. The FDP endeavors to provide links to as much of this documentation as possible. - - + + - Before You Start - - This document assumes that you already know: - - - + Before You Start + + This document assumes that you already know: + + + How to maintain an up-to-date local copy of the FreeBSD documentation by maintaining a local copy of the FreeBSD CVS repository (using CVS @@ -160,23 +164,25 @@ CVSup to download just a >>> TRUNCATED FOR MAIL (1000 lines) <<<