Mercurial > p > roundup > code
comparison doc/user_guide.txt @ 3754:9f4dd27ae843
documentation cleanup from Luke Ross (patch [SF#1594860])
| author | Richard Jones <richard@users.sourceforge.net> |
|---|---|
| date | Sun, 12 Nov 2006 00:09:42 +0000 |
| parents | 790363e96852 |
| children | 068b3d7d4279 |
comparison
equal
deleted
inserted
replaced
| 3753:a6eff0dd2c9c | 3754:9f4dd27ae843 |
|---|---|
| 1 ========== | 1 ========== |
| 2 User Guide | 2 User Guide |
| 3 ========== | 3 ========== |
| 4 | 4 |
| 5 :Version: $Revision: 1.34 $ | 5 :Version: $Revision: 1.35 $ |
| 6 | 6 |
| 7 .. contents:: | 7 .. contents:: |
| 8 | 8 |
| 9 .. hint:: | 9 .. hint:: |
| 10 This document will refer to *issues* as the primary store of | 10 This document will refer to *issues* as the primary store of |
| 19 An item may be an *issue* (a bug or feature request) or a *user*. The | 19 An item may be an *issue* (a bug or feature request) or a *user*. The |
| 20 issue-ness or user-ness is called the item's *class*. So, for bug | 20 issue-ness or user-ness is called the item's *class*. So, for bug |
| 21 reports and features, the class is "issue", and for users the class is | 21 reports and features, the class is "issue", and for users the class is |
| 22 "user". | 22 "user". |
| 23 | 23 |
| 24 Each item in the tracker has an id number that identifies it along with | 24 Each item in the tracker has an ID number that identifies it along with |
| 25 its item class. To identify a particular issue or user, we combine the | 25 its item class. To identify a particular issue or user, we combine the |
| 26 class with the number to create a unique label, so that user 1 (who, | 26 class with the number to create a unique label, so that user 1 (who, |
| 27 incidentally, is *always* the "admin" user) is referred to as "user1". | 27 incidentally, is *always* the "admin" user) is referred to as "user1". |
| 28 Issue number 315 is referred to as "issue315". We call that label the | 28 Issue number 315 is referred to as "issue315". We call that label the |
| 29 item's *designator*. | 29 item's *designator*. |
| 729 | 729 |
| 730 | 730 |
| 731 Using with the shell | 731 Using with the shell |
| 732 -------------------- | 732 -------------------- |
| 733 | 733 |
| 734 With version 0.6.0 or newer of roundup which supports: multiple | 734 With version 0.6.0 or newer of roundup (which introduced support for |
| 735 designators to display and the -d, -S and -s flags. | 735 multiple designators to display and the -d, -S and -s flags): |
| 736 | 736 |
| 737 To find all messages regarding chatting issues that contain the word | 737 To find all messages regarding chatting issues that contain the word |
| 738 "spam", for example, you could execute the following command from the | 738 "spam", for example, you could execute the following command from the |
| 739 directory where the database dumps its files:: | 739 directory where the database dumps its files:: |
| 740 | 740 |