- Add id attributes to sect1 tags to avoid generating random

file-names.
- Do not embed <screen>, <itemizedlist>, etc. in <para>'s since
  it is rendered with additional horizontal space in the output.
This commit is contained in:
Simon L. B. Nielsen 2004-12-18 13:05:46 +00:00
parent 6a14a6a973
commit 4a4bbecf0d
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=23266

View file

@ -38,7 +38,7 @@
</abstract>
</articleinfo>
<sect1>
<sect1 id="introduction">
<title>Introduction</title>
<para>Most of the open source software projects use
@ -61,7 +61,7 @@
<application>CVS</application>.</para>
</sect1>
<sect1>
<sect1 id="first-setup">
<title>First setup</title>
<warning>
@ -74,11 +74,11 @@
<title>Initializing the repository</title>
<para>The first thing to do when setting up a new repository is to tell
<application>CVS</application> to initialize it:
<application>CVS</application> to initialize it:</para>
<screen>&prompt.user; <userinput>cvs -d <replaceable>path-to-repository</replaceable> init</userinput></screen>
This tells <application>CVS</application> to create the
<para>This tells <application>CVS</application> to create the
<filename>CVSROOT</filename> administrative directory, where all the
customization takes place.</para>
</sect2>
@ -89,16 +89,16 @@
<para>Now we will create the group which will own the repository.
All committers need to be in this group, so that they can write to the
repository. We will assume the FreeBSD default of
<literal>ncvs</literal> for this group.
<literal>ncvs</literal> for this group.</para>
<screen>&prompt.root; <userinput>pw groupadd <replaceable>ncvs</replaceable></userinput></screen>
Next, you should &man.chown.8; the directory to the group
you just added:
<para>Next, you should &man.chown.8; the directory to the group
you just added:</para>
<screen>&prompt.root; <userinput>chown -R :<replaceable>ncvs</replaceable> <replaceable>path-to-your-repository</replaceable></userinput></screen>
This ensures that no one can write to the repository without proper
<para>This ensures that no one can write to the repository without proper
group permissions.</para>
</sect2>
@ -132,14 +132,14 @@
<para>It does not matter if the above paragraph did not make sense to
you&mdash;the end result is the same. Simply check out your
<filename>CVSROOT</filename> and copy the FreeBSD files over your
local (untouched) copies:
local (untouched) copies:</para>
<screen>&prompt.user; <userinput>cvs -d <replaceable>path-to-your-repository</replaceable> checkout CVSROOT</userinput>
&prompt.user; <userinput>cd CVSROOT</userinput>
&prompt.user; <userinput>cp ../CVSROOT-freebsd/* .</userinput>
&prompt.user; <userinput>cvs add *</userinput></screen>
Note that you will probably get a few warnings about some directories
<para>Note that you will probably get a few warnings about some directories
not being copied; this is normal, you do not need those.</para>
</sect2>
@ -410,9 +410,9 @@
<step>
<para>If you do not wish to use the <link linkend="freebsdspecific">
FreeBSD specific features</link> of the scripts, you can safely
remove the <filename>access</filename> file:
remove the <filename>access</filename> file:</para>
<screen>&prompt.user; <userinput>cvs rm -f access</userinput></screen></para>
<screen>&prompt.user; <userinput>cvs rm -f access</userinput></screen>
</step>
<step>
@ -431,7 +431,7 @@
<step>
<para>Edit <filename>cfg_local.pm</filename> to contain the options
you want. In particular, you should take a look at the following
configurable items:
configurable items:</para>
<itemizedlist>
<listitem>
@ -483,7 +483,7 @@
FreeBSD specific modifications to
<application>CVS</application>.</para></note>
You can check <filename>cfg.pm</filename> to see which other
<para>You can check <filename>cfg.pm</filename> to see which other
options can be changed, but the above is a reasonable subset.</para>
</step>
@ -533,10 +533,10 @@
the commitlogs can be stored. By default these are stored in
the repository, in the <filename>commitlogs</filename> subdirectory
of the <filename>CVSROOT</filename> directory. This directory
needs to be created, so do the following:
needs to be created, so do the following:</para>
<screen>&prompt.user; <userinput>mkdir commitlogs</userinput>
&prompt.user; <userinput>cvs add commitlogs</userinput></screen></para>
&prompt.user; <userinput>cvs add commitlogs</userinput></screen>
</step>
</procedure>
@ -545,9 +545,9 @@
<filename>CVSROOT</filename> directory in your
<filename>avail</filename> before you do this, because otherwise you
will lock yourself out. So make sure everything is as you intend, and
then do the following:
then do the following:</para>
<screen>&prompt.user; <userinput>cvs commit -m '<replaceable>- Initial FreeBSD scripts commit</replaceable>'</userinput></screen></para>
<screen>&prompt.user; <userinput>cvs commit -m '<replaceable>- Initial FreeBSD scripts commit</replaceable>'</userinput></screen>
</sect2>
<sect2>
@ -555,11 +555,11 @@
<para>You are ready for the first test: a forced commit to the
<filename>avail</filename> file, to make sure everything works as
expected.
expected.</para>
<screen>&prompt.user; <userinput>cvs commit -f -m '<replaceable>Forced commit to test the new CVSROOT scripts</replaceable>' avail</userinput></screen>
If everything works, congratulations! You now have a working setup
<para>If everything works, congratulations! You now have a working setup
of the FreeBSD scripts for your repository. If
<application>CVS</application> still complains about something, go
back and recheck if all of the above steps have been performed
@ -584,7 +584,6 @@
<sect2>
<title>Files used in the FreeBSD setup</title>
<para>
<itemizedlist>
<listitem>
<para><filename>access</filename> - this file controls access
@ -612,7 +611,6 @@
not have to touch this file.</para>
</listitem>
</itemizedlist>
</para>
</sect2>
<sect2>
@ -646,11 +644,11 @@
<filename>CVSROOT</filename>.</para>
<para>Compile the sources that you edited to include the correct
paths:
paths:</para>
<screen>&prompt.user; <userinput>cc -o cvs cvswrap.c</userinput></screen>
And then install them (you have to be root for this step):
<para>And then install them (you have to be root for this step):</para>
<screen>&prompt.root; <userinput>mv /usr/bin/cvs /usr/bin/ncvs</userinput>
&prompt.root; <userinput>mv cvs /usr/bin/cvs</userinput>
@ -658,7 +656,7 @@
&prompt.root; <userinput>chmod o-rx /usr/bin/ncvs</userinput>
&prompt.root; <userinput>chmod u-w,g+s /usr/bin/cvs</userinput></screen>
This installs the wrapper as the default <command>cvs</command>
<para>This installs the wrapper as the default <command>cvs</command>
command, making sure that anyone who wants to use the repository
has to have the correct access levels.</para>
</step>
@ -675,11 +673,11 @@
<title>Testing the setup</title>
<para>Your wrapper should now be setup. You can of course test this by
making a forced commit to the <filename>access</filename> file:
making a forced commit to the <filename>access</filename> file:</para>
<screen>&prompt.user; <userinput>cvs commit -f -m '<replaceable>Forced commit to test the new CVSROOT scripts</replaceable>' access</userinput></screen>
Again, if this fails, check to see whether all of the above steps have
<para>Again, if this fails, check to see whether all of the above steps have
been executed correctly.</para>
</sect2>
</sect1>