summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPaul W. Frields <stickster@gmail.com>2005-08-24 12:30:26 +0000
committerPaul W. Frields <stickster@gmail.com>2005-08-24 12:30:26 +0000
commitee20ed8cbd098f2453fcda517a786d314823a8dc (patch)
tree34e2919873b3ee569e1ca1bd1c7b9dde4b16fbd7
parent73a88376f8ef694474e82b497882c281df88e274 (diff)
downloaddocumentation-guide-ee20ed8cbd098f2453fcda517a786d314823a8dc.tar.gz
documentation-guide-ee20ed8cbd098f2453fcda517a786d314823a8dc.tar.xz
documentation-guide-ee20ed8cbd098f2453fcda517a786d314823a8dc.zip
Clean up CVS instructions a bit, removing excess tagging in screens, some style changes
-rw-r--r--docs-getting-files-en.xml39
1 files changed, 18 insertions, 21 deletions
diff --git a/docs-getting-files-en.xml b/docs-getting-files-en.xml
index dd6c773..e289d05 100644
--- a/docs-getting-files-en.xml
+++ b/docs-getting-files-en.xml
@@ -32,34 +32,31 @@
<para>
The custom scripts and stylesheets used are all stored in CVS on the
<computeroutput>cvs.fedora.redhat.com</computeroutput> CVS server.
- </para>
-
- <para>
You need to check them out along with the DocBook XML files for the
existing docs.
</para>
<para>
- Get started by following these once-only steps.
- When asked for a <abbrev>CVS</abbrev> password, just press the <guibutton>ENTER</guibutton> key.
+ You should perform these steps only once, when you first make a checkout
+ from docs CVS. When you see the password prompt, just press the
+ <keycap>Enter</keycap> key.
</para>
<screen>
-<prompt>$ </prompt><command>mkdir my-fedora-docs</command>
-<prompt>$ </prompt><command>cd my-fedora-docs</command>
-<prompt>$ </prompt><command>export CVSROOT=:pserver:anonymous@cvs.fedora.redhat.com:/cvs/docs</command>
-<prompt>$ </prompt><command>cvs login</command>
-&lt;enter&gt;
-<prompt>$ </prompt><command>cvs co docs-setup</command>
+<userinput>mkdir my-fedora-docs
+cd my-fedora-docs
+export CVSROOT=:pserver:anonymous@cvs.fedora.redhat.com:/cvs/docs
+cvs login
+cvs co docs-setup</userinput>
</screen>
<para>
- Checking the files out anonymously means that you can view them and
- retreive the latest versions, but you can not add (commit) any updates or
- new files back to the repository.
- You need <abbrev>CVS</abbrev> write access for that; check with the
- <ulink url="http://fedoraproject.org/wiki/DocsProject/NewWriters"><filename>http://fedoraproject.org/wiki/DocsProject/NewWriters</filename></ulink>
- site to learn about getting write access to <abbrev>CVS</abbrev>.
+ When you perform an anonymous CVS checkout, you can view the files and
+ retreive the latest versions. You can not add (commit) any updates or new
+ files back to the repository. To commit changes to CVS, you must have
+ <abbrev>CVS</abbrev> write access. Refer to <ulink
+ url="http://fedoraproject.org/wiki/DocsProject/NewWriters"/> to learn
+ about getting write access to <abbrev>CVS</abbrev>.
</para>
<para>
@@ -72,12 +69,12 @@
Pick your document of interest and then download it to your working directory:
</para>
-<screen><prompt>$ </prompt><command>cvs co example-tutorial</command></screen>
+<screen><userinput>cvs co example-tutorial</userinput></screen>
<para>
- Except for the <citetitle>&IG;</citetitle>, all docs must be tutorials
- written in DocBook XML article format using the template in the
- <filename>example-tutorial</filename> directory. Each tutorial
+ Except for the <citetitle>&IG;</citetitle>, all documentation in CVS must
+ be tutorials written in DocBook XML article format using the template in
+ the <filename>example-tutorial</filename> directory. Each tutorial
<emphasis>must</emphasis> be in its own directory. No XML files should be
in the root directory.
</para>