svn commit: r42086 - head/en_US.ISO8859-1/articles/committers-guide
Warren Block
wblock at FreeBSD.org
Sat Jun 29 22:59:49 UTC 2013
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.</para>
<sect2>
- <title>Policy for <filename>doc/</filename> committer activity
+ <title>Policy for <filename>doc/</filename> Committer Activity
in <filename>src/</filename></title>
<itemizedlist>
@@ -532,16 +532,16 @@
Layout</title>
<para>In <literal>svn+ssh://svn.freebsd.org/doc</literal>,
- <emphasis>doc</emphasis> refers repository root of the
+ <emphasis>doc</emphasis> refers to the repository root of the
source tree.</para>
<para>In general, most &os; Documentation Project work will be
done within the <filename>head/</filename> branch of the
- source tree.</para>
+ documentation source tree.</para>
<para>&os; documentation is written and/or translated to
- various languages, each of which within a separate
- directory within the <filename>head/</filename>
+ various languages, each in a separate
+ directory in the <filename>head/</filename>
branch.</para>
<para>Each translation set contains several subdirectories for
@@ -762,7 +762,7 @@
ports tree specific version</ulink>)
and add it to <filename>~/.subversion/config</filename>
according to the instructions in the file. If you added
- something before you've read this, you may use
+ something before reading this, use
<command>svn rm --keep-local</command> 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 @@
<itemizedlist>
<listitem>
<para><literal>log</literal>,
- <literal>diff</literal>.</para>
+ <literal>diff</literal></para>
</listitem>
<listitem>
- <para><literal>mkdir</literal>.</para>
+ <para><literal>mkdir</literal></para>
</listitem>
<listitem>
<para><literal>remove</literal>, <literal>copy</literal>,
- <literal>rename</literal>.</para>
+ <literal>rename</literal></para>
</listitem>
<listitem>
<para><literal>propset</literal>,
<literal>propedit</literal>,
- <literal>propdel</literal>.</para>
+ <literal>propdel</literal></para>
</listitem>
<listitem>
- <para><literal>merge</literal>.</para>
+ <para><literal>merge</literal></para>
</listitem>
</itemizedlist>
@@ -1080,7 +1080,7 @@
<orderedlist>
<listitem>
<para>If <filename
- class="directory">branch/foo/bar/</filename> doesn't
+ class="directory">branch/foo/bar/</filename> does not
already have a mergeinfo record, but a direct ancestor
(for instance, <filename
class="directory">branch/foo/</filename>) does,
@@ -1279,7 +1279,7 @@
<sect4>
<title>Merging</title>
- <para>Now, let's start merging!</para>
+ <para>Now, let us start merging!</para>
<sect5>
<title>The Principles</title>
@@ -1288,18 +1288,18 @@
<itemizedlist>
<listitem>
- <para>revision <literal>$R</literal>.</para>
+ <para>revision <literal>$R</literal></para>
</listitem>
<listitem>
<para>in directory $target in stable branch
- $B.</para>
+ $B</para>
</listitem>
<listitem>
- <para>from directory $source in head.</para>
+ <para>from directory $source in head</para>
</listitem>
<listitem>
<para>$FSVN is
- <literal>svn+ssh://svn.freebsd.org/base</literal>.</para>
+ <literal>svn+ssh://svn.freebsd.org/base</literal></para>
</listitem>
</itemizedlist>
@@ -1416,7 +1416,7 @@ U stable/9/share/man/man4/netmap.4
</sect3>
<sect3>
- <title>Vendor imports with <acronym>SVN</acronym></title>
+ <title>Vendor Imports with <acronym>SVN</acronym></title>
<important>
<para>Please read this entire section before starting a vendor
@@ -1431,7 +1431,7 @@ U stable/9/share/man/man4/netmap.4
<para>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.</para>
</listitem>
<listitem>
@@ -1462,7 +1462,7 @@ U stable/9/share/man/man4/netmap.4
</note>
<sect4>
- <title>Preparing the tree</title>
+ <title>Preparing the Tree</title>
<para>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.</para>
</sect5>
<sect5>
- <title>Cleaning up</title>
+ <title>Cleaning Up</title>
<para>The <literal>dist</literal> 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; <userinput>svn commit</userinput></screen>
</sect5>
<sect5>
- <title>Bootstrapping merge history</title>
+ <title>Bootstrapping Merge History</title>
<para>If importing for the first time after the switch to
Subversion, bootstrap
@@ -1533,7 +1533,7 @@ U stable/9/share/man/man4/netmap.4
</sect4>
<sect4>
- <title>Importing new sources</title>
+ <title>Importing New Sources</title>
<para>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.</para>
<sect5>
- <title>Preparing the vendor sources</title>
+ <title>Preparing the Vendor Sources</title>
<para>Unlike in <acronym>CVS</acronym> 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 <filename>new</filename>.</para>
</sect5>
<sect5>
- <title>Importing into the vendor tree</title>
+ <title>Importing into the Vendor Tree</title>
<para>Now, the sources must be copied into
<filename><replaceable>dist</replaceable></filename> and
@@ -1627,14 +1627,14 @@ U stable/9/share/man/man4/netmap.4
</sect5>
</sect4>
<sect4>
- <title>Merging to head</title>
+ <title>Merging to Head</title>
<screen>&prompt.user; <userinput>cd <replaceable>head/contrib/pf</replaceable></userinput>
&prompt.user; <userinput>svn up</userinput>
&prompt.user; <userinput>svn merge --accept=postpone svn+ssh://svn.freebsd.org/base/<replaceable>vendor/pf/dist</replaceable> .</userinput></screen>
<para>The <literal>--accept=postpone</literal> 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.</para>
<para>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.</para>
<para>Using <acronym>CVS</acronym>, once a file was off the
@@ -1667,7 +1667,7 @@ U stable/9/share/man/man4/netmap.4
until everything builds and runs perfectly.</para>
</sect4>
<sect4>
- <title>Committing the vendor import</title>
+ <title>Committing the Vendor Import</title>
<para>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
</sect4>
<sect4>
- <title>From scratch</title>
+ <title>From Scratch</title>
<sect5>
- <title>Importing into the vendor tree</title>
+ <title>Importing into the Vendor Tree</title>
<para>This section is an example of importing and tagging
<application>byacc</application> into
@@ -1704,7 +1704,7 @@ U stable/9/share/man/man4/netmap.4
</sect5>
<sect5>
- <title>Merging to head</title>
+ <title>Merging to <literal>head</literal></title>
<para>Due to this being a new file, copy it for the
merge:</para>
@@ -1852,7 +1852,7 @@ U stable/9/share/man/man4/netmap.4
<sect3>
<title>Maintaining a Project Branch</title>
- <para>A project branch is one that's synced to head (or
+ <para>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 <acronym>SVN</acronym>,
<quote>dolphin</quote> branching is used for this. A
@@ -1903,7 +1903,7 @@ U stable/9/share/man/man4/netmap.4
<para>In commit logs etc., <quote>rev 179872</quote> should be
spelled <quote>r179872</quote> as per convention.</para>
- <para>Don't remove and re-add the same file in a single commit
+ <para>Do not remove and re-add the same file in a single commit
as this will break the CVS exporter.</para>
<para>Speeding up svn is
@@ -1940,7 +1940,7 @@ ControlPersist yes</screen>
to do these things for you.)</para>
<sect2 id="conventions-committers">
- <title>Guidelines For Committers</title>
+ <title>Guidelines for Committers</title>
<note>
<para>The <literal>.ent</literal>, <literal>.xml</literal>,
@@ -1976,7 +1976,7 @@ ControlPersist yes</screen>
</important>
<note>
- <para>Don't forget to get mentor approval for these patches!</para>
+ <para>Do not forget to get mentor approval for these patches!</para>
</note>
</listitem>
@@ -2079,7 +2079,7 @@ ControlPersist yes</screen>
</sect2>
<sect2 id="conventions-everyone">
- <title>Guidelines For Everyone</title>
+ <title>Guidelines for Everyone</title>
<para>Whether or not you have commit rights:</para>
@@ -2518,7 +2518,7 @@ ControlPersist yes</screen>
sure that you run it before running other applications. X
users, for example, usually do this from their
<filename>.xsession</filename> or
- <filename>.xinitrc</filename> file. See &man.ssh-agent.1;
+ <filename>.xinitrc</filename>. See &man.ssh-agent.1;
for details.</para>
</step>
@@ -3057,9 +3057,9 @@ ControlPersist yes</screen>
<para>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.</para>
<para>The &arch.ia64; platform has many of the same complications that
@@ -4099,7 +4099,7 @@ bak/packages packages from last complet
</sect1>
<sect1 id="non-committers">
- <title>Issues Specific To Developers Who Are Not Committers</title>
+ <title>Issues Specific to Developers Who Are Not Committers</title>
<para>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
</sect1>
<sect1 id="google-analytics">
- <title>Information about &ga;</title>
+ <title>Information About &ga;</title>
<para>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
<para>From now on, every new vendor release of that file will
need to have patches <emphasis>verified</emphasis> by hand.</para>
</listitem>
-
- <listitem>
- <para>The <option>-j</option> option does not work very well.
- Ask &a.obrien; for horror stories.</para>
- </listitem>
</itemizedlist>
</answer>
</qandaentry>
@@ -4393,7 +4388,7 @@ bak/packages packages from last complet
</informaltable>
<example>
- <title>Commit log for a commit based on a PR</title>
+ <title>Commit Log for a Commit Based on a PR</title>
<para>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
</example>
<example>
- <title>Commit log for a commit needing review</title>
+ <title>Commit Log for a Commit Needing Review</title>
<para>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</programlisting
</example>
<example>
- <title>Commit log for a commit needing approval</title>
+ <title>Commit Log for a Commit Needing Approval</title>
<para>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: <replaceable>abc</repla
</example>
<example>
- <title>Commit log for a commit bringing in code from
+ <title>Commit Log for a Commit Bringing in Code from
OpenBSD</title>
<para>You want to commit some code based on work done in the
@@ -4446,8 +4441,8 @@ Obtained from: OpenBSD</programlist
</example>
<example>
- <title>Commit log for a change to &os.current; with a planned
- commit to &os.stable; to follow at a later date.</title>
+ <title>Commit Log for a Change to &os.current; with a Planned
+ Commit to &os.stable; to Follow at a Later Date.</title>
<para>You want to commit some code which will be merged from
&os.current; into the &os.stable; branch after two
More information about the svn-doc-head
mailing list