Merge lp:~bkerensa/serverguide/serverguide-review-A.1 into lp:~ubuntu-core-doc/serverguide/oneiric

[Benjamin Kerensa]

Tidying of:
A.1 -- Reporting Bugs in Ubuntu Server Edition

[Peter Matulis (petermatulis)]

Benjamin, I agree that what we currently have is much too wordy but I would say you are "throwing out the baby with the bathwater" here. The reader should be given information about commands for typical command-line scenarios:

1. Filing a bug
2. Adding bug info to an existing bug
3. Saving bug info to disk and transfer to another computer for the actual filing
4. Other?

and then be provided with solid links to follow for more information.

We should focus solely on the command line for interaction with Launchpad. That objective may help guide us for this appendix. There may be tasks done easily on a graphical desktop that is not so obvious in a CLI environment. What challenges does the Server Edition present us with?...

review: Needs Fixing

[Doug Smythies (dsmythies)]

Can this one be set to "REJECTED" and then deleted?
It is obsolete is it not?

Unmerged revisions

34. By Benjamin Kerensa on 2011-11-26

Reviewing sub-chapter 6.1; Minor revision in wording to be consistent with wiki

=== modified file 'serverguide/C/reporting-bugs.xml'
--- serverguide/C/reporting-bugs.xml	2011-05-03 07:11:18 +0000
+++ serverguide/C/reporting-bugs.xml	2011-12-28 08:34:17 +0000
@@ -1,321 +1,12 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 
-	"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
-<!ENTITY % globalent SYSTEM "../../libs/global.ent">
-%globalent;
-<!ENTITY % gnome-menus-C SYSTEM "../../libs/gnome-menus-C.ent">
-%gnome-menus-C;
-<!ENTITY % xinclude SYSTEM "../../libs/xinclude.mod">
-%xinclude;
-<!ENTITY language "&EnglishAmerican;">
-]>
-<appendix id="serverguide-appendix" status="review">
-  <title>Appendix</title>
-
-  <sect1 id="reporting-bugs" status="review">
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
+<article lang="">
+  <sect1>
+    <title>appendix</title>
+    <title>Appendix</title>
+  </sect1>
+  <sect1>
     <title>Reporting Bugs in Ubuntu Server Edition</title>
-
-  <para>
-  While the Ubuntu Project attempts to release software with as few
-  bugs as possible, they do occur. You can help fix these bugs by
-  reporting ones that you find to the project.  The Ubuntu Project
-  uses <ulink url="https://launchpad.net/">Launchpad</ulink>
-  to track its bug reports. In order to file a bug
-  about Ubuntu Server on Launchpad, you will need to
-  <ulink url="https://help.launchpad.net/YourAccount/NewAccount">create
-  an account</ulink>.
-  </para>
-
-  <sect2 id="reporting-bugs-ubuntu-bug" status="review">
-    <title>Reporting Bugs With ubuntu-bug</title>
-
-    <para>
-    The preferred way to report a bug is with the
-    <application>ubuntu-bug</application> command. The ubuntu-bug
-    tool gathers information about the system useful to developers in
-    diagnosing the reported problem that will then be included in the
-    bug report filed on Launchpad. Bug reports in Ubuntu need to be
-    filed against a specific software package, thus the name of the
-    package that the bug occurs in needs to be given to ubuntu-bug:
-    </para>
-
-<screen>
-<command>ubuntu-bug PACKAGENAME</command>
-</screen>
-
-    <para>
-    For example, to file a bug against the openssh-server package, you would do:
-    </para>
-
-<screen>
-<command>ubuntu-bug openssh-server</command>
-</screen>
-
-    <para>
-    You can specify either a binary package or the source package
-    for ubuntu-bug. Again using openssh-server as an example,
-    you could also generate the report against the source package
-    for openssh-server, openssh:
-    </para>
-
-<screen>
-<command>ubuntu-bug openssh</command>
-</screen>
-
-    <note>
-    <para>
-    See <xref linkend="package-management"/>
-    for more information about packages in Ubuntu.
-    </para>
-    </note>
-
-    <para>
-    The ubuntu-bug command will gather information about the system in
-    question, possibly including information specific to the specified
-    package, and then ask you what you would like to do with collected
-    information:
-    </para>
-
-<screen>
-<command>ubuntu-bug postgresql</command>
-
-*** Collecting problem information
-
-The collected information can be sent to the developers to improve the
-application. This might take a few minutes.
-..........
-
-*** Send problem report to the developers?
-
-After the problem report has been sent, please fill out the form in the
-automatically opened web browser.
-
-What would you like to do? Your options are:
-  S: Send report (1.7 KiB)
-  V: View report
-  K: Keep report file for sending later or copying to somewhere else
-  C: Cancel
-Please choose (S/V/K/C):
-</screen>
-
-    <para>
-    The options available are:
-    </para>
-
-    <para>
-    <itemizedlist>
-      <listitem>
-        <para><emphasis role="bold">Send Report</emphasis> Selecting
-        Send Report submits the collected information to Launchpad as
-        part of the the process of filing a bug report. You will be
-        given the opportunity to describe the situation that led up to
-        the occurrence of the bug.
-        </para>
-
-<screen>
-*** Uploading problem information
-
-The collected information is being sent to the bug tracking system.
-This might take a few minutes.
-91%
-
-*** To continue, you must visit the following URL:
-
-  https://bugs.launchpad.net/ubuntu/+source/postgresql-8.4/+filebug/kc6eSnTLnLxF8u0t3e56EukFeqJ?
-
-You can launch a browser now, or copy this URL into a browser on another
-computer.
-
-Choices:
-  1: Launch a browser now
-  C: Cancel
-Please choose (1/C):
-</screen>
-
-        <para>
-        If you choose to start a browser, by default the text based web
-        browser <application>w3m</application> will be used to finish filing
-        the bug report. Alternately, you can copy the given URL to a
-        currently running web browser.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-        <emphasis role="bold">View Report</emphasis> Selecting View
-        Report causes the collected information to be displayed to
-        the terminal for review.
-        </para>
-
-<screen>
-Package: postgresql 8.4.2-2
-PackageArchitecture: all
-Tags: lucid
-ProblemType: Bug
-ProcEnviron:
-  LANG=en_US.UTF-8
-  SHELL=/bin/bash
-Uname: Linux 2.6.32-16-server x86_64
-Dependencies:
-  adduser 3.112ubuntu1
-  base-files 5.0.0ubuntu10
-  base-passwd 3.5.22
-  coreutils 7.4-2ubuntu2
-...
-</screen>
-
-        <para>
-        After viewing the report, you will be brought back to the same
-        menu asking what you would like to do with the report.
-        </para>
-      </listitem>
-
-      <listitem>
-        <para>
-        <emphasis role="bold">Keep Report File</emphasis> Selecting Keep
-        Report File causes the gathered information to be written to
-        a file. This file can then be used to later file a bug report
-        or transferred to a different Ubuntu system for reporting.
-        To submit the report file, simply give it as an argument to
-        the ubuntu-bug command:
-        </para>
-
-<screen>
-What would you like to do? Your options are:
-  S: Send report (1.7 KiB)
-  V: View report
-  K: Keep report file for sending later or copying to somewhere else
-  C: Cancel
-Please choose (S/V/K/C): <userinput>k</userinput>
-Problem report file: /tmp/apport.postgresql.v4MQas.apport
-
-<command>ubuntu-bug /tmp/apport.postgresql.v4MQas.apport</command>
-
-*** Send problem report to the developers?
-...
-</screen>
-      </listitem>
-
-      <listitem>
-        <para>
-        <emphasis role="bold">Cancel</emphasis> Selecting
-        Cancel causes the collected information to be discarded.
-        </para>
-      </listitem>
-    </itemizedlist>
-    </para>
-  </sect2>
-
-  <sect2 id="apport-crash-catching" status="review">
-    <title>Reporting Application Crashes</title>
-
-    <para>
-    The software package that provides the ubuntu-bug utility, 
-    <application>apport</application>, can be configured to trigger
-    when applications crash. This is disabled by default, as capturing
-    a crash can be resource intensive depending on how much memory
-    the application that crashed was using as apport captures and
-    processes the core dump.
-    </para>
-
-    <para>
-    Configuring apport to capture information about
-    crashing applications requires a couple of steps. First,
-    <application>gdb</application> needs to be installed; it is not
-    installed by default in Ubuntu Server Edition.
-    </para>
-
-<screen>
-<command>sudo apt-get install gdb</command>
-</screen>
-
-    <para>
-    See <xref linkend="package-management"/>
-    for more information about managing packages in Ubuntu.
-    </para>
-
-    <para>
-    Once you have ensured that gdb is installed, open the file
-    <filename>/etc/default/apport</filename> in your text editor,
-    and change the <emphasis>enabled</emphasis> setting to be
-    <emphasis role="bold">1</emphasis> like so:
-    </para>
-
-<programlisting>
-# set this to 0 to disable apport, or to 1 to enable it
-# you can temporarily override this with
-# sudo service apport start force_start=1
-enabled=<userinput>1</userinput>
-
-# set maximum core dump file size (default: 209715200 bytes == 200 MB)
-maxsize=209715200
-</programlisting>
-
-    <para>
-    Once you have completed editing
-    <filename>/etc/default/apport</filename>,
-    start the apport service:
-    </para>
-
-<screen>
-<command>sudo start apport</command>
-</screen>
-
-    <para>
-    After an application crashes, use the
-    <application>apport-cli</application> command to search for the
-    existing saved crash report information:
-    </para>
-
-<screen>
-<command>apport-cli</command>
-
-*** dash closed unexpectedly on 2010-03-11 at 21:40:59.
-
-If you were not doing anything confidential (entering passwords or other
-private information), you can help to improve the application by
-reporting
-the problem.
-
-What would you like to do? Your options are:
-  R: Report Problem...
-  I: Cancel and ignore future crashes of this program version
-  C: Cancel
-Please choose (R/I/C):
-</screen>
-
-    <para>
-    Selecting <emphasis>Report Problem</emphasis> will walk you through
-    similar steps as when using ubuntu-bug. One important difference
-    is that a crash report will be marked as private when filed on
-    Launchpad, meaning that it will be visible to only a limited set
-    of bug triagers. These triagers will review the gathered data for private
-    information before making the bug report publicly visible.
-    </para>
-
-    <!-- Include a bit here on using apport-retrace for generating a
-         full stack trace locally, for situations when the application
-	 does contain confidential information that should not be
-	 submitted to launchpad? -->
-
-  </sect2>
-
-  <sect2 id="reporting-bugs-resources" status="review">
-    <title>Resources</title>
-    <itemizedlist>
-      <listitem>
-        <para>
-	See the <ulink url="https://help.ubuntu.com/community/ReportingBugs">Reporting
-	Bugs</ulink> Ubuntu wiki page.
-	</para>
-      </listitem>
-      <listitem>
-        <para>
-	    Also, the <ulink url="https://wiki.ubuntu.com/Apport">Apport</ulink> page has some useful information.  Though some
-        of it pertains to using a GUI.
-    	</para>
-      </listitem>
-    </itemizedlist>
-  </sect2>
+    <para>While the Ubuntu Project attempts to release software with as few bugs as possible, they do occur. You can help fix these bugs by reporting ones that you find to the project. The Ubuntu Project uses <ulink url="https://launchpad.net/">Launchpad</ulink> to track its bug reports. In order to file a bug about Ubuntu Server on Launchpad, you will need to <ulink url="https://help.launchpad.net/YourAccount/NewAccount">create an account</ulink>. </para>
   </sect1>
-</appendix>
+</article>