From owner-svn-doc-all@FreeBSD.ORG Sat Jun 29 22:59:49 2013 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by hub.freebsd.org (Postfix) with ESMTP id 502F2D52; Sat, 29 Jun 2013 22:59:49 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) by mx1.freebsd.org (Postfix) with ESMTP id 3284218FA; Sat, 29 Jun 2013 22:59:49 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r5TMxnco044794; Sat, 29 Jun 2013 22:59:49 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r5TMxnk2044793; Sat, 29 Jun 2013 22:59:49 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201306292259.r5TMxnk2044793@svn.freebsd.org> From: Warren Block Date: Sat, 29 Jun 2013 22:59:49 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42086 - 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.14 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: Sat, 29 Jun 2013 22:59:49 -0000 Author: wblock Date: Sat Jun 29 22:59:48 2013 New Revision: 42086 URL: http://svnweb.freebsd.org/changeset/doc/42086 Log: Fix wording errors, title capitalization, remove some outdated CVS-specific notes. 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 Sat Jun 29 14:26:29 2013 (r42085) +++ head/en_US.ISO8859-1/articles/committers-guide/article.xml Sat Jun 29 22:59:48 2013 (r42086) @@ -237,7 +237,7 @@ of the tree where the work is occurring. - Policy for <filename>doc/</filename> committer activity + <title>Policy for <filename>doc/</filename> Committer Activity in <filename>src/</filename> @@ -532,16 +532,16 @@ Layout In svn+ssh://svn.freebsd.org/doc, - doc refers repository root of the + doc refers to the repository root of the source tree. In general, most &os; Documentation Project work will be done within the head/ branch of the - source tree. + documentation source tree. &os; documentation is written and/or translated to - various languages, each of which within a separate - directory within the head/ + various languages, each in a separate + directory in the head/ branch. Each translation set contains several subdirectories for @@ -762,7 +762,7 @@ ports tree specific version) and add it to ~/.subversion/config according to the instructions in the file. If you added - something before you've read this, you may use + something before reading this, use svn rm --keep-local for just added files, fix your config file and re-add them again. The initial config file is created when you first run a svn @@ -1005,22 +1005,22 @@ log, - diff. + diff - mkdir. + mkdir remove, copy, - rename. + rename propset, propedit, - propdel. + propdel - merge. + merge @@ -1080,7 +1080,7 @@ If branch/foo/bar/ doesn't + class="directory">branch/foo/bar/ does not already have a mergeinfo record, but a direct ancestor (for instance, branch/foo/) does, @@ -1279,7 +1279,7 @@ Merging - Now, let's start merging! + Now, let us start merging! The Principles @@ -1288,18 +1288,18 @@ - revision $R. + revision $R in directory $target in stable branch - $B. + $B - from directory $source in head. + from directory $source in head $FSVN is - svn+ssh://svn.freebsd.org/base. + svn+ssh://svn.freebsd.org/base @@ -1416,7 +1416,7 @@ U stable/9/share/man/man4/netmap.4 - Vendor imports with <acronym>SVN</acronym> + Vendor Imports with <acronym>SVN</acronym> Please read this entire section before starting a vendor @@ -1431,7 +1431,7 @@ U stable/9/share/man/man4/netmap.4 Vendor patches: these are patches that have been issued by the vendor, or that have been extracted from the vendor's version control system, which address - issues which in your opinion can't wait until the next + issues which in your opinion cannot wait until the next vendor release. @@ -1462,7 +1462,7 @@ U stable/9/share/man/man4/netmap.4 - Preparing the tree + Preparing the Tree If importing for the first time after the switch to Subversion, flattening and cleaning up the vendor tree is @@ -1503,7 +1503,7 @@ U stable/9/share/man/man4/netmap.4 off until the end of the process. - Cleaning up + Cleaning Up The dist tree can be cleaned up as necessary. Disabling keyword expansion is @@ -1517,7 +1517,7 @@ U stable/9/share/man/man4/netmap.4 &prompt.root; svn commit - Bootstrapping merge history + Bootstrapping Merge History If importing for the first time after the switch to Subversion, bootstrap @@ -1533,7 +1533,7 @@ U stable/9/share/man/man4/netmap.4 - Importing new sources + Importing New Sources With two commits—one for the import itself and one for the tag—this step can optionally be repeated @@ -1541,7 +1541,7 @@ U stable/9/share/man/man4/netmap.4 current import. - Preparing the vendor sources + Preparing the Vendor Sources Unlike in CVS where only the needed parts were imported into the vendor tree to avoid bloating @@ -1570,7 +1570,7 @@ U stable/9/share/man/man4/netmap.4 will list added files only in new. - Importing into the vendor tree + Importing into the Vendor Tree Now, the sources must be copied into dist and @@ -1627,14 +1627,14 @@ U stable/9/share/man/man4/netmap.4 - Merging to head + Merging to Head &prompt.user; cd head/contrib/pf &prompt.user; svn up &prompt.user; svn merge --accept=postpone svn+ssh://svn.freebsd.org/base/vendor/pf/dist . The --accept=postpone tells - Subversion that it shouldn't complain because merge conflicts + Subversion that it should not complain because merge conflicts will be taken care of manually. It is necessary to resolve any merge conflicts. @@ -1651,7 +1651,7 @@ U stable/9/share/man/man4/netmap.4 Subversion not to complain about files that are in the vendor tree but not in the main tree, i.e., things that would have previously been removed before the vendor - import, like for example the like the vendor's makefiles + import, like for example the vendor's makefiles and configure scripts. Using CVS, once a file was off the @@ -1667,7 +1667,7 @@ U stable/9/share/man/man4/netmap.4 until everything builds and runs perfectly. - Committing the vendor import + Committing the Vendor Import Committing is now possible! Everything must be committed in one go. If done properly, the tree will move @@ -1676,10 +1676,10 @@ U stable/9/share/man/man4/netmap.4 - From scratch + From Scratch - Importing into the vendor tree + Importing into the Vendor Tree This section is an example of importing and tagging byacc into @@ -1704,7 +1704,7 @@ U stable/9/share/man/man4/netmap.4 - Merging to head + Merging to <literal>head</literal> Due to this being a new file, copy it for the merge: @@ -1852,7 +1852,7 @@ U stable/9/share/man/man4/netmap.4 Maintaining a Project Branch - A project branch is one that's synced to head (or + A project branch is one that is synced to head (or another branch) is used to develop a project then commit it back to head. In SVN, dolphin branching is used for this. A @@ -1903,7 +1903,7 @@ U stable/9/share/man/man4/netmap.4 In commit logs etc., rev 179872 should be spelled r179872 as per convention. - Don't remove and re-add the same file in a single commit + Do not remove and re-add the same file in a single commit as this will break the CVS exporter. Speeding up svn is @@ -1940,7 +1940,7 @@ ControlPersist yes to do these things for you.) - Guidelines For Committers + Guidelines for Committers The .ent, .xml, @@ -1976,7 +1976,7 @@ ControlPersist yes - Don't forget to get mentor approval for these patches! + Do not forget to get mentor approval for these patches! @@ -2079,7 +2079,7 @@ ControlPersist yes - Guidelines For Everyone + Guidelines for Everyone Whether or not you have commit rights: @@ -2518,7 +2518,7 @@ ControlPersist yes sure that you run it before running other applications. X users, for example, usually do this from their .xsession or - .xinitrc file. See &man.ssh-agent.1; + .xinitrc. See &man.ssh-agent.1; for details. @@ -3057,9 +3057,9 @@ ControlPersist yes The &arch.i386; and &arch.sparc64; platforms were chosen due to being more readily available to developers and as representatives of more - diverse processor and system designs - big vs little endian, - register file vs register stack, different DMA and cache - implementations, hardware page tables vs software TLB management + diverse processor and system designs - big versus little endian, + register file versus register stack, different DMA and cache + implementations, hardware page tables versus software TLB management etc. The &arch.ia64; platform has many of the same complications that @@ -4099,7 +4099,7 @@ bak/packages packages from last complet - Issues Specific To Developers Who Are Not Committers + Issues Specific to Developers Who Are Not Committers A few people who have access to the FreeBSD machines do not have commit bits. For instance, the project is willing to give @@ -4153,7 +4153,7 @@ bak/packages packages from last complet - Information about &ga; + Information About &ga; As of December 12, 2012, &ga; was enabled on the &os; Project website to collect anonymized usage statistics @@ -4276,11 +4276,6 @@ bak/packages packages from last complet From now on, every new vendor release of that file will need to have patches verified by hand. - - - The option does not work very well. - Ask &a.obrien; for horror stories. - @@ -4393,7 +4388,7 @@ bak/packages packages from last complet - Commit log for a commit based on a PR + Commit Log for a Commit Based on a PR You want to commit a change based on a PR submitted by John Smith containing a patch. The end of the commit message should @@ -4406,7 +4401,7 @@ Submitted by: John Smith <John.Smi - Commit log for a commit needing review + Commit Log for a Commit Needing Review You want to change the virtual memory system. You have posted patches to the appropriate mailing list (in this case, @@ -4419,7 +4414,7 @@ Reviewed by: -arch - Commit log for a commit needing approval + Commit Log for a Commit Needing Approval You want to commit a change to a section of the tree with a MAINTAINER assigned. You have collaborated with the listed @@ -4434,7 +4429,7 @@ Approved by: abc - Commit log for a commit bringing in code from + <title>Commit Log for a Commit Bringing in Code from OpenBSD You want to commit some code based on work done in the @@ -4446,8 +4441,8 @@ Obtained from: OpenBSD - Commit log for a change to &os.current; with a planned - commit to &os.stable; to follow at a later date. + Commit Log for a Change to &os.current; with a Planned + Commit to &os.stable; to Follow at a Later Date. You want to commit some code which will be merged from &os.current; into the &os.stable; branch after two