Skip to content

Commit aaee991

Browse files
author
Hugo Hörnquist
committed
Add updated git-issue.1.
1 parent 1440353 commit aaee991

File tree

1 file changed

+71
-56
lines changed

1 file changed

+71
-56
lines changed

git-issue.1

+71-56
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Clone the specified remote repository.
4848
\fBgit issue init\fP
4949
.RS 4
5050
Create a new issues repository in the current directory.
51-
The \fC-e\fP option uses an existing Git project repository.
51+
The \fC-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
\fBgit issue weight\fP
8686
.RS 4
8787
Specify (or remove with \fC-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
\fBgit issue duedate\fP
9292
.RS 4
9393
Specify (or remove with \fC-r\fP) the issue's due date.
94-
The command accepts all formats supported by the \fCdate\fP utility.
94+
The command accepts all formats supported by the \fCdate\fP utility.
9595
.RE
9696
.PP
9797
\fBgit issue timeestimate\fP
9898
.RS 4
9999
Specify (or remove with \fC-r\fP) a time estimate for this issue.
100-
Time estimates can be given in a format accepted by \fCdate\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 \fCdate\fP,
101+
however bear in mind that it represents a time interval, not a date.
102102
.RE
103103
.PP
104104
\fBgit issue timespent\fP
105105
.RS 4
106106
Specify (or remove with \fC-r\fP) the time spent working on an issue so far.
107-
Follows the same format outlined above.
108-
If the \fC-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 \fC-a\fP option is given, the time interval will be added together with the existing one.
109109
.RE
110110
.PP
111111
\fBgit issue assign\fP
112112
.RS 4
113113
Assign (or remove \fC-r\fP) an issue to a person.
114-
The person is specified with his/her email address.
115-
The form \fC@name\fP or \fCname@\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 \fC@name\fP or \fCname@\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
\fBgit issue attach\fP
@@ -136,43 +136,58 @@ Remove the \fCopen\fP tag, add the closed tag
136136
\fBgit issue list\fP
137137
.RS 4
138138
List open issues (or all with \fC-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
\fBgit issue list -l formatstring\fP
143143
.RS 4
144144
This will list issues in the specified format, given as an argument to \fC-l\fP.
145-
The following escape sequences can be used:
145+
The following escape sequences can be used:
146146

147-
- \fC%n\fP : newline
148-
- \fC%i\fP : issue ID
149-
- \fC%c\fP : creation date
150-
- \fC%d\fP : due date
151-
- \fC%e\fP : time estimate
152-
- \fC%s\fP : time spent
153-
- \fC%w\fP : weight
154-
- \fC%M\fP : Milestone
155-
- \fC%A\fP : Assignee(s)
156-
- \fC%T\fP : Tags
157-
- \fC%D\fP : Description(first line)
147+
.IP "" 8
148+
\fC%n\fP : newline
149+
.IP "" 8
150+
\fC%i\fP : issue ID
151+
.IP "" 8
152+
\fC%c\fP : creation date
153+
.IP "" 8
154+
\fC%d\fP : due date
155+
.IP "" 8
156+
\fC%e\fP : time estimate
157+
.IP "" 8
158+
\fC%s\fP : time spent
159+
.IP "" 8
160+
\fC%w\fP : weight
161+
.IP "" 8
162+
\fC%M\fP : Milestone
163+
.IP "" 8
164+
\fC%A\fP : Assignee(s)
165+
.IP "" 8
166+
\fC%T\fP : Tags
167+
.IP "" 8
168+
\fC%D\fP : Description(first line)
158169

159-
If the format string is one of: (\fConeline\fP, \fCshort\fP or `full`) it will interpreted as the corresponding preset.
170+
If the format string is one of: (\fConeline\fP, \fCshort\fP or `full`) it will interpreted as the corresponding preset.
160171

161-
Optionally, one of the above given with \fC-o\fP will order based on this field(reverse order with \fC-r\fP).
172+
Optionally, one of the above given with \fC-o\fP will order based on this field(reverse order with \fC-r\fP).
162173

163174
.RE
164175
.PP
165176
\fBgit issue filter-apply command\fP
166177
.RS 4
167178
Run \fCcommand\fP in every issue directory. The following environment variables will be set:
168-
- \fCGI_SHA\fP : Sha of the current issue
169-
- \fCGI_IMPORTS\fP : The imports directories for current issue(one on each line)
170-
- \fCGI_AUTHOR\fP : Author of current issue
171-
- \fCGI_DATE\fP : Creation date of current issue
179+
.IP "" 8
180+
\fCGI_SHA\fP : Sha of the current issue
181+
.IP "" 8
182+
\fCGI_IMPORTS\fP : The imports directories for current issue(one on each line)
183+
.IP "" 8
184+
\fCGI_AUTHOR\fP : Author of current issue
185+
.IP "" 8
186+
\fCGI_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. \fCgi git diff\fP) and commit them with \fCgi 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. \fCgi git diff\fP) and commit them with \fCgi git commit -a\fP.
176191

