[deployment-guide/comm-rel: 154/727] added and modified ABRT section

[Jaromir Hradilek]

commit 4f155efabbc403e937abcaf40f1fb447d7fb333d
Author: Martin Prpic <mprpic at redhat.com>
Date:   Mon Jul 26 19:33:50 2010 +0200

    added and modified ABRT section

 en-US/ABRT.xml |   41 ++++++++++++++++++++++++-----------------
 1 files changed, 24 insertions(+), 17 deletions(-)
---
diff --git a/en-US/ABRT.xml b/en-US/ABRT.xml
index 465fe55..21b3d30 100644
--- a/en-US/ABRT.xml
+++ b/en-US/ABRT.xml
@@ -145,10 +145,10 @@ Starting abrt daemon:                                      [  OK  ]</screen>
         </listitem>
       </varlistentry>
       <varlistentry>
-        <term>#WatchCrashdumpArchiveDir = /var/spool/abrt-upload</term>
+        <term>#WatchCrashdumpArchiveDir = /var/spool/abrt-upload/</term>
         <listitem>
           <para>
-            This directive is commented out by default. Enable (uncomment) it if you want <systemitem class="daemon">abrtd</systemitem> to auto-unpack crashdump tarballs which appear in the specified directory — in this case <filename>/var/spool/abrt-upload</filename> — (for example, uploaded via <systemitem class="service">ftp</systemitem>, <systemitem class="service">scp</systemitem>, etc.). You must ensure that whatever directory you specify in this directive exists and is writable for <systemitem class="daemon">abrtd</systemitem>. <systemitem class="daemon">abrtd</systemitem> will not create it automatically.
+            This directive is commented out by default. Enable (uncomment) it if you want <systemitem class="daemon">abrtd</systemitem> to auto-unpack crashdump tarballs which appear in the specified directory — in this case <filename>/var/spool/abrt-upload/</filename> — (for example, uploaded via <systemitem class="service">ftp</systemitem>, <systemitem class="service">scp</systemitem>, etc.). You must ensure that whatever directory you specify in this directive exists and is writable for <systemitem class="daemon">abrtd</systemitem>. <systemitem class="daemon">abrtd</systemitem> will not create it automatically.
           </para>
         </listitem>
       </varlistentry>
@@ -223,23 +223,23 @@ Starting abrt daemon:                                      [  OK  ]</screen>
   <section id="configuring-centralized-crash-collection">
     <title>Configuring Centralized Crash Collection</title>
     <para>
-        It is possible to set up <application>ABRT</application> so that crash reports are collected from multiple machines and sent to a dedicated machine for further processing. This is useful when an administrator does not want to log into hundreds of machines and check for crashes found by <application>ABRT</application> manually. In order to use this method, you need to install the <application>abrt-plugin-reportuploader</application> plugin (<command>yum install abrt-plugin-reportuploader</command>).
+        It is possible to set up <application>ABRT</application> so that crash reports are collected from multiple systems and sent to a dedicated system for further processing. This is useful when an administrator does not want to log into hundreds of systems and check for crashes found by <application>ABRT</application> manually. In order to use this method, you need to install the <application>abrt-plugin-reportuploader</application> plugin (<command>yum install abrt-plugin-reportuploader</command>).
     </para>
     <para>
         The steps to configure <application>ABRT</application>'s centralized crash collection are: 
       </para>
       <para>
-        Complete the following steps on a dedicated machine ("server machine"):
+        Complete the following steps on a dedicated system ("server system"):
       </para>
       <itemizedlist>
         <listitem>
           <para>
-            Create a directory to which you want the crash reports to be uploaded to. Usually, <filename>/var/spool/abrt-upload</filename> is used (the rest of the document assumes you are using <filename>/var/spool/abrt-upload</filename>). Make sure this directory is writable by the abrt user.  
+            Create a directory to which you want the crash reports to be uploaded to. Usually, <filename>/var/spool/abrt-upload/</filename> is used (the rest of the document assumes you are using <filename>/var/spool/abrt-upload/</filename>). Make sure this directory is writable by the abrt user.  
           </para>
           <note>
             <title>Note</title>
             <para>
-                The abrt user is a user named "abrt". This user is used by <systemitem class="daemon">abrtd</systemitem> for various things, for example, as the owner of <filename>/var/spool/abrt*</filename> directories.
+                When the <package>abrt-desktop</package> package is installed, it creates a new system user and and a group, both named <systemitem class="username">abrt</systemitem>. This user is used by the <systemitem class="daemon">abrtd</systemitem> daemon for various things, for example, as the owner:group of <filename>/var/spool/abrt/*</filename> directories.
               </para>
           </note>
         </listitem>
@@ -247,21 +247,21 @@ Starting abrt daemon:                                      [  OK  ]</screen>
           <para>
              In the <filename>/etc/abrt/abrt.conf</filename> configuration file, set the <varname>WatchCrashdumpArchiveDir</varname> directive to the following:
 <screen>
-WatchCrashdumpArchiveDir = /var/spool/abrt-upload
+WatchCrashdumpArchiveDir = /var/spool/abrt-upload/
 </screen>
           </para>
         </listitem>
         <listitem>
           <para>
-            Set up your preferred upload mechanism, for example <systemitem class="daemon">ftp</systemitem>, <systemitem class="daemon">scp</systemitem>. For more information on how to configure <systemitem class="daemon">ftp</systemitem>, refer to <xref linkend="ch-FTP"/>. For more information on how to configure <systemitem class="daemon">scp</systemitem>, refer to <xref linkend="s2-ssh-clients-scp"/>.
+            Determine your preferred upload mechanism; for example, either <systemitem class="protocol">FTP</systemitem> or <systemitem class="protocol">SCP</systemitem>. For more information on how to configure <systemitem class="protocol">FTP</systemitem>, refer to <xref linkend="ch-FTP"/>. For more information on how to configure <systemitem class="protocol">SCP</systemitem>, refer to <xref linkend="s2-ssh-clients-scp"/>.
           </para>
           <para>
-            For security reasons, make sure that uploads can only be performed by a specific user and with a password. The rest of the document assumes that the username used for uploads is "USERNAME" and the password is "PASSWORD".
+            For security reasons, make sure that uploads can only be performed by a specific user and with a password. The rest of the document assumes that the username used for uploads is <systemitem class="username">USERNAME</systemitem> and the password is <literal>PASSWORD</literal>.
           </para>
         </listitem>
         <listitem>
           <para>
-            Test from another machine that your upload method. For example, upload a file using the interactive <systemitem class="daemon">ftp</systemitem> client:
+            Test your upload method from a different system to ensure that it works. For example, upload a file using the interactive <systemitem class="protocol">FTP</systemitem> client:
           </para>
           <screen>
 ~]$ ftp
@@ -272,12 +272,12 @@ ftp> put TESTFILE
 ftp> quit
           </screen>
           <para>
-            Check if the "TESTFILE" file appeared in the desired directory on your server machine.
+            Ensure that <filename>TESTFILE</filename> appeared in the correct directory on the server system.
           </para>
         </listitem>
       </itemizedlist>
       <para>
-        Complete the following steps on every machine ("client machine") which will use the central management method:
+        Complete the following steps on every client system which will use the central management method:
       </para>
       <itemizedlist>
         <listitem>
@@ -292,7 +292,7 @@ URL = ftp://user:password@server/
         </listitem>
         <listitem>
           <para>
-             To automatically send the crash reports to the server machine immediately after the crash occurs, is detected, and saved, set the <varname>ActionsAndReporters</varname> directive in the <filename>/etc/abrt/abrt.conf</filename> configuration file to the following:
+             To automatically send the crash reports to the server system immediately after the crash occurs, is detected, and saved, set the <varname>ActionsAndReporters</varname> directive in the <filename>/etc/abrt/abrt.conf</filename> configuration file to the following:
 <screen>
 ActionsAndReporters = ReportUploader 
 </screen>
@@ -300,7 +300,7 @@ ActionsAndReporters = ReportUploader
         </listitem>
         <listitem>
           <para>
-            Setting the <parameter>ReportUploader</parameter> to be a reporter plugin for a specific crash type in the <literal>[AnalyzerActionsAndReporters]</literal> section of the <filename>/etc/abrt/abrt.conf</filename> configuration file will require user interaction before the crash dump is sent to the server machine. The user will be required to run <application>abrt-cli</application> or <application>abrt-gui</application> and instruct <systemitem class="daemon">abrtd</systemitem> to report the crash and send it to the server machine. For example, if you want all crash types to use this method, edit your <filename>/etc/abrt/abrt.conf</filename> configuration file in the following way:
+            Setting the <parameter>ReportUploader</parameter> to be a reporter plugin for a specific crash type in the <literal>[AnalyzerActionsAndReporters]</literal> section of the <filename>/etc/abrt/abrt.conf</filename> configuration file will require user interaction before the crash dump is sent to the server system. The user will be required to run <application>abrt-cli</application> or <application>abrt-gui</application> and instruct <systemitem class="daemon">abrtd</systemitem> to report the crash and send it to the server system. For example, if you want all crash types to use this method, edit your <filename>/etc/abrt/abrt.conf</filename> configuration file in the following way:
           </para>
 <screen>
 Kerneloops = ReportUploader
@@ -309,8 +309,15 @@ Python = ReportUploader
 </screen>
         </listitem>
       </itemizedlist>
+      <bridgehead>Testing ABRT Crash Detection</bridgehead>
       <para>
-        After completing this configuration process, the basic setup is finished. To test that this setup works properly, use the <command>kill -SEGV</command> command to terminate a process on a client machine. Check that the crash was detected by <application>ABRT</application> on the client machine (this can be checked by examining the appropriate syslog file), copied to the server machine, unpacked on the server machine and can be seen and acted upon using <command>abrt-cli</command> or <command>abrt-gui</command> on the server machine.
+        After completing this configuration process, the basic setup is finished. To test that this setup works properly use the <command>kill -s SEGV <replaceable>PID</replaceable></command> command to terminate a process on a client system. For example, start a <systemitem class="process">sleep</systemitem> and kill it afterwards in the following way:
+        <screen>
+~]$ sleep 100 &amp;
+[1] 2823
+~]$ kill -s SEGV 2823
+        </screen>
+        <application>ABRT</application> should detect a crash after executing the <command>kill</command> command. Check that the crash was detected by <application>ABRT</application> on the client system (this can be checked by examining the appropriate syslog file), copied to the server system, unpacked on the server system and can be seen and acted upon using <command>abrt-cli</command> or <command>abrt-gui</command> on the server system.
       </para>
       <para>
         It is advisable to check and modify the following parameters if needed:
@@ -318,12 +325,12 @@ Python = ReportUploader
       <itemizedlist>
         <listitem>
           <para>
-            The <parameter>MaxCrashReportsSize</parameter> directive (in <filename>/etc/abrt/abrt.conf</filename>) needs to be set to a larger value if the expected volume of crash data is larger than the default 1000 Mb.
+            The <parameter>MaxCrashReportsSize</parameter> directive (in <filename>/etc/abrt/abrt.conf</filename>) needs to be set to a larger value if the expected volume of crash data is larger than the default <constant>1000</constant>&#160;MB.
           </para>
         </listitem>
         <listitem>
           <para>
-            The <parameter>ProcessUnpackaged</parameter> directive (in <filename>/etc/abrt/abrt.conf</filename>) needs to be set to <replaceable>yes</replaceable> and the <parameter>BacktraceRemotes</parameter> (in <filename>/etc/abrt/plugins/CCpp.conf</filename>) needs to be set to <replaceable>no</replaceable> if the client machine and the server machine have significantly different sets of installed packages.
+            The <parameter>ProcessUnpackaged</parameter> directive (in <filename>/etc/abrt/abrt.conf</filename>) needs to be set to <replaceable>yes</replaceable> and the <parameter>BacktraceRemotes</parameter> (in <filename>/etc/abrt/plugins/CCpp.conf</filename>) needs to be set to <replaceable>no</replaceable> if the client system and the server system have significantly different sets of installed packages.
           </para>
         </listitem>
       </itemizedlist>