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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.5//EN">
<refentry id="ti">
<refmeta>
<refentrytitle>ti</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="date">June 2008</refmiscinfo>
<refmiscinfo class="source"></refmiscinfo>
<refmiscinfo class="title">ticgit issue tracker</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ti</refname>
<refpurpose>issue tracking system built on Git</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>ti</command>
<arg choice="req"><replaceable>COMMAND</replaceable></arg>
<arg choice="opt"><replaceable>ARGUMENTS</replaceable></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
<para>
<command>ti</command>, short for ticgit, is an issue tracker based
in the Git revision control system. It allows you to store bugs
in your project in a separate <literal>ticgit</literal> branch of
its development repository, thereby keeping open issues close to
the source without cluttering the tree. Just like any other
branch, <literal>ticgit</literal> can be pushed to a public server
and cloned by everyone for inspection and local modification.
</para>
<para>
Every ticket consists of the following information:
</para>
<variablelist>
<varlistentry>
<term>Title</term>
<listitem>
<para>
A short summary of the problem. This can be compared to the
subject of an e-mail or to the first line of a Git commit
message.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Ticket ID</term>
<listitem>
<para>
The Ticket ID (TicId) is the SHA-1 hash of the file which
holds the ticket name (which is a normalized form of the
title including the time of ticket creation and a small
random number). It is used to uniquely identify a ticket.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Number</term>
<listitem>
<para>
Apart from TicIds, tickets can also be referred to by using
their number. This will often be preferred to TicIds when
using ticgit from the command line (i.e., in everyday work),
but ticket numbers are not persistent (they change with
every <literal>ti list</literal> invocation).
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>State</term>
<listitem>
<para>
A ticket can either be <literal>open</literal>,
<literal>resolved</literal>, <literal>invalid</literal> or put
on <literal>hold</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Assignment</term>
<listitem>
<para>
The e-mail address of the person working on the ticket.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>Tag</term>
<listitem>
<para>
A custom label which tells more about the nature of a ticket.
A typical example is <literal>feature</literal> (not a bug,
but a feature suggestion). ticgit associates no special
semantics to tags, you are free to choose them however you
like.
</para>
<para>
Tickets can have an arbitrary number of tags.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>COMMANDS</title>
<para><command>ti</command> supports the following commands:</para>
<variablelist>
<varlistentry>
<term><literal>list</literal></term>
<listitem>
<para>
List tickets. By default, only <literal>open</literal> issues
are shown; to show tickets in other states, use <literal>-s
STATE</literal>. You can also select by tag
(<literal>-t TAG</literal>) or by assignment
(<literal>-a ADDRESS</literal>). When running
<literal>list</literal>, small integer numbers will be
assigned to all shown tickets; you may use them to refer to
tickets in other commands until you call
<literal>list</literal> again.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>state</literal></term>
<listitem>
<para>
Pass a ticket ID and a state specification to set the
ticket's state information. You can omit the ticket ID to
work on the current ticket.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>show</literal></term>
<listitem>
<para>
Show everything known about the specified ticket. You can
omit the ticket ID to show the current ticket.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>new</literal></term>
<listitem>
<para>
Create a new ticket. This will launch an editor to let you
enter a title, more detailled information about the issue,
and some tags. Initially, the ticket will be in the
<literal>open</literal> state.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>checkout</literal></term>
<listitem>
<para>
Set the current ticket.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>comment</literal></term>
<listitem>
<para>
Add a comment to the ticket specified on the command line.
If you do not pass one, the current ticket will be used.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>tag</literal></term>
<listitem>
<para>
Pass a ticket ID and a tag name to add a label to an issue.
You can omit the ticket ID to tag the current ticket. If
you use the <literal>-d</literal> option, the tag will be
removed instead of added.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>assign</literal></term>
<listitem>
<para>
Assign the specified ticket to you (or to the given user,
when <literal>-u ADDRESS</literal> is given). If you omit
the ticket ID, the current ticket will be assigned.
Otherwise, you can prepend <literal>-c</literal> to the
ticket ID to perform the <literal>checkout</literal> operation
after assigning the ticket.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
These commands, except for <literal>state</literal>,
<literal>show</literal> and <literal>checkout</literal>, show
usage information about themselves when passed the
<literal>-h</literal> option.
</para>
</refsect1>
<refsect1>
<title>FILES</title>
<variablelist>
<varlistentry>
<term><filename>~/.ticgit/</filename></term>
<listitem>
<para>
The ticket cache.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>
ticgit is Copyright © 2008 Scott Chacon
<<email>schacon@gmail.com</email>>.
</para>
<para>
This manual page was written by Michael Schutte for the Debian
GNU/Linux system (but may be used by others).
</para>
</refsect1>
</refentry>
<!-- vim: set sw=2 sts=2 et tw=72: -->
|
