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

Re: Request for Review: APT manpages



David Kalnischkies wrote:
> You might still remember the last time we talked about apt manpages:

I have machines to do that for me.

[...]
> The pages in question would be (direct link to the current git version
> in docbook format as attaching all probably kills the mail):
> https://anonscm.debian.org/cgit/apt/apt.git/plain/doc/apt.8.xml
> https://anonscm.debian.org/cgit/apt/apt.git/plain/doc/apt-secure.8.xml
> https://anonscm.debian.org/cgit/apt/apt.git/plain/doc/sources.list.5.xml
> https://anonscm.debian.org/cgit/apt/apt.git/plain/doc/apt-mark.8.xml

Okay, I'll look at those later today.

[...]
> And finally to whet your appetite I attached a pseudo-po file which
> contains some program strings we have recently added/changed in src:apt
> where a review wouldn't hurt either.

Here goes...

> #: apt-private/private-cmndline.cc
> #, c-format
> msgid "See %s for more information about the available commands."
> msgstr ""
> 
> #: apt-private/private-cmndline.cc
> msgid ""
> "Configuration options and syntax is detailed in apt.conf(5).\n"

Agreement error - s/is/are/

> "Information about how to configure sources can be found in sources.list(5).\n"
> "Package and version choices can be expressed via apt_preferences(5).\n"
> "Security details are available in apt-secure(8).\n"
> msgstr ""
> 
> #: apt-private/private-download.cc apt-private/private-install.cc
> msgid ""
> "--force-yes is deprecated, use one of the options starting with --allow "
> "instead."
> msgstr ""

Comma splice - s/,/;/
 
> #: apt-private/private-install.cc
> msgid ""
> "Held packages were changed and -y was used without --allow-change-held-"
> "packages."
> msgstr ""
> 
> #: cmdline/apt-cache.cc
> msgid ""
> "Usage: apt-cache [options] command\n"
> "       apt-cache [options] show pkg1 [pkg2 ...]\n"
> "\n"
> "apt-cache queries and displays available information about installed\n"
> "as well as installable packages. It works exclusively on the data\n"
> "acquired via the 'update' command of e.g. apt-get to the local cache.\n"
> "The displayed information can therefore be outdated if the last update\n"
> "is too long ago, but in exchange apt-cache works independently of the\n"
> "availability of the configured sources (e.g. offline).\n"
> msgstr ""

"X as well as Y" normally (when X and Y are similarly lightweight)
introduces the more "surprising" item first, which if anything would
be "installable"; here I think you might as well stick to plain "and".

It's not obvious how the phrase "to the local cache" fits in here.
Does it mean "acquired (in)to the local cache via [...]"?

When describing a risk, "may" is more likely than "can".

The present tense in "if the last update is too long ago" is logical
but I'm not sure it's idiomatic; I think I'd say "was" (thinking of
it as meaning "occurred").

"In exchange" is a bit odd too, but at least it's short and clear.

If I could see an easy way to get rid of one of the "e.g."s I'd take
it, but never mind.

So my revised version:

 "apt-cache queries and displays available information about installed\n"
 "and installable packages. It works exclusively on the data acquired\n"
 "into the local cache via the 'update' command of e.g. apt-get. The\n"
 "displayed information may therefore be outdated if the last update was\n"
 "too long ago, but in exchange apt-cache works independently of the\n"
 "availability of the configured sources (e.g. offline).\n"

> 
> #: cmdline/apt.cc
> msgid ""
> "Usage: apt [options] command\n"
> "\n"
> "apt is a commandline package manager and provides commands for\n"
> "searching and managing as well as querying information about packages.\n"
> "It provides the same functionality as the specialized APT tools,\n"
> "like apt-get and apt-cache, but enables options more suitable for\n"
> "interactive use by default.\n"
> msgstr ""

Which specialised APT tools are like apt-get and apt-cache?  apt
doesn't provide the same functionality as apt-mark, for instance, does
it?  If it's intended as an exhaustive list I would recommend just

                                  "[...] the specialized APT tools\n"
  "apt-get and apt-cache, [...]

If we're allowing for the possibility that it *will* swallow apt-mark,
then I suppose that's

                                  "[...] the specialized APT tools,\n"
  "such as apt-get and apt-cache, [...]
 
> #: cmdline/apt-cdrom.cc
> msgid ""
> "Usage: apt-cdrom [options] command\n"
> "\n"
> "apt-cdrom is used to add CDROM's, USB flashdrives and other removable\n"
> "media types as package sources to APT. The mount point and device\n"
> "information is taken from apt.conf(5), udev(7) and fstab(5).\n"
> msgstr ""

I normally recommend not putting an apostrophe in "CDROMs", but for
consistency with apt-cdrom's existing messages I'll leave it.
Similarly, you've got two lists that could take an extra "Harvard
comma" here, but if you're consistently not using that standard then
never mind.

> 
> #: cmdline/apt-config.cc
> msgid ""
> "Usage: apt-config [options] command\n"
> "\n"
> "apt-config is an interface to the configuration settings used by\n"
> "all APT tools to be used mainly in debugging and shell scripting.\n"
> msgstr ""

Over-"used".  I would recommend something like

 "apt-config is an interface to the configuration settings used by\n"
 "all APT tools, mainly intended for debugging and shell scripting.\n"

> #: methods/server.cc
> #, c-format
> msgid ""
> "Automatically disabled %s due to incorrect response from server/proxy. (man "
> "5 apt.conf)"
> msgstr ""
> 
> #: cmdline/apt-sortpkgs.cc
> msgid ""
> "Usage: apt-sortpkgs [options] file1 [file2 ...]\n"
> "\n"
> "apt-sortpkgs is a simple tool to sort package information files.\n"
> "It sorts by default by binary package information, but the -s option\n"
> "can be used to switch to source package ordering instead.\n"
> msgstr ""

"By X by Y" is confusing.  Could we make it:

  "By default it sorts by binary package information, but the -s option\n"

> #: apt-pkg/acquire.cc
> #, c-format
> msgid ""
> "Can't drop privileges for downloading as file '%s' couldn't be accessed by "
> "user '%s'."
> msgstr ""
> 
> #: apt-pkg/acquire-item.cc
> msgid ""
> "Updating such a repository securily is impossible and therefore disabled by "
> "default."
> msgstr ""

Typo - s/securily/securely/

Is this actually talking about updating (modifying) a repository, or
does it mean running an "update" reading *from* such a repository?  I
think it should be
 "Updating from such a repository securely is impossible and therefore disabled "
 "by default."
 
Wait a minute, though - it isn't updating securely that's disabled,
it's updating.  Or maybe the repository...

 "It is impossible to update securely from such a repository, so it is disabled "
 "by default."

or

 "Updating from such a repository cannot be done securely, so it is disabled "
 "by default."

or how about just

 "Updating from such a repository is insecure, so it is disabled by default."

> #: apt-pkg/acquire-item.cc
> msgid ""
> "Data from such a repository can not be authenticated and is therefore "
> "potentially dangerous to use."
> msgstr ""

Avoid "can not" ("sometimes it can not only be technically ambiguous
but genuinely confusing"); use either "cannot" or (as in previous
msgs) just "can't".
 
> #: apt-pkg/acquire-item.cc
> msgid ""
> "See apt-secure(8) manpage for repository creation and user configuration "
> "details."
> msgstr ""

This makes it sound as if it explains how to configure users, but
probably only to me.

> 
> #: apt-pkg/acquire-item.cc
> msgid ""
> "This is normally not allowed, but the option Acquire::"
> "AllowDowngradeToInsecureRepositories was given to override it."
> msgstr ""

Well, technically to override the rule against it, but that's probably
hairsplitting.
 
> #. TRANSLATOR: an identifier like Packages; Releasefile key indicating
> #. a file like main/binary-amd64/Packages; another identifier like Contents;
> #. filename and linenumber of the sources.list entry currently parsed
> #: apt-pkg/deb/debmetaindex.cc
> #, c-format
> msgid "Target %s wants to acquire the same file (%s) as %s from source %s"
> msgstr ""
> 
> #. TRANSLATOR: an identifier like Packages; Releasefile key indicating
> #. a file like main/binary-amd64/Packages; filename and linenumber of
> #. two sources.list entries
> #: apt-pkg/deb/debmetaindex.cc
> #, c-format
> msgid "Target %s (%s) is configured multiple times in %s and %s"
> msgstr ""
> 
> #. TRANSLATOR: The first is an option name from sources.list manpage, the other two URI and Suite
> #: apt-pkg/deb/debmetaindex.cc
> #, c-format
> msgid "Conflicting values set for option %s concerning source %s %s"
> msgstr ""

I suspect that "concerning" isn't quite the right word here.  The
options aren't "concerns" of the APT source; perhaps it should be
"regarding".  (That's still a bit heavyweight, though... I'd suggest
just "for", but that's repetitive.)
 
> #: apt-pkg/deb/debmetaindex.cc
> #, c-format
> msgid "Invalid value set for option %s concerning source %s %s (%s)"
> msgstr ""

Ditto: s/concerning/regarding/

> #: apt-pkg/policy.cc
> #, c-format
> msgid "%s: Value %s is outside the range of valid pin priorities (%d to %d)"
> msgstr ""
> 
> #: apt-pkg/sourcelist.cc
> #, c-format
> msgid "Unsupported file %s given on commandline"
> msgstr ""
> 
> #: cmdline/apt-get.cc
> msgid ""
> "Usage: apt-get [options] command\n"
> "       apt-get [options] install|remove pkg1 [pkg2 ...]\n"
> "       apt-get [options] source pkg1 [pkg2 ...]\n"
> "\n"
> "apt-get is a command line interface for retrieval of packages\n"
> "and information about them from authenticated sources and\n"
> "for installation, upgrade and removal of packages together\n"
> "with their dependencies.\n"
> msgstr ""

Ignoring a potential Harvard comma, all good.

> 
> #: cmdline/apt-helper.cc
> msgid ""
> "Usage: apt-helper [options] command\n"
> "       apt-helper [options] download-file uri target-path\n"
> "\n"
> "apt-helper bundles a variety of commands for shell scripts to use\n"
> "e.g. the same proxy configuration or acquire system as APT would do.\n"
> msgstr ""

Grammatical, but personally I'd say either "as APT would use" or "as
APT would".  Still, this way may be clearer for non-native-speakers...
 
> #: cmdline/apt-mark.cc
> msgid ""
> "Usage: apt-mark [options] {auto|manual} pkg1 [pkg2 ...]\n"
> "\n"
> "apt-mark is a simple command line interface for marking packages\n"
> "as manually or automatically installed. It is also possible to\n"
> "manipulate the dpkg(1) selection states of packages with it.\n"
> "It can also list all packages with or without a certain marking.\n"
> msgstr ""

Double "also"; if I'm going to fix that I might as well also switch it
round so that all three chunks have apt-mark as the subject:

 "apt-mark is a simple command line interface for marking packages\n"
 "as manually or automatically installed. It can also be used to\n"
 "manipulate the dpkg(1) selection states of packages, and to list\n"
 "all packages with or without a certain marking.\n"
 
> #: cmdline/apt-extracttemplates.cc
> msgid ""
> "Usage: apt-extracttemplates file1 [file2 ...]\n"
> "\n"
> "apt-extracttemplates is used to extract config and template files\n"
> "from debian packages. It is used mainly by debconf(1) to prompt for\n"
> "configuration questions before installation of packages.\n"
> msgstr ""

Using lowercase "debian" to mean ".deb-format" is odd but seems to be
an established convention.

(I occasionally complain that by the time these files are on my system
being handed to debconf it's crazy to call them "templates", but it's
far too late to do anything about that now...)
 
> #: cmdline/apt-internal-solver.cc
> msgid ""
> "Usage: apt-internal-solver\n"
> "\n"
> "apt-internal-solver is an interface to use the current internal\n"
> "like an external resolver for the APT family for debugging or alike.\n"
> msgstr ""

I'm not 100% sure, but I think this was aiming for:

 "apt-internal-solver is an interface to use the current internal\n"
 "resolver for the APT family like an external one, for debugging or\n"
 "the like.\n"

> #. No Release file was present, or verification failed, so fall
> #. back to queueing Packages files without verification
> #. only allow going further if the users explicitely wants it

Here and below you mean
                              if the user explicitly

but never mind, and otherwise the rest of the file looks okay.
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
#: apt-private/private-cmndline.cc
#, c-format
msgid "See %s for more information about the available commands."
msgstr ""

#: apt-private/private-cmndline.cc
msgid ""
"Configuration options and syntax are detailed in apt.conf(5).\n"
"Information about how to configure sources can be found in sources.list(5).\n"
"Package and version choices can be expressed via apt_preferences(5).\n"
"Security details are available in apt-secure(8).\n"
msgstr ""

#: apt-private/private-download.cc apt-private/private-install.cc
msgid ""
"--force-yes is deprecated; use one of the options starting with --allow "
"instead."
msgstr ""

#: apt-private/private-install.cc
msgid ""
"Held packages were changed and -y was used without --allow-change-held-"
"packages."
msgstr ""

#: cmdline/apt-cache.cc
msgid ""
"Usage: apt-cache [options] command\n"
"       apt-cache [options] show pkg1 [pkg2 ...]\n"
"\n"
"apt-cache queries and displays available information about installed\n"
"and installable packages. It works exclusively on the data acquired\n"
"to the local cache via the 'update' command of e.g. apt-get. The\n"
"displayed information may therefore be outdated if the last update was\n"
"too long ago, but in exchange apt-cache works independently of the\n"
"availability of the configured sources (e.g. offline).\n"
msgstr ""

#: cmdline/apt.cc
msgid ""
"Usage: apt [options] command\n"
"\n"
"apt is a commandline package manager and provides commands for\n"
"searching and managing as well as querying information about packages.\n"
"It provides the same functionality as the specialized APT tools, such\n"
"as apt-get and apt-cache, but enables options more suitable for\n"
"interactive use by default.\n"
msgstr ""

#: cmdline/apt-cdrom.cc
msgid ""
"Usage: apt-cdrom [options] command\n"
"\n"
"apt-cdrom is used to add CDROM's, USB flashdrives and other removable\n"
"media types as package sources to APT. The mount point and device\n"
"information is taken from apt.conf(5), udev(7) and fstab(5).\n"
msgstr ""

#: cmdline/apt-config.cc
msgid ""
"Usage: apt-config [options] command\n"
"\n"
"apt-config is an interface to the configuration settings used by\n"
"all APT tools, mainly intended for debugging and shell scripting.\n"
msgstr ""

#: methods/server.cc
#, c-format
msgid ""
"Automatically disabled %s due to incorrect response from server/proxy. (man "
"5 apt.conf)"
msgstr ""

#: cmdline/apt-sortpkgs.cc
msgid ""
"Usage: apt-sortpkgs [options] file1 [file2 ...]\n"
"\n"
"apt-sortpkgs is a simple tool to sort package information files.\n"
"By default it sorts by binary package information, but the -s option\n"
"can be used to switch to source package ordering instead.\n"
msgstr ""

#: apt-pkg/acquire.cc
#, c-format
msgid ""
"Can't drop privileges for downloading as file '%s' couldn't be accessed by "
"user '%s'."
msgstr ""

#: apt-pkg/acquire-item.cc
msgid ""
"Updating from such a repository is insecure, so it is disabled by default."
msgstr ""

#: apt-pkg/acquire-item.cc
msgid ""
"Data from such a repository cannot be authenticated and is therefore "
"potentially dangerous to use."
msgstr ""

#: apt-pkg/acquire-item.cc
msgid ""
"See apt-secure(8) manpage for repository creation and user configuration "
"details."
msgstr ""

#: apt-pkg/acquire-item.cc
msgid ""
"This is normally not allowed, but the option Acquire::"
"AllowDowngradeToInsecureRepositories was given to override it."
msgstr ""

#. TRANSLATOR: an identifier like Packages; Releasefile key indicating
#. a file like main/binary-amd64/Packages; another identifier like Contents;
#. filename and linenumber of the sources.list entry currently parsed
#: apt-pkg/deb/debmetaindex.cc
#, c-format
msgid "Target %s wants to acquire the same file (%s) as %s from source %s"
msgstr ""

#. TRANSLATOR: an identifier like Packages; Releasefile key indicating
#. a file like main/binary-amd64/Packages; filename and linenumber of
#. two sources.list entries
#: apt-pkg/deb/debmetaindex.cc
#, c-format
msgid "Target %s (%s) is configured multiple times in %s and %s"
msgstr ""

#. TRANSLATOR: The first is an option name from sources.list manpage, the other two URI and Suite
#: apt-pkg/deb/debmetaindex.cc
#, c-format
msgid "Conflicting values set for option %s regarding source %s %s"
msgstr ""

#: apt-pkg/deb/debmetaindex.cc
#, c-format
msgid "Invalid value set for option %s regarding source %s %s (%s)"
msgstr ""

#: apt-pkg/policy.cc
#, c-format
msgid "%s: Value %s is outside the range of valid pin priorities (%d to %d)"
msgstr ""

#: apt-pkg/sourcelist.cc
#, c-format
msgid "Unsupported file %s given on commandline"
msgstr ""

#: cmdline/apt-get.cc
msgid ""
"Usage: apt-get [options] command\n"
"       apt-get [options] install|remove pkg1 [pkg2 ...]\n"
"       apt-get [options] source pkg1 [pkg2 ...]\n"
"\n"
"apt-get is a command line interface for retrieval of packages\n"
"and information about them from authenticated sources and\n"
"for installation, upgrade and removal of packages together\n"
"with their dependencies.\n"
msgstr ""

#: cmdline/apt-helper.cc
msgid ""
"Usage: apt-helper [options] command\n"
"       apt-helper [options] download-file uri target-path\n"
"\n"
"apt-helper bundles a variety of commands for shell scripts to use\n"
"e.g. the same proxy configuration or acquire system as APT would do.\n"
msgstr ""

#: cmdline/apt-mark.cc
msgid ""
"Usage: apt-mark [options] {auto|manual} pkg1 [pkg2 ...]\n"
"\n"
"apt-mark is a simple command line interface for marking packages\n"
"as manually or automatically installed. It can also be used  to\n"
"manipulate the dpkg(1) selection states of packages, and to list\n"
"all packages with or without a certain marking.\n"
msgstr ""

#: cmdline/apt-extracttemplates.cc
msgid ""
"Usage: apt-extracttemplates file1 [file2 ...]\n"
"\n"
"apt-extracttemplates is used to extract config and template files\n"
"from debian packages. It is used mainly by debconf(1) to prompt for\n"
"configuration questions before installation of packages.\n"
msgstr ""

#: cmdline/apt-internal-solver.cc
msgid ""
"Usage: apt-internal-solver\n"
"\n"
"apt-internal-solver is an interface to use the current internal\n"
"resolver for the APT family like an external one, for debugging or\n"
"the like.\n"
msgstr ""

#. No Release file was present, or verification failed, so fall
#. back to queueing Packages files without verification
#. only allow going further if the users explicitely wants it
#: apt-pkg/acquire-item.cc
#, c-format
msgid "The repository '%s' is not signed."
msgstr ""

#. No Release file was present so fall
#. back to queueing Packages files without verification
#. only allow going further if the users explicitely wants it
#: apt-pkg/acquire-item.cc
#, c-format
msgid "The repository '%s' does not have a Release file."
msgstr ""

#: apt-pkg/acquire-item.cc
#, c-format
msgid "The repository '%s' is no longer signed."
msgstr ""

#: apt-pkg/contrib/cmndline.cc
#, c-format
msgid ""
"Command line option '%c' [from %s] is not understood in combination with the "
"other options."
msgstr ""

#: apt-pkg/contrib/cmndline.cc
#, c-format
msgid ""
"Command line option %s is not understood in combination with the other "
"options"
msgstr ""
--- new-in-apt.po.pristine	2015-11-21 12:41:39.201195986 +0000
+++ new-in-apt.po	2015-11-21 13:13:35.483519171 +0000
@@ -5,7 +5,7 @@
 
 #: apt-private/private-cmndline.cc
 msgid ""
-"Configuration options and syntax is detailed in apt.conf(5).\n"
+"Configuration options and syntax are detailed in apt.conf(5).\n"
 "Information about how to configure sources can be found in sources.list(5).\n"
 "Package and version choices can be expressed via apt_preferences(5).\n"
 "Security details are available in apt-secure(8).\n"
@@ -13,7 +13,7 @@
 
 #: apt-private/private-download.cc apt-private/private-install.cc
 msgid ""
-"--force-yes is deprecated, use one of the options starting with --allow "
+"--force-yes is deprecated; use one of the options starting with --allow "
 "instead."
 msgstr ""
 
@@ -29,10 +29,10 @@
 "       apt-cache [options] show pkg1 [pkg2 ...]\n"
 "\n"
 "apt-cache queries and displays available information about installed\n"
-"as well as installable packages. It works exclusively on the data\n"
-"acquired via the 'update' command of e.g. apt-get to the local cache.\n"
-"The displayed information can therefore be outdated if the last update\n"
-"is too long ago, but in exchange apt-cache works independently of the\n"
+"and installable packages. It works exclusively on the data acquired\n"
+"to the local cache via the 'update' command of e.g. apt-get. The\n"
+"displayed information may therefore be outdated if the last update was\n"
+"too long ago, but in exchange apt-cache works independently of the\n"
 "availability of the configured sources (e.g. offline).\n"
 msgstr ""
 
@@ -42,8 +42,8 @@
 "\n"
 "apt is a commandline package manager and provides commands for\n"
 "searching and managing as well as querying information about packages.\n"
-"It provides the same functionality as the specialized APT tools,\n"
-"like apt-get and apt-cache, but enables options more suitable for\n"
+"It provides the same functionality as the specialized APT tools, such\n"
+"as apt-get and apt-cache, but enables options more suitable for\n"
 "interactive use by default.\n"
 msgstr ""
 
@@ -61,7 +61,7 @@
 "Usage: apt-config [options] command\n"
 "\n"
 "apt-config is an interface to the configuration settings used by\n"
-"all APT tools to be used mainly in debugging and shell scripting.\n"
+"all APT tools, mainly intended for debugging and shell scripting.\n"
 msgstr ""
 
 #: methods/server.cc
@@ -76,7 +76,7 @@
 "Usage: apt-sortpkgs [options] file1 [file2 ...]\n"
 "\n"
 "apt-sortpkgs is a simple tool to sort package information files.\n"
-"It sorts by default by binary package information, but the -s option\n"
+"By default it sorts by binary package information, but the -s option\n"
 "can be used to switch to source package ordering instead.\n"
 msgstr ""
 
@@ -89,13 +89,12 @@
 
 #: apt-pkg/acquire-item.cc
 msgid ""
-"Updating such a repository securily is impossible and therefore disabled by "
-"default."
+"Updating from such a repository is insecure, so it is disabled by default."
 msgstr ""
 
 #: apt-pkg/acquire-item.cc
 msgid ""
-"Data from such a repository can not be authenticated and is therefore "
+"Data from such a repository cannot be authenticated and is therefore "
 "potentially dangerous to use."
 msgstr ""
 
@@ -130,12 +129,12 @@
 #. TRANSLATOR: The first is an option name from sources.list manpage, the other two URI and Suite
 #: apt-pkg/deb/debmetaindex.cc
 #, c-format
-msgid "Conflicting values set for option %s concerning source %s %s"
+msgid "Conflicting values set for option %s regarding source %s %s"
 msgstr ""
 
 #: apt-pkg/deb/debmetaindex.cc
 #, c-format
-msgid "Invalid value set for option %s concerning source %s %s (%s)"
+msgid "Invalid value set for option %s regarding source %s %s (%s)"
 msgstr ""
 
 #: apt-pkg/policy.cc
@@ -174,9 +173,9 @@
 "Usage: apt-mark [options] {auto|manual} pkg1 [pkg2 ...]\n"
 "\n"
 "apt-mark is a simple command line interface for marking packages\n"
-"as manually or automatically installed. It is also possible to\n"
-"manipulate the dpkg(1) selection states of packages with it.\n"
-"It can also list all packages with or without a certain marking.\n"
+"as manually or automatically installed. It can also be used  to\n"
+"manipulate the dpkg(1) selection states of packages, and to list\n"
+"all packages with or without a certain marking.\n"
 msgstr ""
 
 #: cmdline/apt-extracttemplates.cc
@@ -193,7 +192,8 @@
 "Usage: apt-internal-solver\n"
 "\n"
 "apt-internal-solver is an interface to use the current internal\n"
-"like an external resolver for the APT family for debugging or alike.\n"
+"resolver for the APT family like an external one, for debugging or\n"
+"the like.\n"
 msgstr ""
 
 #. No Release file was present, or verification failed, so fall

Reply to: