diff options
| author | Paul W. Frields <stickster@gmail.com> | 2007-03-03 00:03:49 +0000 |
|---|---|---|
| committer | Paul W. Frields <stickster@gmail.com> | 2007-03-03 00:03:49 +0000 |
| commit | 9971c4fb180b8c5a744b48ebef5642989a62c589 (patch) | |
| tree | f219d2002cd644a7438028181b1de11442968b57 /en_US | |
| parent | f10317a442d418d07ce934797abfa1e91eb955d8 (diff) | |
| download | documentation-guide-9971c4fb180b8c5a744b48ebef5642989a62c589.tar.gz documentation-guide-9971c4fb180b8c5a744b48ebef5642989a62c589.tar.xz documentation-guide-9971c4fb180b8c5a744b48ebef5642989a62c589.zip | |
Better hinting for choosing module names; caution about using distro name redundantly
Diffstat (limited to 'en_US')
| -rw-r--r-- | en_US/getting-files.xml | 24 |
1 files changed, 18 insertions, 6 deletions
diff --git a/en_US/getting-files.xml b/en_US/getting-files.xml index c86a6d4..6104eb4 100644 --- a/en_US/getting-files.xml +++ b/en_US/getting-files.xml @@ -79,7 +79,7 @@ cvs co docs-common</userinput> <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 @@ cvs co docs-common</userinput> 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> |