Add a role="directory" attribute to all the <filename> elements that

reference directory paths.
This commit is contained in:
Giorgos Keramidas 2006-01-23 00:48:35 +00:00
parent 70899d41c6
commit 4b0a76e253
Notes: svn2git 2020-12-08 03:00:23 +00:00
svn path=/head/; revision=26933

View file

@ -79,7 +79,7 @@
<screen>&prompt.user; <userinput>cvs -d <replaceable>path-to-repository</replaceable> init</userinput></screen> <screen>&prompt.user; <userinput>cvs -d <replaceable>path-to-repository</replaceable> init</userinput></screen>
<para>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 <filename role="directory">CVSROOT</filename> administrative directory, where all the
customization takes place.</para> customization takes place.</para>
</sect2> </sect2>
@ -105,25 +105,25 @@
<sect2> <sect2>
<title>Getting the sources</title> <title>Getting the sources</title>
<para>Now you need to obtain the <filename>CVSROOT</filename> directory <para>Now you need to obtain the <filename role="directory">CVSROOT</filename> directory
from the FreeBSD repository. This is most easily done by checking it from the FreeBSD repository. This is most easily done by checking it
out from a FreeBSD anonymous CVS mirror. See <ulink out from a FreeBSD anonymous CVS mirror. See <ulink
url="&url.books.handbook;/anoncvs.html">the relevant chapter in url="&url.books.handbook;/anoncvs.html">the relevant chapter in
the handbook</ulink> for more information. Let us assume that the the handbook</ulink> for more information. Let us assume that the
sources are stored in <filename>CVSROOT-freebsd</filename> in the sources are stored in <filename role="directory">CVSROOT-freebsd</filename> in the
current directory.</para> current directory.</para>
</sect2> </sect2>
<sect2> <sect2>
<title>Copying the FreeBSD scripts</title> <title>Copying the FreeBSD scripts</title>
<para>Next, we will copy the FreeBSD <filename>CVSROOT</filename> <para>Next, we will copy the FreeBSD <filename role="directory">CVSROOT</filename>
sources into your own repository. If you are accustomed to sources into your own repository. If you are accustomed to
<application>CVS</application>, you might be thinking that you can just <application>CVS</application>, you might be thinking that you can just
import the scripts, in an attempt to make synchronizing with later import the scripts, in an attempt to make synchronizing with later
versions easier. However, it turns out that versions easier. However, it turns out that
<application>CVS</application> has a deficiency in this area: <application>CVS</application> has a deficiency in this area:
when importing sources into the <filename>CVSROOT</filename> directory, when importing sources into the <filename role="directory">CVSROOT</filename> directory,
it will not update the needed administrative files. In order to make it will not update the needed administrative files. In order to make
it recognize those, you will need to checkin each file after importing it recognize those, you will need to checkin each file after importing
them, losing the value of <literal>cvs import</literal>. Therefore, them, losing the value of <literal>cvs import</literal>. Therefore,
@ -131,7 +131,7 @@
<para>It does not matter if the above paragraph did not make sense to <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 you&mdash;the end result is the same. Simply check out your
<filename>CVSROOT</filename> and copy the FreeBSD files over your <filename role="directory">CVSROOT</filename> and copy the FreeBSD files over your
local (untouched) copies:</para> local (untouched) copies:</para>
<screen>&prompt.user; <userinput>cvs -d <replaceable>path-to-your-repository</replaceable> checkout CVSROOT</userinput> <screen>&prompt.user; <userinput>cvs -d <replaceable>path-to-your-repository</replaceable> checkout CVSROOT</userinput>
@ -163,7 +163,7 @@
<para><filename>avail</filename> - this file controls access to the <para><filename>avail</filename> - this file controls access to the
repository. In this, you can specify groups of people that are repository. In this, you can specify groups of people that are
allowed access to the repository, as well as disallow commits on a allowed access to the repository, as well as disallow commits on a
per-directory basis. You should tailor it to contain the groups per-directory or per-file basis. You should tailor it to contain the groups
and directories that will be in your repository.</para> and directories that will be in your repository.</para>
</listitem> </listitem>
@ -276,7 +276,7 @@
match one of the lines in this file are exempted from this check. match one of the lines in this file are exempted from this check.
You should add expressions to this file as you checkin files that You should add expressions to this file as you checkin files that
cannot have a revision header. For the purpose of installing the cannot have a revision header. For the purpose of installing the
scripts, it may be best to exclude <filename>CVSROOT/</filename> scripts, it may be best to exclude <filename role="directory">CVSROOT/</filename>
from header checks.</para> from header checks.</para>
</listitem> </listitem>
@ -465,7 +465,7 @@
<para><literal>@LOG_FILE_MAP</literal> - change this array <para><literal>@LOG_FILE_MAP</literal> - change this array
as you wish - each regexp is matched on the directory of as you wish - each regexp is matched on the directory of
the commit, and the commit log message gets stored in the commit, and the commit log message gets stored in
the <filename>commitlogs</filename> subdirectory in the <filename role="directory">commitlogs</filename> subdirectory in
the filename mentioned.</para> the filename mentioned.</para>
</listitem> </listitem>
@ -494,7 +494,7 @@
<literal>^CVSROOT/</literal>, and add one line with only <literal>^CVSROOT/</literal>, and add one line with only
<literal>^CVSROOT/</literal> on it. After the wrapper is <literal>^CVSROOT/</literal> on it. After the wrapper is
installed, you can add your header to the files in the installed, you can add your header to the files in the
<filename>CVSROOT</filename> directory and restore these lines, <filename role="directory">CVSROOT</filename> directory and restore these lines,
but for now they will only be in the way when you try to commit but for now they will only be in the way when you try to commit
later on.</para> later on.</para>
</step> </step>
@ -532,7 +532,7 @@
<para>The last thing to do before you are finished, is to make sure <para>The last thing to do before you are finished, is to make sure
the commitlogs can be stored. By default these are stored in the commitlogs can be stored. By default these are stored in
the repository, in the <filename>commitlogs</filename> subdirectory the repository, in the <filename>commitlogs</filename> subdirectory
of the <filename>CVSROOT</filename> directory. This directory of the <filename role="directory">CVSROOT</filename> directory. This directory
needs to be created, so do the following:</para> needs to be created, so do the following:</para>
<screen>&prompt.user; <userinput>mkdir commitlogs</userinput> <screen>&prompt.user; <userinput>mkdir commitlogs</userinput>
@ -542,7 +542,7 @@
<para>Now, after careful review, you should commit your changes. Be <para>Now, after careful review, you should commit your changes. Be
sure that you have granted yourself access to the sure that you have granted yourself access to the
<filename>CVSROOT</filename> directory in your <filename role="directory">CVSROOT</filename> directory in your
<filename>avail</filename> before you do this, because otherwise you <filename>avail</filename> before you do this, because otherwise you
will lock yourself out. So make sure everything is as you intend, and will lock yourself out. So make sure everything is as you intend, and
then do the following:</para> then do the following:</para>
@ -571,8 +571,8 @@
<title>FreeBSD specific setup</title> <title>FreeBSD specific setup</title>
<para>The FreeBSD project itself uses a slightly different setup, which <para>The FreeBSD project itself uses a slightly different setup, which
also uses files from the <filename>freebsd</filename> subdirectory of also uses files from the <filename role="directory">freebsd</filename> subdirectory of
the FreeBSD <filename>CVSROOT</filename>. The project uses this because the FreeBSD <filename role="directory">CVSROOT</filename>. The project uses this because
of the large number of committers, which all would have to be in the of the large number of committers, which all would have to be in the
same group. So, a simple wrapper was written which ensures that people same group. So, a simple wrapper was written which ensures that people
have the correct credentials to commit, and then sets the group id have the correct credentials to commit, and then sets the group id
@ -641,7 +641,7 @@
<para>Next up is installing the wrapper to ensure you become the <para>Next up is installing the wrapper to ensure you become the
correct group when committing. The sources for this live in correct group when committing. The sources for this live in
<filename>cvswrap.c</filename> in your <filename>cvswrap.c</filename> in your
<filename>CVSROOT</filename>.</para> <filename role="directory">CVSROOT</filename>.</para>
<para>Compile the sources that you edited to include the correct <para>Compile the sources that you edited to include the correct
paths:</para> paths:</para>