From owner-svn-doc-all@FreeBSD.ORG Tue Jun 24 13:38:27 2014 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id 826C690F; Tue, 24 Jun 2014 13:38:27 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 62CF22AB0; Tue, 24 Jun 2014 13:38:27 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s5ODcRNt024605; Tue, 24 Jun 2014 13:38:27 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.8/8.14.8/Submit) id s5ODcRiB024604; Tue, 24 Jun 2014 13:38:27 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201406241338.s5ODcRiB024604@svn.freebsd.org> From: Warren Block Date: Tue, 24 Jun 2014 13:38:27 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r45111 - head/en_US.ISO8859-1/articles/committers-guide X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 24 Jun 2014 13:38:27 -0000 Author: wblock Date: Tue Jun 24 13:38:27 2014 New Revision: 45111 URL: http://svnweb.freebsd.org/changeset/doc/45111 Log: Whitespace-only fixes, translators please ignore. Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml Modified: head/en_US.ISO8859-1/articles/committers-guide/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/committers-guide/article.xml Tue Jun 24 13:35:28 2014 (r45110) +++ head/en_US.ISO8859-1/articles/committers-guide/article.xml Tue Jun 24 13:38:27 2014 (r45111) @@ -209,19 +209,20 @@ doc/head/share/pgpkeys/checkkey.sh first. - For those who do not yet have an OpenPGP key, - or need a new key to meet &os; security requirements, here we - show how to generate one. + For those who do not yet have an + OpenPGP key, or need a new key to meet &os; + security requirements, here we show how to generate + one. - Install - security/gnupg. Enter - these lines in ~/.gnupg/gpg.conf to set - minimum acceptable defaults: + Install + security/gnupg. Enter + these lines in ~/.gnupg/gpg.conf to + set minimum acceptable defaults: - fixed-list-mode + fixed-list-mode keyid-format 0xlong personal-digest-preferences SHA512 SHA384 SHA256 SHA224 default-preference-list SHA512 SHA384 SHA256 SHA224 AES256 AES192 AES CAST5 BZIP2 ZLIB ZIP Uncompressed @@ -233,9 +234,9 @@ cert-digest-algo SHA512 - Generate a key: + Generate a key: - &prompt.user; gpg --gen-key + &prompt.user; gpg --gen-key gpg (GnuPG) 2.0.22; Copyright (C) 2013 Free Software Foundation, Inc. This is free software: you are free to change and redistribute it. There is NO WARRANTY, to the extent permitted by law. @@ -271,38 +272,39 @@ You selected this USER-ID: Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? o You need a Passphrase to protect your secret key. - - - 2048-bit keys with a three-year expiration provide - adequate protection at present (2013-12). - describes the situation in more detail. - - - - A three year key lifespan is short enough to obsolete - keys weakened by advancing computer power, but long enough - to reduce key management problems. - - - - Use your real name here, preferably matching that - shown on government-issued ID to make - it easier for others to verify your identity. Text that - may help others identify you can be entered in the - Comment section. - - - - After the email address is entered, a passphrase is - requested. Methods of creating a secure passphrase are - contentious. Rather than suggest a single way, here are some - links to sites that describe various methods: , - , - , . + + + 2048-bit keys with a three-year expiration provide + adequate protection at present (2013-12). + describes the situation in more detail. + + + + A three year key lifespan is short enough to + obsolete keys weakened by advancing computer power, + but long enough to reduce key management + problems. + + + + Use your real name here, preferably matching that + shown on government-issued ID to + make it easier for others to verify your identity. + Text that may help others identify you can be entered + in the Comment section. + + + + After the email address is entered, a passphrase is + requested. Methods of creating a secure passphrase are + contentious. Rather than suggest a single way, here are + some links to sites that describe various methods: , + , + , + . @@ -2207,8 +2209,8 @@ ControlPersist yes The .ent and - .xml files mentioned below exist in the - &os; Documentation Project SVN repository at .xml files mentioned below exist in + the &os; Documentation Project SVN repository at svn.FreeBSD.org/doc/. @@ -2219,20 +2221,20 @@ ControlPersist yes when attempting to commit them to the repository. Be sure to read - regarding adding and removing files. - Verify that ~/.subversion/config - contains the necessary auto-props entries from + regarding adding and removing files. Verify that + ~/.subversion/config contains the + necessary auto-props entries from auto-props.txt mentioned there. - All src commits should go to - &os.current; first before being merged to &os.stable;. - The &os.stable; branch must maintain ABI - and API compatibility with earlier - versions of that branch. Do not merge changes that break - this compatibility. + All src commits should go to + &os.current; first before being merged to &os.stable;. + The &os.stable; branch must maintain + ABI and API + compatibility with earlier versions of that branch. Do + not merge changes that break this compatibility. @@ -2242,43 +2244,50 @@ ControlPersist yes Add an Author Entity - head/share/xml/authors.ent — - Add an author entity. Later steps depend - on this entity, and missing this step will - cause the - doc/ build to fail. This is a relatively easy task, but remains a good - first test of version control skills. + head/share/xml/authors.ent + — Add an author entity. Later steps depend on this + entity, and missing this step will cause the + doc/ build to fail. This is a + relatively easy task, but remains a good first test of + version control skills. - Update the List of Developers and Contributors + Update the List of Developers and + Contributors - head/en_US.ISO8859-1/articles/contributors/contrib.committers.xml — + head/en_US.ISO8859-1/articles/contributors/contrib.committers.xml + — Add an entry to the Developers section of the Contributors List. Entries are sorted by last name. - head/en_US.ISO8859-1/articles/contributors/contrib.additional.xml — - Remove the entry from the - Additional Contributors section. - Entries are sorted by last name. + + head/en_US.ISO8859-1/articles/contributors/contrib.additional.xml + — Remove the entry from the + Additional Contributors section. Entries + are sorted by last name. Add a News Item - doc/head/share/xml/news.xml — - Add an entry. Look for - the other entries that announce - new committers and follow the - format. Use the date from the commit bit approval email from core@FreeBSD.org. + + doc/head/share/xml/news.xml + — Add an entry. Look for the other entries that + announce new committers and follow the format. Use the + date from the commit bit approval email from + core@FreeBSD.org. Add a <acronym>PGP</acronym> Key - doc/head/share/pgpkeys/pgpkeys.ent and - doc/head/share/pgpkeys/pgpkeys-developers.xml - - Add your PGP or GnuPG key. - Those who do not yet have a key should see . + + doc/head/share/pgpkeys/pgpkeys.ent + and + doc/head/share/pgpkeys/pgpkeys-developers.xml + - Add your PGP or + GnuPG key. Those who do not yet have a + key should see . &a.des.email; has written a shell script (head/share/pgpkeys/addkey.sh) to @@ -2291,15 +2300,17 @@ ControlPersist yes verify that keys meet minimal best-practices standards. - After adding and checking a key, add both updated files to source control and then commit them. - Entries in this file are sorted by last name. + After adding and checking a key, add both updated + files to source control and then commit them. Entries in + this file are sorted by last name. - It is very important to have a current PGP/GnuPG key - in the repository. The key may be required for - positive identification of a committer. For example, the - &a.admins; might need it for account recovery. A complete keyring of - It is very important to have a current + PGP/GnuPG key in + the repository. The key may be required for positive + identification of a committer. For example, the + &a.admins; might need it for account recovery. A + complete keyring of FreeBSD.org users is available for download from http://www.FreeBSD.org/doc/pgpkeyring.txt. @@ -2309,43 +2320,41 @@ ControlPersist yes Update Mentor and Mentee Information - head/share/misc/committers-repository.dot — - Add an entry to the current committers - section, - where repository is doc, ports, or src, depending on - the commit privileges granted. - - Add an entry for the - each additonal mentor/mentee relationship in the - bottom section. + head/share/misc/committers-repository.dot + — Add an entry to the current committers section, + where repository is + doc, ports, or + src, depending on the commit privileges + granted. + + Add an entry for the each additonal mentor/mentee + relationship in the bottom section. Generate a <application>Kerberos</application> Password - See to generate or - set a Kerberos for use with - other &os; services like the bug tracking - database. + See to generate or + set a Kerberos for use with + other &os; services like the bug tracking database. Optional: Enable Wiki Account - &os; Wiki Account — - A wiki account allows sharing projects and ideas. Those - who do not yet have an account can contact - clusteradm@FreeBSD.org to obtain - one. + &os; + Wiki Account — A wiki account allows + sharing projects and ideas. Those who do not yet have an + account can contact clusteradm@FreeBSD.org + to obtain one. Optional: Update Wiki Information - Wiki Information - - After gaining access to the wiki, some people add entries - to the Wiki Information - After gaining access to the wiki, + some people add entries to the How We Got Here, Irc @@ -2355,20 +2364,24 @@ ControlPersist yes - Optional: Update Ports with Personal Information - ports/astro/xearth/files/freebsd.committers.markers and - src/usr.bin/calendar/calendars/calendar.freebsd - - Some people add entries for themselves to these - files to show where they are located or the date of their birthday. + Optional: Update Ports with Personal + Information + + ports/astro/xearth/files/freebsd.committers.markers + and + src/usr.bin/calendar/calendars/calendar.freebsd + - Some people add entries for themselves to these files to + show where they are located or the date of their + birthday. Optional: Prevent Duplicate Mailings Subscribers to &a.svn-src-all.name;, - &a.svn-ports-all.name; or &a.svn-doc-all.name; might wish to - unsubscribe to avoid receiving duplicate - copies of commit messages and followups. + &a.svn-ports-all.name; or &a.svn-doc-all.name; might wish + to unsubscribe to avoid receiving duplicate copies of + commit messages and followups. @@ -2381,11 +2394,10 @@ ControlPersist yes Introduce yourself to the other developers, otherwise no one will have any idea who you are or what you are working on. The introduction need not be a comprehensive - biography, just write a paragraph or two about who you are, - what you plan to be working on as a developer in - &os;, and who will be your mentor. - Email this to the &a.developers; and you will be on - your way! + biography, just write a paragraph or two about who you + are, what you plan to be working on as a developer in + &os;, and who will be your mentor. Email this to the + &a.developers; and you will be on your way! @@ -2432,20 +2444,20 @@ ControlPersist yes All new developers have a mentor assigned to them for the first few months. A mentor is responsible for teaching - the mentee the rules and conventions of the project and guiding their - first steps in the developer community. The mentor is also - personally responsible for the mentee's actions during this initial - period. + the mentee the rules and conventions of the project and + guiding their first steps in the developer community. The + mentor is also personally responsible for the mentee's actions + during this initial period. For committers: do not commit anything without first - getting mentor approval. Document that - approval with an Approved by: line in the - commit message. + getting mentor approval. Document that approval with an + Approved by: line in the commit + message. When the mentor decides that a mentee has learned the ropes and is ready to commit on their own, the mentor - announces it - with a commit to mentors. + announces it with a commit to + mentors. @@ -2724,7 +2736,8 @@ Relnotes: yes - Keeping Track of Licenses Granted to the &os; Project + Keeping Track of Licenses Granted to the &os; + Project Various software or data exist in the repositories where the &os; project has been granted a special licence to be able @@ -2738,8 +2751,8 @@ Relnotes: yes license grants. To that end, the &a.core; has decided to keep an archive of them. Whenever the &os; project is granted a special license we require the &a.core; to be notified. Any - developers involved in arranging such a license grant, please send - details to the &a.core; including: + developers involved in arranging such a license grant, please + send details to the &a.core; including: @@ -2755,8 +2768,8 @@ Relnotes: yes The date the license comes into effect from. Unless - otherwise agreed, this will be the date the license was issued - by the authors of the software in question. + otherwise agreed, this will be the date the license was + issued by the authors of the software in question. @@ -2764,8 +2777,8 @@ Relnotes: yes - A note of any restrictions, limitations or exceptions that - apply specifically to &os;'s usage of the licensed + A note of any restrictions, limitations or exceptions + that apply specifically to &os;'s usage of the licensed material. @@ -2774,11 +2787,11 @@ Relnotes: yes - Once the &a.core; is satisfied that all the necessary details - have been gathered and are correct, the secretary will send a - PGP-signed acknowledgement of receipt including the license - details. This receipt will be persistently archived and serve - as our permanent record of the license grant. + Once the &a.core; is satisfied that all the necessary + details have been gathered and are correct, the secretary will + send a PGP-signed acknowledgement of receipt including the + license details. This receipt will be persistently archived and + serve as our permanent record of the license grant. The license archive should contain only details of license grants; this is not the place for any discussions around