Round 2 (of 3) of committers-guide changes. Markup fixes and

output-significant whitespace changes.

Approved by:	jhb
This commit is contained in:
Bruce A. Mah 2002-04-28 18:04:46 +00:00
parent 78d5cb767a
commit 02da3723b9
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=12893

View file

@ -76,7 +76,7 @@
<row>
<entry><emphasis>Noteworthy CVS Tags</emphasis></entry>
<entry>RELENG_4 (4.x-STABLE), HEAD (-CURRENT)</entry>
<entry><literal>RELENG_4</literal> (4.x-STABLE), <literal>HEAD</literal> (-CURRENT)</entry>
</row>
</tbody>
</tgroup>
@ -166,7 +166,7 @@
modification of it for the purposes of cleanup or fixing some
grievous abuse of CVS by a committer. No one else should
attempt to touch the repository directly. Should you cause some
repository accident, say a bad cvs import or tag operation, do
repository accident, say a bad <command>cvs import</command> or <command>cvs tag</command> operation, do
<emphasis role="bold">not</emphasis> attempt to fix it yourself!
Mail the &a.cvs; (or call one of them) and report the problem to
one of them instead. The only ones allowed to directly fiddle
@ -178,7 +178,7 @@
<filename>/home/ncvs</filename>, and then doing the appropriate
check-out/check-in operations. If you wish to add
something which is wholly new (like contrib-ified
sources, etc), a script called <quote>easy-import</quote> is
sources, etc), a script called <filename>easy-import</filename> is
also provided for making the process easier. It automatically
adds the new module entry, does the appropriate thing with
<command>cvs import</command>, etc. &ndash; just run it without
@ -200,7 +200,7 @@
pretty studly with CVS in general, you can also do CVS
operations directly from your own machine and local working
sources. Just remember to set <envar>CVS_RSH</envar> to
<wordasword>ssh</wordasword> so that you are using a relatively
<literal>ssh</literal> so that you are using a relatively
secure and reliable transport. If you have no idea what any of
the above even means, on the other hand, then please stick with
logging into <hostid>freefall</hostid> and applying your diffs
@ -208,7 +208,7 @@
<para>If you need to use CVS <command>add</command> and
<command>delete</command> operations in a manner that is
effectively a <quote>mv</quote> operation, then a repository
effectively a &man.mv.1; operation, then a repository
copy is in order rather than using CVS <command>add</command> and
<command>delete</command>. In a repository copy, a <link
linkend="conventions">CVS Meister</link> will copy the file(s)
@ -338,7 +338,7 @@
<screen>&prompt.user; <userinput>cvs co -rRELENG_3_4_0_RELEASE miscfs</userinput></screen>
<para>You will not be able to commit modifications, since
RELENG_3_4_0_RELEASE is a point in time, not a branch.</para>
<literal>RELENG_3_4_0_RELEASE</literal> is a point in time, not a branch.</para>
</listitem>
<listitem>
@ -583,11 +583,11 @@
</itemizedlist>
<para>You will almost certainly get a conflict because
of the <literal>$Id: article.sgml,v 1.109 2002-04-28 17:55:20 bmah Exp $</literal> (or in FreeBSD's case,
of the <literal>$Id: article.sgml,v 1.110 2002-04-28 18:04:46 bmah Exp $</literal> (or in FreeBSD's case,
<literal>$<!-- stop expansion -->FreeBSD<!-- stop expansion -->$</literal>) lines, so you will have to edit
the file to resolve the conflict (remove the marker lines and
the second <literal>$Id: article.sgml,v 1.109 2002-04-28 17:55:20 bmah Exp $</literal> line, leaving the original
<literal>$Id: article.sgml,v 1.109 2002-04-28 17:55:20 bmah Exp $</literal> line intact).</para>
the second <literal>$Id: article.sgml,v 1.110 2002-04-28 18:04:46 bmah Exp $</literal> line, leaving the original
<literal>$Id: article.sgml,v 1.110 2002-04-28 18:04:46 bmah Exp $</literal> line intact).</para>
</listitem>
<listitem>
@ -840,14 +840,14 @@ checkout -P</programlisting>
<screen>&prompt.user; <userinput>cvs diff -Nu shazam | cdiff</userinput></screen>
<para>Alternatively some editors like &man.vim.1;
(ports/editors/vim5) have color support and when used as
(<filename role="package">editors/vim5</filename>) have color support and when used as
a pager with color syntax highlighting switched on will
highlight many types of file, including diffs, patches,
and cvs/rcs logs. </para>
<screen>&prompt.user; <userinput> echo "syn on" >> ~/.vimrc </userinput>
&prompt.user; <userinput> cvs diff -Nu shazam | vim -</userinput>
&prompt.user; <userinput> cvs log shazam | vim -</userinput> </screen>
<screen>&prompt.user; <userinput>echo "syn on" &gt;&gt; ~/.vimrc </userinput>
&prompt.user; <userinput>cvs diff -Nu shazam | vim -</userinput>
&prompt.user; <userinput>cvs log shazam | vim -</userinput> </screen>
</listitem>
<listitem>
@ -861,7 +861,7 @@ checkout -P</programlisting>
<listitem>
<para>Do not leave the <command>cvs commit</command> command in commit
message editing mode for too long (more than 2-3 minutes). It
message editing mode for too long (more than 2&ndash;3 minutes). It
locks the directory you are working with and will prevent other
developers from committing into the same directory. If you have
to type a long commit message, type it before executing
@ -1123,7 +1123,7 @@ docs:Documentation Bug:nik:</programlisting>
<screen>&prompt.root; <userinput>query-pr -c docs -s open</userinput></screen>
<para>Other interfaces, such as that provided by the
<filename>ports/databases/tkgnats</filename> port should also work
<filename role="package">databases/tkgnats</filename> port should also work
nicely.</para>
</step>
@ -1364,10 +1364,10 @@ docs:Documentation Bug:nik:</programlisting>
OpenSSH is included in the base system.
If you are using an earlier release,
update and install one of the SSH ports. In general,
you will probably want to get OpenSSH from the port in
<filename>/usr/ports/security/openssh</filename>. You
may also wish to check out the original ssh1 in
<filename>/usr/ports/security/ssh</filename>, but make
you will probably want to get OpenSSH from the
<filename role="package">security/openssh</filename> port. You
may also wish to check out the original ssh1 in the
<filename role="package">security/ssh</filename> port, but make
certain you pay attention to its license. Note that both
of these ports cannot be installed at the same time.</para>
</step>
@ -1414,7 +1414,7 @@ docs:Documentation Bug:nik:</programlisting>
freefall.FreeBSD.org ls /usr</command>.</para>
<para>For more information, see
<filename>/usr/ports/security/openssh</filename>, &man.ssh.1;,
<filename role="package">security/openssh</filename>, &man.ssh.1;,
&man.ssh-add.1;, &man.ssh-agent.1;, &man.ssh-keygen.1;, and
&man.scp.1;.</para>
</sect1>