177192
.RE
178193
.PP
@@ -189,29 +204,29 @@ Update local Git repository with remote changes.
189204
\fBgit issue import\fP
190205
.RS 4
191206
Import/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 \fCGH_CURL_AUTH\fP (GitHub) or \fCGL_CURL_AUTH\fP (GitLab) to the authentication token.
194-
For example, run the following command: \fCexport 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 \fCrepo\fP and \fCdelete_repo\fP(only for running the tests) permissions.
197-
For GitLab: \fCexport GL_CURL_AUTH="PRIVATE-TOKEN: JvHLsdnDmD7rjUXzT-Ea"\fP. The \fCapi\fP permission is required.
198-
Use the GitLab settings <https://gitlab.com/profile/personal\fIaccess\fPtokens> 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 \fCGH_CURL_AUTH\fP (GitHub) or \fCGL_CURL_AUTH\fP (GitLab) to the authentication token.
209+
For example, run the following command: \fCexport 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 \fCrepo\fP and \fCdelete_repo\fP(only for running the tests) permissions.
212+
For GitLab: \fCexport GL_CURL_AUTH="PRIVATE-TOKEN: JvHLsdnDmD7rjUXzT-Ea"\fP. The \fCapi\fP permission is required.
213+
Use the GitLab settings <https://gitlab.com/profile/personal\fIaccess\fPtokens> 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
\fBgit issue create\fP
203218
.RS 4
204219
Create the issue in the provided GitHub repository.
205-
With the \fC-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 \fC-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
\fBgit issue export\fP
210225
.RS 4
211226
Export modified issues for the specified project.
212-
Only the issues that have been imported and modified (or created by \fCgit issue create\fP) by \fCgit-issue\fP will be exported.
213-
With the \fC-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 \fCgit issue create\fP) by \fCgit-issue\fP will be exported.
228+
With the \fC-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
\fBgit issue exportall\fP
@@ -262,21 +277,21 @@ A \fCconfig\fP file with configuration data.
262277
An \fCimports\fP directory contains details about imported issues.
263278
.IP "" 8
264279
The \fCsha\fP file under \fCimport/<provider>/<user>/<repo>/<number>\fP contains the
265-
\fIgit-issue\fP SHA corresponding to an imported GitHub \fInumber\fP issue.
266-
Likewise for GitLab.
280+
\fIgit-issue\fP SHA corresponding to an imported GitHub \fInumber\fP issue.
281+
Likewise for GitLab.
267282
.IP "" 8
268283
The \fCsha\fP file under \fCimport/<provider>/<user>/<repo>/<number>/comments/<number>\fP
269-
contains the \fIgit-issue\fP comment SHA corresponding to an imported GitHub/GitLab
270-
\fInumber\fP comment.
284+
contains the \fIgit-issue\fP comment SHA corresponding to an imported GitHub/GitLab
285+
\fInumber\fP comment.
271286
.IP "" 8
272287
The file \fCimport/<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
276291
An \fCissues\fP directory contains the individual issues.
277292
.IP "" 4
278293
Each issue is stored in a directory named \fCissues/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
281296
Each 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.
289304
A \fCtimespent\fP and \fCtimeestimate\fP file with the time estimate and time spent respectively, stored in seconds.
290305
.IP "" 8
291306
A \fCcomments\fP directory where comments are stored, each with the SHA of
292-
a commit containing the text \fCgi comment mark\fP
293-
\fIissue SHA\fP.
307+
a commit containing the text \fCgi comment mark\fP
308+
\fIissue SHA\fP.
294309
.IP "" 8
295310
An \fCattachments\fP directory where the issue's attachments are stored.
296311
.IP "" 8

0 commit comments

Comments
 (0)