~bughelper-dev/bughelper/main

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
]>
<refentry>
  <refentryinfo>
    <author>
      <firstname>Alex</firstname>
      <surname>Muntada</surname>
      <email>ubuntu@alexm.org</email>
    </author>
    <copyright>
      <year>2007</year>
      <holder>Alex Muntada</holder>
    </copyright>
    <!-- XXX IMPORTANT XXX -->
    <!-- Keep this date up to date: -->
    <date>2007-12-31</date>
    <!--  ^^^^^^^^^^ -->
  </refentryinfo>
  <refmeta>
    <refentrytitle>bugxml</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>bugxml</refname>
    <refpurpose>A bug triaging tool for Malone</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>bugxml</command>
      <arg choice="plain">
        <option>--version</option>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>bugxml</command>
      <arg choice="plain">
        <option>-e <replaceable>&lt;text&gt;</replaceable></option>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>bugxml</command>
      <arg choice="plain">
        <option>-v <replaceable>&lt;clue-file&gt;</replaceable></option>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>bugxml</command>
      <arg choice="plain">
        <option>-a <replaceable>&lt;package&gt;</replaceable>
                   <replaceable>&lt;condition&gt;</replaceable>
                   <replaceable>&lt;clue&gt;</replaceable></option>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>OVERVIEW</title>
    <para>
      Bugxml is part of the bughelper suite written by Ubuntu's BugSquad!
    </para>
    <para>
      Bug triaging is one of the most challenging jobs 
      of the BugSquad team on Malone (Launchpad bug tracker).
      On Dec 2006, Henrik Nilsen Omma sent a message to
      the BugSquad mailing list announcing a script to
      help with bug triaging.  Then, Daniel Holbach started
      to improve it and both of them started a new product in
      Launchpad for <productname>bughelper</productname>,
      where the BugSquad team develops it further.
    </para>
  </refsect1>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
      This tool is primarily intended to help with the editing and creation
      of clue files for bughelper.
    </para>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>
    <para>
      These are all the options available so far:
    </para>
    <para>
      <variablelist>
        <title>bugxml options:</title>
        <varlistentry>
          <term><option>--version</option></term>
          <listitem><para>show program's version number and exit</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>-h</option>, <option>--help</option></term>
          <listitem><para>show this help message and exit</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>-e</option> STRING</term>
          <listitem><para>escape provided string for use in XML files</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>-v</option>, <option>--validate</option>=CLUEFILE</term>
          <listitem><para>validate syntax of provided file against the clue file schema</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>-a</option>, <option>--simple-add</option>=&lt;package&gt; &lt;condition&gt; &lt;clue&gt;</term>
          <listitem><para>add clue using condition to package</para></listitem>
        </varlistentry>
        <varlistentry>
          <term><option>-d</option>, <option>--dont-list</option>=BUGNUMBER[,BUGNUMBER,...]</term>
          <listitem>
            <para>adds a dontlist tag to XML with the bug numbers
            in the comma separated list provided.  This option is
            used in combination with <option>-a</option> only
            </para>
          </listitem>
        </varlistentry>
      </variablelist>
    </para>
  </refsect1>
  <refsect1>
    <title>COPYRIGHT</title>
    <para>
      This manual page was written by Ubuntu's BugSquad for the
      <productname>Malone</productname> bug tracking system.
      Permission is granted to copy, distribute and/or modify this document
      under the terms of the <acronym>GNU</acronym> General Public License,
      Version 2 or any later version published by the Free Software Foundation.
    </para>
    <para>
      On Debian systems (like Ubuntu), the complete text of the
      GNU General Public License can be found in
      <filename>/usr/share/common-licenses/GPL</filename>.
    </para>
  </refsect1>
</refentry>