os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Fix wording errors, title capitalization, remove some outdated

Browse source 
CVS-specific notes.
This commit is contained in:
Warren Block 2013-06-29 22:59:48 +00:00
parent a83d0a09a3
commit aac92ebdaf
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=42086
1 changed files with 49 additions and 54 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

103
en_US.ISO8859-1/articles/committers-guide/article.xml
View file

@ -237,7 +237,7 @@
of the tree where the work is occurring.</para> of the tree where the work is occurring.</para>
<sect2> <sect2>
<title>Policy for <filename>doc/</filename> committer activity <title>Policy for <filename>doc/</filename> Committer Activity
in <filename>src/</filename></title> in <filename>src/</filename></title>
<itemizedlist> <itemizedlist>
@ -532,16 +532,16 @@
Layout</title> Layout</title>
<para>In <literal>svn+ssh://svn.freebsd.org/doc</literal>, <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> source tree.</para>
<para>In general, most &os; Documentation Project work will be <para>In general, most &os; Documentation Project work will be
done within the <filename>head/</filename> branch of the 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 <para>&os; documentation is written and/or translated to
various languages, each of which within a separate various languages, each in a separate
directory within the <filename>head/</filename> directory in the <filename>head/</filename>
branch.</para> branch.</para>
<para>Each translation set contains several subdirectories for <para>Each translation set contains several subdirectories for
@ -762,7 +762,7 @@
ports tree specific version</ulink>) ports tree specific version</ulink>)
and add it to <filename>~/.subversion/config</filename> and add it to <filename>~/.subversion/config</filename>
according to the instructions in the file. If you added 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 <command>svn rm --keep-local</command> for just added
files, fix your config file and re-add them again. The files, fix your config file and re-add them again. The
initial config file is created when you first run a svn initial config file is created when you first run a svn
@ -1005,22 +1005,22 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para><literal>log</literal>, <para><literal>log</literal>,
<literal>diff</literal>.</para> <literal>diff</literal></para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>mkdir</literal>.</para> <para><literal>mkdir</literal></para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>remove</literal>, <literal>copy</literal>, <para><literal>remove</literal>, <literal>copy</literal>,
<literal>rename</literal>.</para> <literal>rename</literal></para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>propset</literal>, <para><literal>propset</literal>,
<literal>propedit</literal>, <literal>propedit</literal>,
<literal>propdel</literal>.</para> <literal>propdel</literal></para>
</listitem> </listitem>
<listitem> <listitem>
<para><literal>merge</literal>.</para> <para><literal>merge</literal></para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -1080,7 +1080,7 @@
<orderedlist> <orderedlist>
<listitem> <listitem>
<para>If <filename <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 already have a mergeinfo record, but a direct ancestor
(for instance, <filename (for instance, <filename
class="directory">branch/foo/</filename>) does, class="directory">branch/foo/</filename>) does,
@ -1279,7 +1279,7 @@
<sect4> <sect4>
<title>Merging</title> <title>Merging</title>
<para>Now, let's start merging!</para> <para>Now, let us start merging!</para>
<sect5> <sect5>
<title>The Principles</title> <title>The Principles</title>
@ -1288,18 +1288,18 @@
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>revision <literal>&dollar;R</literal>.</para> <para>revision <literal>&dollar;R</literal></para>
</listitem> </listitem>
<listitem> <listitem>
<para>in directory &dollar;target in stable branch <para>in directory &dollar;target in stable branch
&dollar;B.</para> &dollar;B</para>
</listitem> </listitem>
<listitem> <listitem>
<para>from directory &dollar;source in head.</para> <para>from directory &dollar;source in head</para>
</listitem> </listitem>
<listitem> <listitem>
<para>&dollar;FSVN is <para>&dollar;FSVN is
<literal>svn+ssh://svn.freebsd.org/base</literal>.</para> <literal>svn+ssh://svn.freebsd.org/base</literal></para>
</listitem> </listitem>
</itemizedlist> </itemizedlist>
@ -1416,7 +1416,7 @@ U stable/9/share/man/man4/netmap.4
</sect3> </sect3>
<sect3> <sect3>
<title>Vendor imports with <acronym>SVN</acronym></title> <title>Vendor Imports with <acronym>SVN</acronym></title>
<important> <important>
<para>Please read this entire section before starting a vendor <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 <para>Vendor patches: these are patches that have been
issued by the vendor, or that have been extracted from issued by the vendor, or that have been extracted from
the vendor's version control system, which address 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> vendor release.</para>
</listitem> </listitem>
<listitem> <listitem>
@ -1462,7 +1462,7 @@ U stable/9/share/man/man4/netmap.4
</note> </note>
<sect4> <sect4>
<title>Preparing the tree</title> <title>Preparing the Tree</title>
<para>If importing for the first time after the switch to <para>If importing for the first time after the switch to
Subversion, flattening and cleaning up the vendor tree is 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> off until the end of the process.</para>
</sect5> </sect5>
<sect5> <sect5>
<title>Cleaning up</title> <title>Cleaning Up</title>
<para>The <literal>dist</literal> tree can be cleaned up <para>The <literal>dist</literal> tree can be cleaned up
as necessary. Disabling keyword expansion is 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> &prompt.root; <userinput>svn commit</userinput></screen>
</sect5> </sect5>
<sect5> <sect5>
<title>Bootstrapping merge history</title> <title>Bootstrapping Merge History</title>
<para>If importing for the first time after the switch to <para>If importing for the first time after the switch to
Subversion, bootstrap Subversion, bootstrap
@ -1533,7 +1533,7 @@ U stable/9/share/man/man4/netmap.4
</sect4> </sect4>
<sect4> <sect4>
<title>Importing new sources</title> <title>Importing New Sources</title>
<para>With two commits&mdash;one for the import itself and <para>With two commits&mdash;one for the import itself and
one for the tag&mdash;this step can optionally be repeated one for the tag&mdash;this step can optionally be repeated
@ -1541,7 +1541,7 @@ U stable/9/share/man/man4/netmap.4
current import.</para> current import.</para>
<sect5> <sect5>
<title>Preparing the vendor sources</title> <title>Preparing the Vendor Sources</title>
<para>Unlike in <acronym>CVS</acronym> where only the needed <para>Unlike in <acronym>CVS</acronym> where only the needed
parts were imported into the vendor tree to avoid bloating 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> will list added files only in <filename>new</filename>.</para>
</sect5> </sect5>
<sect5> <sect5>
<title>Importing into the vendor tree</title> <title>Importing into the Vendor Tree</title>
<para>Now, the sources must be copied into <para>Now, the sources must be copied into
<filename><replaceable>dist</replaceable></filename> and <filename><replaceable>dist</replaceable></filename> and
@ -1627,14 +1627,14 @@ U stable/9/share/man/man4/netmap.4
</sect5> </sect5>
</sect4> </sect4>
<sect4> <sect4>
<title>Merging to head</title> <title>Merging to Head</title>
<screen>&prompt.user; <userinput>cd <replaceable>head/contrib/pf</replaceable></userinput> <screen>&prompt.user; <userinput>cd <replaceable>head/contrib/pf</replaceable></userinput>
&prompt.user; <userinput>svn up</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> &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 <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> will be taken care of manually.</para>
<para>It is necessary to resolve any merge conflicts. <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 Subversion not to complain about files that are in the
vendor tree but not in the main tree, i.e., things that vendor tree but not in the main tree, i.e., things that
would have previously been removed before the vendor 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> and configure scripts.</para>
<para>Using <acronym>CVS</acronym>, once a file was off the <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> until everything builds and runs perfectly.</para>
</sect4> </sect4>
<sect4> <sect4>
<title>Committing the vendor import</title> <title>Committing the Vendor Import</title>
<para>Committing is now possible! Everything must be <para>Committing is now possible! Everything must be
committed in one go. If done properly, the tree will move 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>
<sect4> <sect4>
<title>From scratch</title> <title>From Scratch</title>
<sect5> <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 <para>This section is an example of importing and tagging
<application>byacc</application> into <application>byacc</application> into
@ -1704,7 +1704,7 @@ U stable/9/share/man/man4/netmap.4
</sect5> </sect5>
<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 <para>Due to this being a new file, copy it for the
merge:</para> merge:</para>
@ -1852,7 +1852,7 @@ U stable/9/share/man/man4/netmap.4
<sect3> <sect3>
<title>Maintaining a Project Branch</title> <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 another branch) is used to develop a project then commit it
back to head. In <acronym>SVN</acronym>, back to head. In <acronym>SVN</acronym>,
<quote>dolphin</quote> branching is used for this. A <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 <para>In commit logs etc., <quote>rev 179872</quote> should be
spelled <quote>r179872</quote> as per convention.</para> 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> as this will break the CVS exporter.</para>
<para>Speeding up svn is <para>Speeding up svn is
@ -1940,7 +1940,7 @@ ControlPersist yes</screen>
to do these things for you.)</para> to do these things for you.)</para>
<sect2 id="conventions-committers"> <sect2 id="conventions-committers">
<title>Guidelines For Committers</title> <title>Guidelines for Committers</title>
<note> <note>
<para>The <literal>.ent</literal>, <literal>.xml</literal>, <para>The <literal>.ent</literal>, <literal>.xml</literal>,
@ -1976,7 +1976,7 @@ ControlPersist yes</screen>
</important> </important>
<note> <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> </note>
</listitem> </listitem>
@ -2079,7 +2079,7 @@ ControlPersist yes</screen>
</sect2> </sect2>
<sect2 id="conventions-everyone"> <sect2 id="conventions-everyone">
<title>Guidelines For Everyone</title> <title>Guidelines for Everyone</title>
<para>Whether or not you have commit rights:</para> <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 sure that you run it before running other applications. X
users, for example, usually do this from their users, for example, usually do this from their
<filename>.xsession</filename> or <filename>.xsession</filename> or
<filename>.xinitrc</filename> file. See &man.ssh-agent.1; <filename>.xinitrc</filename>. See &man.ssh-agent.1;
for details.</para> for details.</para>
</step> </step>
@ -3057,9 +3057,9 @@ ControlPersist yes</screen>
<para>The &arch.i386; and &arch.sparc64; platforms were chosen due to being more <para>The &arch.i386; and &arch.sparc64; platforms were chosen due to being more
readily available to developers and as representatives of more readily available to developers and as representatives of more
diverse processor and system designs - big vs little endian, diverse processor and system designs - big versus little endian,
register file vs register stack, different DMA and cache register file versus register stack, different DMA and cache
implementations, hardware page tables vs software TLB management implementations, hardware page tables versus software TLB management
etc.</para> etc.</para>
<para>The &arch.ia64; platform has many of the same complications that <para>The &arch.ia64; platform has many of the same complications that
@ -4099,7 +4099,7 @@ bak/packages packages from last complete &lt;major_version&gt; run on &lt;arch&
</sect1> </sect1>
<sect1 id="non-committers"> <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 <para>A few people who have access to the FreeBSD machines do not
have commit bits. For instance, the project is willing to give have commit bits. For instance, the project is willing to give
@ -4153,7 +4153,7 @@ bak/packages packages from last complete &lt;major_version&gt; run on &lt;arch&
</sect1> </sect1>
<sect1 id="google-analytics"> <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 <para>As of December 12, 2012, &ga; was enabled on the
&os;&nbsp;Project website to collect anonymized usage statistics &os;&nbsp;Project website to collect anonymized usage statistics
@ -4276,11 +4276,6 @@ bak/packages packages from last complete &lt;major_version&gt; run on &lt;arch&
<para>From now on, every new vendor release of that file will <para>From now on, every new vendor release of that file will
need to have patches <emphasis>verified</emphasis> by hand.</para> need to have patches <emphasis>verified</emphasis> by hand.</para>
</listitem> </listitem>
<listitem>
<para>The <option>-j</option> option does not work very well.
Ask &a.obrien; for horror stories.</para>
</listitem>
</itemizedlist> </itemizedlist>
</answer> </answer>
</qandaentry> </qandaentry>
@ -4393,7 +4388,7 @@ bak/packages packages from last complete &lt;major_version&gt; run on &lt;arch&
</informaltable> </informaltable>
<example> <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 <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 Smith containing a patch. The end of the commit message should
@ -4406,7 +4401,7 @@ Submitted by: John Smith &lt;John.Smith@example.com></programlisting>
</example> </example>
<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 <para>You want to change the virtual memory system. You have
posted patches to the appropriate mailing list (in this case, posted patches to the appropriate mailing list (in this case,
@ -4419,7 +4414,7 @@ Reviewed by: -arch</programlisting>
</example> </example>
<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 <para>You want to commit a change to a section of the tree with a
MAINTAINER assigned. You have collaborated with the listed MAINTAINER assigned. You have collaborated with the listed
@ -4434,7 +4429,7 @@ Approved by: <replaceable>abc</replaceable></programlisting>
</example> </example>
<example> <example>
<title>Commit log for a commit bringing in code from <title>Commit Log for a Commit Bringing in Code from
OpenBSD</title> OpenBSD</title>
<para>You want to commit some code based on work done in the <para>You want to commit some code based on work done in the
@ -4446,8 +4441,8 @@ Obtained from: OpenBSD</programlisting>
</example> </example>
<example> <example>
<title>Commit log for a change to &os.current; with a planned <title>Commit Log for a Change to &os.current; with a Planned
commit to &os.stable; to follow at a later date.</title> Commit to &os.stable; to Follow at a Later Date.</title>
<para>You want to commit some code which will be merged from <para>You want to commit some code which will be merged from
&os.current; into the &os.stable; branch after two &os.current; into the &os.stable; branch after two