@@ -48,7 +48,7 @@ Clone the specified remote repository.
4848\fB git issue init \fP
4949.RS 4
5050Create a new issues repository in the current directory.
51- The \f C -e\fP option uses an existing Git project repository.
51+ The \f C -e\fP option uses an existing Git project repository.
5252
5353.RE
5454.PP
@@ -85,37 +85,37 @@ Specify (or remove with \fC-r\fP) the issue's milestone.
8585\fB git issue weight \fP
8686.RS 4
8787Specify (or remove with \f C -r\fP ) the issue's weight.
88- The weight is a positive integer that serves as a measure of importance.
88+ The weight is a positive integer that serves as a measure of importance.
8989.RE
9090.PP
9191\fB git issue duedate \fP
9292.RS 4
9393Specify (or remove with \f C -r\fP ) the issue's due date.
94- The command accepts all formats supported by the \f C date\fP utility.
94+ The command accepts all formats supported by the \f C date\fP utility.
9595.RE
9696.PP
9797\fB git issue timeestimate \fP
9898.RS 4
9999Specify (or remove with \f C -r\fP ) a time estimate for this issue.
100- Time estimates can be given in a format accepted by \f C date\fP ,
101- however bear in mind that it represents a time interval, not a date.
100+ Time estimates can be given in a format accepted by \f C date\fP ,
101+ however bear in mind that it represents a time interval, not a date.
102102.RE
103103.PP
104104\fB git issue timespent \fP
105105.RS 4
106106Specify (or remove with \f C -r\fP ) the time spent working on an issue so far.
107- Follows the same format outlined above.
108- If the \f C -a\fP option is given, the time interval will be added together with the existing one.
107+ Follows the same format outlined above.
108+ If the \f C -a\fP option is given, the time interval will be added together with the existing one.
109109.RE
110110.PP
111111\fB git issue assign \fP
112112.RS 4
113113Assign (or remove \f C -r\fP ) an issue to a person.
114- The person is specified with his/her email address.
115- The form \f C @name\fP or \f C name@\fP can be used as a shortcut, provided it
116- uniquely identifies an existing assignee or committer.
117- Note that if you plan to export the issue to a GitHub/GitLab repository, the assignee may be rejected if
118- it doesn't correspond to a valid username, or if you don't have the necessary permissions.
114+ The person is specified with his/her email address.
115+ The form \f C @name\fP or \f C name@\fP can be used as a shortcut, provided it
116+ uniquely identifies an existing assignee or committer.
117+ Note that if you plan to export the issue to a GitHub/GitLab repository, the assignee may be rejected if
118+ it doesn't correspond to a valid username, or if you don't have the necessary permissions.
119119.RE
120120.PP
121121\fB git issue attach \fP
@@ -136,43 +136,58 @@ Remove the \fCopen\fP tag, add the closed tag
136136\fB git issue list \fP
137137.RS 4
138138List open issues (or all with \f C -a\fP ).
139- An optional argument can show issues matching a tag or milestone.
139+ An optional argument can show issues matching a tag or milestone.
140140.RE
141141.PP
142142\fB git issue list -l formatstring \fP
143143.RS 4
144144This will list issues in the specified format, given as an argument to \f C -l\fP .
145- The following escape sequences can be used:
145+ The following escape sequences can be used:
146146
147- - \f C %n\fP : newline
148- - \f C %i\fP : issue ID
149- - \f C %c\fP : creation date
150- - \f C %d\fP : due date
151- - \f C %e\fP : time estimate
152- - \f C %s\fP : time spent
153- - \f C %w\fP : weight
154- - \f C %M\fP : Milestone
155- - \f C %A\fP : Assignee(s)
156- - \f C %T\fP : Tags
157- - \f C %D\fP : Description(first line)
147+ .IP " " 8
148+ \f C %n\fP : newline
149+ .IP " " 8
150+ \f C %i\fP : issue ID
151+ .IP " " 8
152+ \f C %c\fP : creation date
153+ .IP " " 8
154+ \f C %d\fP : due date
155+ .IP " " 8
156+ \f C %e\fP : time estimate
157+ .IP " " 8
158+ \f C %s\fP : time spent
159+ .IP " " 8
160+ \f C %w\fP : weight
161+ .IP " " 8
162+ \f C %M\fP : Milestone
163+ .IP " " 8
164+ \f C %A\fP : Assignee(s)
165+ .IP " " 8
166+ \f C %T\fP : Tags
167+ .IP " " 8
168+ \f C %D\fP : Description(first line)
158169
159- If the format string is one of: (\f C oneline\fP , \f C short\fP or `full`) it will interpreted as the corresponding preset.
170+ If the format string is one of: (\f C oneline\fP , \f C short\fP or `full`) it will interpreted as the corresponding preset.
160171
161- Optionally, one of the above given with \f C -o\fP will order based on this field(reverse order with \f C -r\fP ).
172+ Optionally, one of the above given with \f C -o\fP will order based on this field(reverse order with \f C -r\fP ).
162173
163174.RE
164175.PP
165176\fB git issue filter-apply command \fP
166177.RS 4
167178Run \f C command\fP in every issue directory. The following environment variables will be set:
168- - \f C GI_SHA\fP : Sha of the current issue
169- - \f C GI_IMPORTS\fP : The imports directories for current issue(one on each line)
170- - \f C GI_AUTHOR\fP : Author of current issue
171- - \f C GI_DATE\fP : Creation date of current issue
179+ .IP " " 8
180+ \f C GI_SHA\fP : Sha of the current issue
181+ .IP " " 8
182+ \f C GI_IMPORTS\fP : The imports directories for current issue(one on each line)
183+ .IP " " 8
184+ \f C GI_AUTHOR\fP : Author of current issue
185+ .IP " " 8
186+ \f C GI_DATE\fP : Creation date of current issue
172187
173- The command can read, add/remove or edit any of the issue's attributes.
174- Some potentially useful scripts to be used with this command are in the scripts/ directory.
175- Remember to inspect the results (e.g. \f C gi git diff\fP ) and commit them with \f C gi git commit -a\fP .
188+ The command can read, add/remove or edit any of the issue's attributes.
189+ Some potentially useful scripts to be used with this command are in the scripts/ directory.
190+ Remember to inspect the results (e.g. \f C gi git diff\fP ) and commit them with \f C gi git commit -a\fP .
176191
177192.RE
178193.PP
@@ -189,29 +204,29 @@ Update local Git repository with remote changes.
189204\fB git issue import \fP
190205.RS 4
191206Import/update GitHub/GitLab issues from the specified project.
192- If the import involves more than a dozen of issues or if the repository
193- is private, set the environment variable \f C GH_CURL_AUTH\fP (GitHub) or \f C GL_CURL_AUTH\fP (GitLab) to the authentication token.
194- For example, run the following command: \f C export GH_CURL_AUTH="Authorization: token badf00ddead9bfee8f3c19afc3c97c6db55fcfde"\fP
195- You can create the authorization token through
196- GitHub settings <https://github.com/settings/tokens/new>, with the \f C repo\fP and \f C delete_repo\fP (only for running the tests) permissions.
197- For GitLab: \f C export GL_CURL_AUTH="PRIVATE-TOKEN: JvHLsdnDmD7rjUXzT-Ea"\fP . The \f C api\fP permission is required.
198- Use the GitLab settings <https://gitlab.com/profile/personal\fI access \fP tokens> to create the token.
199- In case the repository is part of a GitLab group, specify repository as groupname/reponame.
207+ If the import involves more than a dozen of issues or if the repository
208+ is private, set the environment variable \f C GH_CURL_AUTH\fP (GitHub) or \f C GL_CURL_AUTH\fP (GitLab) to the authentication token.
209+ For example, run the following command: \f C export GH_CURL_AUTH="Authorization: token badf00ddead9bfee8f3c19afc3c97c6db55fcfde"\fP
210+ You can create the authorization token through
211+ GitHub settings <https://github.com/settings/tokens/new>, with the \f C repo\fP and \f C delete_repo\fP (only for running the tests) permissions.
212+ For GitLab: \f C export GL_CURL_AUTH="PRIVATE-TOKEN: JvHLsdnDmD7rjUXzT-Ea"\fP . The \f C api\fP permission is required.
213+ Use the GitLab settings <https://gitlab.com/profile/personal\fI access \fP tokens> to create the token.
214+ In case the repository is part of a GitLab group, specify repository as groupname/reponame.
200215.RE
201216.PP
202217\fB git issue create \fP
203218.RS 4
204219Create the issue in the provided GitHub repository.
205- With the \f C -e\fP option any escape sequences for the attributes present in the description, will be replaced as above.
206- This can be used to e.g. export an unsupported attribute to GitHub as text.
220+ With the \f C -e\fP option any escape sequences for the attributes present in the description, will be replaced as above.
221+ This can be used to e.g. export an unsupported attribute to GitHub as text.
207222.RE
208223.PP
209224\fB git issue export \fP
210225.RS 4
211226Export modified issues for the specified project.
212- Only the issues that have been imported and modified (or created by \f C git issue create\fP ) by \f C git-issue\fP will be exported.
213- With the \f C -e\fP option any escape sequences for the attributes present in the description, will be replaced as above.
214- This can be used to e.g. export an unsupported attribute to GitHub as text.
227+ Only the issues that have been imported and modified (or created by \f C git issue create\fP ) by \f C git-issue\fP will be exported.
228+ With the \f C -e\fP option any escape sequences for the attributes present in the description, will be replaced as above.
229+ This can be used to e.g. export an unsupported attribute to GitHub as text.
215230.RE
216231.PP
217232\fB git issue exportall \fP
@@ -262,21 +277,21 @@ A \fCconfig\fP file with configuration data.
262277An \f C imports\fP directory contains details about imported issues.
263278.IP " " 8
264279The \f C sha\fP file under \f C import/<provider>/<user>/<repo>/<number>\fP contains the
265- \fI git-issue \fP SHA corresponding to an imported GitHub \fI number \fP issue.
266- Likewise for GitLab.
280+ \fI git-issue \fP SHA corresponding to an imported GitHub \fI number \fP issue.
281+ Likewise for GitLab.
267282.IP " " 8
268283The \f C sha\fP file under \f C import/<provider>/<user>/<repo>/<number>/comments/<number>\fP
269- contains the \fI git-issue \fP comment SHA corresponding to an imported GitHub/GitLab
270- \fI number \fP comment.
284+ contains the \fI git-issue \fP comment SHA corresponding to an imported GitHub/GitLab
285+ \fI number \fP comment.
271286.IP " " 8
272287The file \f C import/<provider>/<user>/<repo>/checkpoint\fP contains the SHA
273- of the last imported or updated issue. This can be used for merging
274- future updates.
288+ of the last imported or updated issue. This can be used for merging
289+ future updates.
275290.IP " " 4
276291An \f C issues\fP directory contains the individual issues.
277292.IP " " 4
278293Each issue is stored in a directory named \f C issues/xx/xxxxxxx...\fP ,
279- where the x's are the SHA of the issue's initial commit.
294+ where the x's are the SHA of the issue's initial commit.
280295.IP " " 4
281296Each issue can have the following elements in its directory.
282297.IP " " 8
@@ -289,8 +304,8 @@ A \fCweight\fP file with the weight stored as a positive integer.
289304A \f C timespent\fP and \f C timeestimate\fP file with the time estimate and time spent respectively, stored in seconds.
290305.IP " " 8
291306A \f C comments\fP directory where comments are stored, each with the SHA of
292- a commit containing the text \f C gi comment mark\fP
293- \fI issue SHA \fP .
307+ a commit containing the text \f C gi comment mark\fP
308+ \fI issue SHA \fP .
294309.IP " " 8
295310An \f C attachments\fP directory where the issue's attachments are stored.
296311.IP " " 8
0 commit comments