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

Re: Request for Review: APT manpages



Two easy ones today: apt-key.8.xml and apt-mark.8.xml.

Apt-key:
[...]
>      <varlistentry><term><option>net-update</option></term>
>      <listitem>
>      <para>
> 
>        Work similar to the <command>update</command> command above, but get the
>        archive keyring from an URI instead and validate it against a master key.

(s/similar/similarly/, s/an URI/a URI/)

Uninflected "work" may be parallel to "add" and "output" and so on,
but it doesn't quite make sense.  The meaning of the "add" command is
"add a new key, please", but you're not ordering net-update to "work
like the update command!" - the best I can come up with is:

         Perform an update working similarly to the <command>update</command> command above,
         but get the archive keyring from a URI instead and validate it against a master key.

>        This requires an installed &wget; and an APT build configured to have
>        a server to fetch from and a master keyring to validate.
> 
>        APT in Debian does not support this command and relies on
>        <command>update</command> instead, but Ubuntu's APT does.

The "relies" is a positive verb, and ruins the contrast of "but
Ubuntu's APT does"; say

         APT in Debian does not support this command, relying on
         <command>update</command> instead, but Ubuntu's APT does.

[...]
>    <variablelist>
>       <varlistentry><term><option>--keyring</option> <option>&synopsis-param-filename;</option></term>
>       <listitem><para>With this option it is possible to specify a specific keyring
>       file the command should operate on. The default is that a command is executed

Just to make it slightly less repetitive, "specify a particular
keyring".

And apt-mark:
[...]
>        <varlistentry><term><option>hold</option></term>
> 	 <listitem><para><literal>hold</literal> is used to mark a
>        package as hold back, which will prevent the package from being

s/hold/held/

>        automatically installed, upgraded or removed.
>        The command is only a wrapper around <command>dpkg --set-selections</command>
>        and the state is therefore maintained by &dpkg; and not effected

s/effected/affected/

>        by the <option>--filename</option> option.
>        </para></listitem>
>        </varlistentry>
[...]
>        <varlistentry><term><option>showmanual</option></term>

Ooh, new in Wheezy, thanks.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
--- old/apt-key.8.xml	2012-05-21 10:41:17.000000000 +0100
+++ new/apt-key.8.xml	2012-05-27 16:52:50.815392399 +0100
@@ -141,13 +141,13 @@
      <listitem>
      <para>
 
-       Work similar to the <command>update</command> command above, but get the
-       archive keyring from an URI instead and validate it against a master key.
+       Perform an update working similarly to the <command>update</command> command above,
+       but get the archive keyring from a URI instead and validate it against a master key.
 
        This requires an installed &wget; and an APT build configured to have
        a server to fetch from and a master keyring to validate.
 
-       APT in Debian does not support this command and relies on
+       APT in Debian does not support this command, relying on
        <command>update</command> instead, but Ubuntu's APT does.
 
      </para>
@@ -161,7 +161,7 @@
 <para>Note that options need to be defined before the commands described in the previous section.</para>
    <variablelist>
       <varlistentry><term><option>--keyring</option> <option>&synopsis-param-filename;</option></term>
-      <listitem><para>With this option it is possible to specify a specific keyring
+      <listitem><para>With this option it is possible to specify a particular keyring
       file the command should operate on. The default is that a command is executed
       on the <filename>trusted.gpg</filename> file as well as on all parts in the
       <filename>trusted.gpg.d</filename> directory, though <filename>trusted.gpg</filename>

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

--- old/apt-mark.8.xml	2012-05-21 10:41:17.000000000 +0100
+++ new/apt-mark.8.xml	2012-05-27 17:02:00.803392449 +0100
@@ -66,10 +66,10 @@
 
        <varlistentry><term><option>hold</option></term>
 	 <listitem><para><literal>hold</literal> is used to mark a
-       package as hold back, which will prevent the package from being
+       package as held back, which will prevent the package from being
        automatically installed, upgraded or removed.
        The command is only a wrapper around <command>dpkg --set-selections</command>
-       and the state is therefore maintained by &dpkg; and not effected
+       and the state is therefore maintained by &dpkg; and not affected
        by the <option>--filename</option> option.
        </para></listitem>
        </varlistentry>

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


Reply to: