[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Request for Review: APT manpages



Next in alphabetical order, apt-cdrom.8.xml:

[...]
>  <refsect1><title>Description</title>
>    <para><command>apt-cdrom</command> is used to add a new CDROM to APTs list
                                                               ^         ^
Missing hyphen in "CD-ROM" (yes, the dictionary says there's a
hyphen, even though it's usually written solid and lowercase in
variable-names and so on); missing possessive apostrophe in "APT's".

There should probably be a mention somewhere of DVD/BD/etc media,
and here is the obvious place for it - maybe something like:

     <para><command>apt-cdrom</command> is used to add new media
     (such as CD-ROMs or DVDs) to APT's list

(But that's not in my patch.)

>     of available sources. <command>apt-cdrom</command> takes care of
>    determining the structure of
>    the disc as well as correcting for several possible mis-burns and 
>    verifying the index files.   
>    </para>
> 
>    <para>It is necessary to use <command>apt-cdrom</command> to add CDs to the
>    APT system, 
               ^
This is a "run-on" sentence, and should in principle have at least a
semicolon here. 

>    it cannot be done by hand. Furthermore each disk in a multi-cd set must be
                                                    ^            ^^
                                                    c            CD

>    inserted and scanned separately to account for possible mis-burns.
>    </para>
>
>    <para>Unless the <option>-h</option>, or <option>--help</option> option is
>     given one of the commands below must be present.
>    
>     <variablelist>
>      <varlistentry><term><option>add</option></term>
>      <listitem><para><literal>add</literal> is used to add a new disc to the
>      source list. It will unmount the
>      CDROM device, prompt for a disk to be inserted and then proceed to 
         ^                           ^
       CD-ROM                     disc

>      scan it and copy the index files. If the disc does not have a proper
>      <filename>disk</filename> directory you will be prompted for a descriptive 
>      title.
>      </para>

Is that really a "<filename>disk</filename> directory" or is this a
typo?

[...]
>    <variablelist>
>      <varlistentry><term><option>-d</option></term><term><option>--cdrom</option></term>
>      <listitem><para>Mount point; specify the location to mount the cdrom. This
                                                                      ^^^^^
                                                                      CD-ROM

>       mount point must be listed in <filename>/etc/fstab</filename> and
>       properly configured.
>       Configuration Item: <literal>Acquire::cdrom::mount</literal>.
>      </para>
>      </listitem>
>      </varlistentry>
>      
>      <varlistentry><term><option>-r</option></term><term><option>--rename</option></term>
>      <listitem><para>Rename a disc; change the label of a disk or override the
                                                               ^
                                                               c
>       disks given label. This option will cause <command>apt-cdrom</command> to
           ^^
        disc's

[...]
>      <varlistentry><term><option>-a</option></term><term><option>--thorough</option></term>
>      <listitem><para>Thorough Package Scan; This option may be needed with some
>       old Debian 1.1/1.2 discs that have Package files in strange places. It 
>       takes much longer to scan the CD but will pick them all up.

As it happens I've got a Debian 1.2 CD, but I wouldn't expect
current APT to support installing things off it!
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- old/apt-cdrom.8.xml	2012-05-21 10:41:17.000000000 +0100
+++ new/apt-cdrom.8.xml	2012-05-24 20:27:42.095392687 +0100
@@ -29,13 +29,13 @@
  <!-- Man page title -->
  <refnamediv>
     <refname>apt-cdrom</refname>
-    <refpurpose>APT CDROM management utility</refpurpose>
+    <refpurpose>APT CD-ROM management utility</refpurpose>
  </refnamediv>
 
  &synopsis-command-apt-cdrom;
 
  <refsect1><title>Description</title>
-   <para><command>apt-cdrom</command> is used to add a new CDROM to APTs list
+   <para><command>apt-cdrom</command> is used to add a new CD-ROM to APT's list
     of available sources. <command>apt-cdrom</command> takes care of
    determining the structure of
    the disc as well as correcting for several possible mis-burns and 
@@ -43,8 +43,8 @@
    </para>
 
    <para>It is necessary to use <command>apt-cdrom</command> to add CDs to the
-   APT system, 
-   it cannot be done by hand. Furthermore each disk in a multi-cd set must be
+   APT system; 
+   it cannot be done by hand. Furthermore each disc in a multi-CD set must be
    inserted and scanned separately to account for possible mis-burns.
    </para>
 
@@ -55,13 +55,13 @@
      <varlistentry><term><option>add</option></term>
      <listitem><para><literal>add</literal> is used to add a new disc to the
      source list. It will unmount the
-     CDROM device, prompt for a disk to be inserted and then proceed to 
+     CD-ROM device, prompt for a disc to be inserted and then proceed to
      scan it and copy the index files. If the disc does not have a proper
-     <filename>disk</filename> directory you will be prompted for a descriptive 
+     <filename>disc</filename> directory you will be prompted for a descriptive
      title.
      </para>
 
-     <para>APT uses a CDROM ID to track which disc is currently in the drive and
+     <para>APT uses a CD-ROM ID to track which disc is currently in the drive and
      maintains a database of these IDs in 
      <filename>&statedir;/cdroms.list</filename>
      </para>
@@ -83,7 +83,7 @@
    
    <variablelist>
      <varlistentry><term><option>-d</option></term><term><option>--cdrom</option></term>
-     <listitem><para>Mount point; specify the location to mount the cdrom. This
+     <listitem><para>Mount point; specify the location to mount the CD-ROM. This
       mount point must be listed in <filename>/etc/fstab</filename> and
       properly configured.
       Configuration Item: <literal>Acquire::cdrom::mount</literal>.
@@ -92,8 +92,8 @@
      </varlistentry>
      
      <varlistentry><term><option>-r</option></term><term><option>--rename</option></term>
-     <listitem><para>Rename a disc; change the label of a disk or override the
-      disks given label. This option will cause <command>apt-cdrom</command> to
+     <listitem><para>Rename a disc; change the label of a disc or override the
+      disc's given label. This option will cause <command>apt-cdrom</command> to
       prompt for a new label.
      Configuration Item: <literal>APT::CDROM::Rename</literal>.
      </para>

Attachment: apt-cdrom.8.xml
Description: XML document


Reply to: