Package: aptitude-doc-en
Severity: minor
Version: 0.6.4-1.2
Tags: patch

The xml files mainly use entity references when referring to aptitude,
apt, and so on:

  <para>
    &aptitude; is a sizeable program with many features, and it can
    be a bit overwhelming for new users to get acquainted with it.
    This chapter does not exhaustively describe the features of
    ...

These have been missed in some places:

  <para>
    Once the cache is loaded (this may take some time on slower
    machines), the main aptitude screen should appear:
  </para>

Attached patch corrects most of these that could be found with
a quick replace-regexp, and inserts some missing <filename>
tags.
From 7075e1ec0e9d39dc8a22d348c8ba81677ac809aa Mon Sep 17 00:00:00 2001
From: Daniel Hartwig <[email protected]>
Date: Wed, 7 Dec 2011 19:25:57 +0800
Subject: [PATCH] Fix missing entity refs and filename elements.

---
 doc/en/aptitude.xml |   30 +++++++++++++++---------------
 doc/en/manpage.xml  |   33 +++++++++++++++++----------------
 2 files changed, 32 insertions(+), 31 deletions(-)

diff --git a/doc/en/aptitude.xml b/doc/en/aptitude.xml
index 617a3e8..630a96a 100644
--- a/doc/en/aptitude.xml
+++ b/doc/en/aptitude.xml
@@ -599,7 +599,7 @@
 	  <title>Building &aptitude; from the development tree</title>
 
 	  <para>
-	    To build aptitude from the Mercurial repository, you must
+	    To build &aptitude; from the Mercurial repository, you must
 	    have the programs <systemitem>autoconf</systemitem> and
 	    <systemitem>automake</systemitem> installed.  Type
 	    <command>sh ./autogen.sh &amp;&amp; ./configure</command>
@@ -658,7 +658,7 @@
 
 	<para>
 	  Once the cache is loaded (this may take some time on slower
-	  machines), the main aptitude screen should appear:
+	  machines), the main &aptitude; screen should appear:
 	</para>
 
 	<screenshot>
@@ -711,7 +711,7 @@ These packages are currently installed on your computer.
 
 	<para>
 	  As the top line of the screen suggests, you can access
-	  aptitude's menus by pressing <keycombo action='simul'><keycap>Control</keycap><keycap>t</keycap></keycombo>; you can
+	  &aptitude;'s menus by pressing <keycombo action='simul'><keycap>Control</keycap><keycap>t</keycap></keycombo>; you can
 	  also click the mouse on a menu title if your system supports
 	  it.  Pressing <keycombo action='simul'><keycap>Control</keycap><keycap>t</keycap></keycombo> will open the Actions menu:
 	</para>
@@ -2952,8 +2952,8 @@ Th+-------------------------------------------------------------------------+
 	</para>
 
 	<para>
-	  By default, aptitude will use the command
-	  <systemitem>su</systemitem> to gain root privileges.  If you
+	  By default, &aptitude; will use the command
+	  <systemitem>su</systemitem> to gain &root; privileges.  If you
 	  would like it to use some other command (such as
 	  <systemitem>sudo</systemitem>), set the configuration option
 	  <link
@@ -5070,7 +5070,7 @@ e: Examine  !: Apply  .: Next  ,: Previous</screen>
 
       <warning>
 	<para>
-	  The behavior of aptitude when given a search pattern without
+	  The behavior of &aptitude; when given a search pattern without
 	  a leading <quote>?</quote> (or <quote>~</quote>) is provided
 	  as a convenience for interactive use and will change in
 	  future releases; scripts that invoke
@@ -5470,7 +5470,7 @@ e: Examine  !: Apply  .: Next  ,: Previous</screen>
 
 	<para>
 	  <xref linkend='tableSearchTermQuickGuide'/> provides a brief
-	  summary of all the search terms provided by aptitude.  A
+	  summary of all the search terms provided by &aptitude;.  A
 	  full description of each term can be found <link
 	  linkend='searchTermReferenceList'>below</link>.
 	</para>
@@ -10960,7 +10960,7 @@ e: Examine  !: Apply  .: Next  ,: Previous</screen>
 	      <seg><literal>16384</literal></seg>
 
 	      <seg>
-		The minimum size in bytes at which aptitude will begin
+		The minimum size in bytes at which &aptitude; will begin
 		to display screenshots incrementally.  Below this
 		size, screenshots will not appear until they are fully
 		downloaded.
@@ -10973,7 +10973,7 @@ e: Examine  !: Apply  .: Next  ,: Previous</screen>
 
 	      <seg>
 		The maximum number of bytes of screenshot data that
-		aptitude will store in memory for screenshots that are
+		&aptitude; will store in memory for screenshots that are
 		not currently being displayed.  The default is four
 		megabytes.
 	      </seg>
@@ -11129,13 +11129,13 @@ e: Examine  !: Apply  .: Next  ,: Previous</screen>
 		<literal><replaceable>protocol</replaceable>:<replaceable>command</replaceable></literal>.
 		<replaceable>protocol</replaceable> must be either
 		<literal>su</literal> or <literal>sudo</literal>; it
-		determines how aptitude invokes the program when it
-		wants to gain root privileges.  If
+		determines how &aptitude; invokes the program when it
+		wants to gain &root; privileges.  If
 		<replaceable>protocol</replaceable> is
 		<literal>su</literal>, then
 		<quote><literal><replaceable>command</replaceable> -c
 		<replaceable>arguments</replaceable></literal></quote> is used
-		to become root; otherwise, aptitude uses
+		to become &root;; otherwise, &aptitude; uses
 		<quote><literal><replaceable>command</replaceable>
 		<replaceable>arguments</replaceable></literal></quote>.  The
 		first word in <replaceable>command</replaceable> is
@@ -11170,7 +11170,7 @@ e: Examine  !: Apply  .: Next  ,: Previous</screen>
 	      <seg><literal>false</literal></seg>
 
 	      <seg>
-		In previous versions of aptitude, the setting
+		In previous versions of &aptitude;, the setting
 		<literal>Aptitude::Recommends-Important</literal>
 		caused recommendations to be installed automatically,
 		the same way that <literal><link
@@ -11178,7 +11178,7 @@ e: Examine  !: Apply  .: Next  ,: Previous</screen>
 		does today.  If this option is set to
 		<literal>false</literal> and
 		<literal>Aptitude::Recommends-Important</literal> is
-		also set to <literal>false</literal>, aptitude will
+		also set to <literal>false</literal>, &aptitude; will
 		set <literal><link
 		linkend='configAptInstall-Recommends'>Apt::Install-Recommends</link></literal>
 		to <literal>false</literal> and set
@@ -12868,7 +12868,7 @@ Minesweeper                                   Minesweeper    Lost in 2388 second
       <qandaentry>
 	<question>
 	  <para>
-	    I want to select text, why doesn't aptitude let me disable
+	    I want to select text, why doesn't &aptitude; let me disable
 	    the mouse?
 	  </para>
 	</question>
diff --git a/doc/en/manpage.xml b/doc/en/manpage.xml
index 445deb2..684a2f9 100644
--- a/doc/en/manpage.xml
+++ b/doc/en/manpage.xml
@@ -445,10 +445,10 @@
 	<listitem>
 	  <para>
 	    Forbid a package from being upgraded to a particular
-	    version.  This will prevent aptitude from
+	    version.  This will prevent &aptitude; from
 	    automatically upgrading to this version, but will
 	    allow automatic upgrades to future versions.  By
-	    default, aptitude will select the version to which the
+	    default, &aptitude; will select the version to which the
 	    package would normally be upgraded; you may override
 	    this selection by appending <quote><literal>=<replaceable>version</replaceable></literal></quote>
 	    to the package name: for instance, <quote><literal>aptitude forbid-version
@@ -862,11 +862,11 @@ p   kde           Depends    kdepim (>= 4:3.4.3)</screen>
 	  <para>
 	    The command <literal>why</literal> finds a dependency
 	    chain that installs the package named on the command line,
-	    as above.  Note that the dependency that aptitude produced
+	    as above.  Note that the dependency that &aptitude; produced
 	    in this case is only a suggestion.  This is because no
 	    package currently installed on this computer depends on or
 	    recommends the <systemitem>kdepim</systemitem> package; if
-	    a stronger dependency were available, aptitude would have
+	    a stronger dependency were available, &aptitude; would have
 	    displayed it.
 	  </para>
 
@@ -883,7 +883,7 @@ i A texlive-latex-extra Conflicts textopo</screen>
 
 	  <para>
 	    If one or more <replaceable>pattern</replaceable>s are
-	    present, then aptitude will begin its search at these
+	    present, then &aptitude; will begin its search at these
 	    patterns; that is, the first package in the chain it
 	    prints will be a package matching the pattern in question.
 	    The patterns are considered to be package names unless
@@ -916,7 +916,7 @@ i A texlive-latex-extra Conflicts textopo</screen>
 	  </note>
 
 	  <para>
-	    By default aptitude outputs only the <quote>most
+	    By default &aptitude; outputs only the <quote>most
 	    installed, strongest, tightest, shortest</quote>
 	    dependency chain.  That is, it looks for a chain that only
 	    contains packages which are installed or will be
@@ -930,7 +930,7 @@ i A texlive-latex-extra Conflicts textopo</screen>
 
 	  <para>
 	    If the verbosity level is 1 or more, then
-	    <emphasis>all</emphasis> the explanations aptitude can
+	    <emphasis>all</emphasis> the explanations &aptitude; can
 	    find will be displayed, in inverse order of relevance.  If
 	    the verbosity level is 2 or more, a truly excessive amount
 	    of debugging information will be printed to standard
@@ -1030,7 +1030,7 @@ i A texlive-latex-extra Conflicts textopo</screen>
 
 	<listitem>
 	  <para>
-	    Copy the apt configuration directory
+	    Copy the &apt; configuration directory
 	    (<literal>/etc/apt</literal>) and a subset of the package
 	    database to the specified directory.  If no packages are
 	    listed, the entire package database is copied; otherwise
@@ -1437,7 +1437,7 @@ libdbix-fulltextsearch-perl 0.73-10</screen>
 
 	  <para>
 	    This does not affect the log of installations that
-	    aptitude has performed
+	    &aptitude; has performed
 	    (<filename>/var/log/aptitude</filename>); the log messages
 	    written using this configuration include internal program
 	    events, errors, and debugging messages.  See the
@@ -1499,7 +1499,7 @@ libdbix-fulltextsearch-perl 0.73-10</screen>
 
 	  <para>
 	    This does not affect the log of installations that
-	    aptitude has performed
+	    &aptitude; has performed
 	    (<filename>/var/log/aptitude</filename>); the log messages
 	    written using this configuration include internal program
 	    events, errors, and debugging messages.  See the
@@ -2338,10 +2338,11 @@ The following packages will be REMOVED:
 
       <listitem>
 	<para>
-	  If $HOME/.aptitude exists, aptitude will store its
-	  configuration file in $HOME/.aptitude/config.  Otherwise, it
-	  will look up the current user's home directory using <citerefentry><refentrytitle>getpwuid</refentrytitle><manvolnum>2</manvolnum></citerefentry>
-	  and place its configuration file there.
+	  If <filename>$HOME/.aptitude</filename> exists, aptitude will store
+	  its configuration file in <filename>$HOME/.aptitude/config</filename>.
+          Otherwise, it will look up the current user's home directory
+          using <citerefentry><refentrytitle>getpwuid</refentrytitle><manvolnum>2</manvolnum></citerefentry>
+          and place its configuration file there.
 	</para>
       </listitem>
     </varlistentry>
@@ -2735,7 +2736,7 @@ The following packages will be REMOVED:
     <para>
       The following options may occur on the command-line before the
       input file.  Options following the input file are presumed to be
-      arguments to aptitude.
+      arguments to &aptitude;.
     </para>
 
     <variablelist>
@@ -2785,7 +2786,7 @@ The following packages will be REMOVED:
 	    Do not remove the unpacked state directory after running
 	    <command>aptitude</command>.  You might want to use this
 	    if, for instance, you are debugging a problem that appears
-	    when aptitude's state file is modified.  When
+	    when &aptitude;'s state file is modified.  When
 	    <command>aptitude</command> finishes running, the name of
 	    the state directory will be printed so that you can access
 	    it in the future.
-- 
1.7.5.4

Reply via email to