README
changeset 59 6c388fe11dcc
parent 55 c379bed603c6
child 62 c933fa2cd204
equal deleted inserted replaced
58:bc4b0df08e0d 59:6c388fe11dcc
    24 
    24 
    25 Setup
    25 Setup
    26 -----
    26 -----
    27 
    27 
    28 In the ``[extensions]`` section of your ``~/.hgrc`` add::
    28 In the ``[extensions]`` section of your ``~/.hgrc`` add::
    29     
    29 
    30     artemis = /path/to/artemis.py
    30     artemis = /path/to/artemis.py
    31 
    31 
    32 Optionally, provide a section ``[artemis]``, and specify an alternative path for
    32 Optionally, provide a section ``[artemis]``, and specify an alternative path for
    33 the issues subdirectory (instead of the default ``.issues``)::
    33 the issues subdirectory (instead of the default ``.issues``)::
    34 
    34 
    41 
    41 
    42 Create an issue::
    42 Create an issue::
    43 
    43 
    44     # hg iadd
    44     # hg iadd
    45     ... enter some text in an editor ...
    45     ... enter some text in an editor ...
    46     Added new issue 907ab57e04502afd 
    46     Added new issue 907ab57e04502afd
    47 
    47 
    48     # hg ilist
    48     # hg ilist
    49     907ab57e04502afd (  0) [new]: New issue
    49     907ab57e04502afd (  0) [new]: New issue
    50 
    50 
    51     # hg ishow 907
    51     # hg ishow 907
    54     Date: ...
    54     Date: ...
    55     Subject: New issue
    55     Subject: New issue
    56     State: new
    56     State: new
    57 
    57 
    58     Detailed description.
    58     Detailed description.
    59     
    59 
    60     ----------------------------------------------------------------------
    60     ----------------------------------------------------------------------
    61 
    61 
    62 Add a comment to the issue::
    62 Add a comment to the issue::
    63     
    63 
    64     # hg iadd 907
    64     # hg iadd 907
    65     ... enter the comment text
    65     ... enter the comment text
    66     ======================================================================
    66     ======================================================================
    67     From: ...
    67     From: ...
    68     [snip]
    68     [snip]
    69     Detailed description.
    69     Detailed description.
    70     
    70 
    71     ----------------------------------------------------------------------
    71     ----------------------------------------------------------------------
    72     Comments:
    72     Comments:
    73       1: [dmitriy] Some comment
    73       1: [dmitriy] Some comment
    74     ----------------------------------------------------------------------
    74     ----------------------------------------------------------------------
    75 
    75 
    79     ... enter the comment text ...
    79     ... enter the comment text ...
    80     ======================================================================
    80     ======================================================================
    81     From: ...
    81     From: ...
    82     [snip]
    82     [snip]
    83     Detailed description.
    83     Detailed description.
    84     
    84 
    85     ----------------------------------------------------------------------
    85     ----------------------------------------------------------------------
    86     Comments:
    86     Comments:
    87       1: [dmitriy] Some comment
    87       1: [dmitriy] Some comment
    88         2: [dmitriy] Comment on a comment
    88         2: [dmitriy] Comment on a comment
    89     ----------------------------------------------------------------------
    89     ----------------------------------------------------------------------
    93     # hg iadd 907 -p state=resolved -p resolution=fixed -n
    93     # hg iadd 907 -p state=resolved -p resolution=fixed -n
    94     ======================================================================
    94     ======================================================================
    95     From: ...
    95     From: ...
    96     [snip]
    96     [snip]
    97     Detailed description.
    97     Detailed description.
    98     
    98 
    99     ----------------------------------------------------------------------
    99     ----------------------------------------------------------------------
   100     Comments:
   100     Comments:
   101       1: [dmitriy] Some comment
   101       1: [dmitriy] Some comment
   102         2: [dmitriy] Comment on a comment
   102         2: [dmitriy] Comment on a comment
   103       3: [dmitriy] changed properties (state=resolved, resolution=fixed)
   103       3: [dmitriy] changed properties (state=resolved, resolution=fixed)
   147 
   147 
   148     `-a`, `--all`
   148     `-a`, `--all`
   149         list all issues (not just the `new` ones)
   149         list all issues (not just the `new` ones)
   150 
   150 
   151     `-p`, `--property`
   151     `-p`, `--property`
   152         list issues with specific property values, e.g. 
   152         list issues with specific property values, e.g.
   153         ``-p state=resolved -p category=documentation``;
   153         ``-p state=resolved -p category=documentation``;
   154         if no property value is provided (e.g. ``-p category``), lists all
   154         if no property value is provided (e.g. ``-p category``), lists all
   155         possible values for that property (among the issues that satisfy the
   155         possible values for that property (among the issues that satisfy the
   156         rest of the criteria)
   156         rest of the criteria)
   157 
   157 
       
   158     `-o`, `--order`
       
   159         order of the issues; choices: "new" (date submitted), "latest" (date of
       
   160         the most recent message)
       
   161 
   158     `-d`, `--date`
   162     `-d`, `--date`
   159         restrict to issues matching the given date, e.g. ``-d ">1/1/2008"``
   163         restrict to issues matching the given date, e.g. ``-d ">1/1/2008"``
   160 
   164 
   161     `-f`, `--filter`
   165     `-f`, `--filter`
   162         restrict to a predefined filter, see Filters_ below
   166         restrict to a predefined filter, see Filters_ below
   163    
   167 
   164 
   168 
   165 `ishow` ``[ID] [COMMENT]``
   169 `ishow` ``[ID] [COMMENT]``
   166     Show an issue or a comment.
   170     Show an issue or a comment.
   167 
   171 
   168     `-a`, `--all`
   172     `-a`, `--all`