Author: pfrields
Update of /cvs/docs/documentation-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv2887/en_US
Modified Files:
getting-files.xml
Log Message:
Better hinting for choosing module names; caution about using distro name redundantly
Index: getting-files.xml
===================================================================
RCS file: /cvs/docs/documentation-guide/en_US/getting-files.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- getting-files.xml 3 Feb 2007 22:21:58 -0000 1.1
+++ getting-files.xml 3 Mar 2007 00:03:49 -0000 1.2
@@ -79,7 +79,7 @@
<section id="ch-getting-files-filenames">
<title>Filename Conventions</title>
<para>
- &FDP; provides the tools, scripts, and stylesheets to transform your
+ The &FDP; provides the tools, scripts, and stylesheets to transform your
<abbrev>XML</abbrev> documents into other output formats such as
<abbrev>HTML</abbrev>. In addition, these tools can build your
document
into a <abbrev>RPM</abbrev> package. To take advantage of these
@@ -91,16 +91,28 @@
Each document lives in a peer directory to the
<filename>docs-common</filename> directory you extracted from the
&FED;
archive earlier. On the CVS server, these directories are called
- <firstterm>modules</firstterm>. Choose a module name that
accurately
- reflects your document's subject, but avoid any name already taken. Use
+ <firstterm>modules</firstterm>. Use
the <command>cvs co -c</command> command to view existing module
names.
</para>
+ <example>
+ <title>Partial List of CVS Modules</title>
+ <screen><userinput>cd ~/localrepo/fedora-docs/</userinput>
+<computeroutput>build-docs infrastructure/build-docs
+cvsroot CVSROOT
+desktop-up2date desktop-up2date
+developer-guide developer-guide
+docs .
+docs-common docs-common
+documentation-guide documentation-guide
+example-tutorial example-tutorial</computeroutput></screen>
+ </example>
+ <para>Choose a module name that accurately reflects your
+ document's subject, but avoid any name already taken.</para>
<important>
<title>Avoid Redundancy</title>
<para>
- Do not use the word <wordasword>&FED;</wordasword> in your module
- name. Since all documents in the repository are &FED; documentation,
- using this term creates unnecessary confusion.
+ Do not use the word <wordasword>&FED;</wordasword> to name
+ modules in the &FDP; CVS repository.
</para>
</important>
</section>
Show replies by date