Skip to content

Commit fc3d7f7

Browse files
committed
Sync documentation
1 parent a65d95b commit fc3d7f7

File tree

2 files changed

+42
-43
lines changed

2 files changed

+42
-43
lines changed

git-issue.1

Lines changed: 40 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.TH GIT-ISSUE 1 "17 April 2018"
1+
.TH GIT-ISSUE 1 "11 October 2019"
22
.\"
33
.\" (C) Copyright 2016-2018 Diomidis Spinellis
44
.\"
@@ -49,6 +49,7 @@ Clone the specified remote repository.
4949
.RS 4
5050
Create a new issues repository in the current directory.
5151
The \fC-e\fP option uses an existing Git project repository.
52+
5253
.RE
5354
.PP
5455
\fBgit issue new\fP
@@ -142,7 +143,7 @@ List open issues (or all with \fC-a\fP).
142143
.RS 4
143144
This will list issues in the specified format, given as an argument to \fC-l\fP.
144145
The following escape sequences can be used:
145-
146+
146147
- \fC%n\fP : newline
147148
- \fC%i\fP : issue ID
148149
- \fC%c\fP : creation date
@@ -156,23 +157,23 @@ This will list issues in the specified format, given as an argument to \fC-l\fP.
156157
- \fC%D\fP : Description(first line)
157158

158159
If the format string is one of: (\fConeline\fP, \fCshort\fP or `full`) it will interpreted as the corresponding preset.
159-
160+
160161
Optionally, one of the above given with \fC-o\fP will order based on this field(reverse order with \fC-r\fP).
161-
162+
162163
.RE
163164
.PP
164165
\fBgit issue filter-apply command\fP
165166
.RS 4
166-
Run \fCcommand\fP in every issue directory. The following environment variables will be set:
167+
Run \fCcommand\fP in every issue directory. The following environment variables will be set:
167168
- \fCGI_SHA\fP : Sha of the current issue
168169
- \fCGI_IMPORTS\fP : The imports directories for current issue(one on each line)
169170
- \fCGI_AUTHOR\fP : Author of current issue
170171
- \fCGI_DATE\fP : Creation date of current issue
171-
172+
172173
The command can read, add/remove or edit any of the issue's attributes.
173174
Some potentially useful scripts to be used with this command are in the scripts/ directory.
174175
Remember to inspect the results (e.g \fCgi git diff\fP) and commit them with \fCgi git commit -a\fP.
175-
176+
176177
.RE
177178
.PP
178179
\fBgit issue push\fP
@@ -193,9 +194,7 @@ Import/update GitHub/GitLab issues from the specified project.
193194
For example, run the following command: \fCexport GH_CURL_AUTH="Authorization: token badf00ddead9bfee8f3c19afc3c97c6db55fcfde"\fP
194195
You can create the authorization token through
195196
GitHub settings <https://github.com/settings/tokens/new>, with the \fCrepo\fP and \fCdelete_repo\fP(only for running the tests) permissions.
196-
197-
For GitLab: \fCexport GL_CURL_AUTH="PRIVATE-TOKEN: JvHLsdnDmD7rjUXzT-Ea"\fP
198-
The \fCapi\fP permission is required.
197+
For GitLab: \fCexport GL_CURL_AUTH="PRIVATE-TOKEN: JvHLsdnDmD7rjUXzT-Ea"\fP. The \fCapi\fP permission is required.
199198
Use the GitLab settings <https://gitlab.com/profile/personal\fIaccess\fPtokens> to create the token.
200199
In case the repository is part of a GitLab group, specify repository as groupname/reponame.
201200
.RE
@@ -312,8 +311,8 @@ The command terminates with a non zero exit code on errors.
312311
.\" Auto-generated content from README.md; do not edit this section
313312
You can also view a video of the following session on YouTube <https://youtu.be/9aKHTjtTbFs>.
314313

315-
.ft P
316314
.fi
315+
.ft R
317316
.PP
318317
Initialize issue repository
319318
.ft C
@@ -323,17 +322,17 @@ Initialized empty Issues repository in /home/dds/src/gi/.issues
323322
$ git issue new -s 'New issue entered from the command line'
324323
Added issue e6a95c9
325324

326-
.ft P
327325
.fi
326+
.ft R
328327
.PP
329328
Create a new issue (opens editor window)
330329
.ft C
331330
.nf
332331
$ git issue new
333332
Added issue 7dfa5b7
334333

335-
.ft P
336334
.fi
335+
.ft R
337336
.PP
338337
List open issues
339338
.ft C
@@ -342,53 +341,53 @@ $ git issue list
342341
7dfa5b7 An issue entered from the editor
343342
e6a95c9 New issue entered from the command line
344343

345-
.ft P
346344
.fi
345+
.ft R
347346
.PP
348347
Add an issue comment (opens editor window)
349348
.ft C
350349
.nf
351350
$ git issue comment e6a95c9
352351
Added comment 8c0d5b3
353352

354-
.ft P
355353
.fi
354+
.ft R
356355
.PP
357356
Add a due date for the issue
358-
\fC\fP\fC.ft C
357+
.ft C
359358
.nf
360359
$ git issue duedate "next Tuesday" e6a95c9
361360
Added duedate 2019-08-13T00:00:00+03:00
362361

363-
.ft P
364362
.fi
363+
.ft R
365364
.PP
366365
Keep track of time spent on the issue
367-
\fC\fP\fC.ft C
366+
.ft C
368367
.nf
369368
$ git issue timespent "2hours" e6a95c9
370369
Added timespent 7200
371370

372-
.ft P
373371
.fi
372+
.ft R
374373
.PP
375374
Log additional time spent working on it
376-
\fC\fP\fC.ft C
375+
.ft C
377376
.nf
378377
$ git issue timespent -a "4 hours" e6a95c9
379378
Added timespent 21600
380379

381-
.ft P
382380
.fi
381+
.ft R
383382
.PP
384383
Add tag to an issue
385384
.ft C
386385
.nf
387386
$ git issue tag e6a9 urgent
388387
Added tag urgent
389388

390-
.ft P
391389
.fi
390+
.ft R
392391
.PP
393392
Add two more tags
394393
.ft C
@@ -397,44 +396,44 @@ $ git issue tag e6a9 gui crash
397396
Added tag gui
398397
Added tag crash
399398

400-
.ft P
401399
.fi
400+
.ft R
402401
.PP
403402
Remove a tag
404403
.ft C
405404
.nf
406405
$ git issue tag -r e6a9 urgent
407406
Removed tag urgent
408407

409-
.ft P
410408
.fi
409+
.ft R
411410
.PP
412411
Assign issue
413412
.ft C
414413
.nf
415414
$ git issue assign e6a9 joe@example.com
416415
Assigned to joe@example.com
417416

418-
.ft P
419417
.fi
418+
.ft R
420419
.PP
421420
Add issue watcher
422421
.ft C
423422
.nf
424423
$ git issue watcher e6a9 jane@example.com
425424
Added watcher jane@example.com
426425

427-
.ft P
428426
.fi
427+
.ft R
429428
.PP
430429
List issues tagged as gui
431430
.ft C
432431
.nf
433432
$ git issue list gui
434433
e6a95c9 New issue entered from the command line
435434

436-
.ft P
437435
.fi
436+
.ft R
438437
.PP
439438
Push issues repository to a server
440439
.ft C
@@ -449,8 +448,8 @@ To git@github.com:dspinellis/gi-example.git
449448
* [new branch] master -> master
450449
Branch master set up to track remote branch master from origin.
451450

452-
.ft P
453451
.fi
452+
.ft R
454453
.PP
455454
Clone issues repository from server
456455
.ft C
@@ -465,8 +464,8 @@ Resolving deltas: 100% (8/8), done.
465464
Checking connectivity... done.
466465
Cloned git@github.com:dspinellis/gi-example.git into my-issues
467466

468-
.ft P
469467
.fi
468+
.ft R
470469
.PP
471470
List open issues
472471
.ft C
@@ -475,17 +474,17 @@ $ git issue list
475474
7dfa5b7 An issue entered from the editor
476475
e6a95c9 New issue entered from the command line
477476

478-
.ft P
479477
.fi
478+
.ft R
480479
.PP
481480
Create new issue
482481
.ft C
483482
.nf
484483
$ git issue new -s 'Issue added on another host'
485484
Added issue abc9adc
486485

487-
.ft P
488486
.fi
487+
.ft R
489488
.PP
490489
Push changes to server
491490
.ft C
@@ -498,8 +497,8 @@ Total 7 (delta 0), reused 0 (delta 0)
498497
To git@github.com:dspinellis/gi-example.git
499498
d6be890..740f9a0 master -> master
500499

501-
.ft P
502500
.fi
501+
.ft R
503502
.PP
504503
Show issue added on the other host
505504
.ft C
@@ -514,8 +513,8 @@ Tags: open
514513

515514
Here is a longer description.
516515

517-
.ft P
518516
.fi
517+
.ft R
519518
.PP
520519
Show issue and comments
521520
.ft C
@@ -536,8 +535,8 @@ Date: Fri, 29 Jan 2016 01:03:57 +0200
536535

537536
First comment regarding the issue.
538537

539-
.ft P
540538
.fi
539+
.ft R
541540
.PP
542541
Pull in remote changes (on the original host)
543542
.ft C
@@ -557,8 +556,8 @@ Fast-forward
557556
create mode 100644 issues/ab/c9adc61025a3cb73b0c67470b65cefc133a8d0/description
558557
create mode 100644 issues/ab/c9adc61025a3cb73b0c67470b65cefc133a8d0/tags
559558

560-
.ft P
561559
.fi
560+
.ft R
562561
.PP
563562
List open issues
564563
.ft C
@@ -568,8 +567,8 @@ $ git issue list
568567
abc9adc Issue added on another host
569568
e6a95c9 New issue entered from the command line
570569

571-
.ft P
572570
.fi
571+
.ft R
573572
.PP
574573
Import issues from GitHub
575574
.ft C
@@ -608,8 +607,8 @@ Thu, 30 Aug 2018 20:59:59 +0000 by dspinellis
608607
.IP "" 4
609608
<dspinellis@users.noreply.github.com>
610609

611-
.ft P
612610
.fi
611+
.ft R
613612
.PP
614613
Export all issues to GitHub
615614
.ft C
@@ -625,8 +624,8 @@ Creating comment 6966d4d718c80cf8635e9276d6f391de70c22f93...
625624
Creating comment 85293a6904d0fbd6238fbb2e1c36fc65af9ffc60...
626625
Creating comment aea83723c0414ff135afcfb5165d64f8a7ad687c...
627626

628-
.ft P
629627
.fi
628+
.ft R
630629
.PP
631630
Make changes
632631
.ft C
@@ -638,8 +637,8 @@ $ git issue edit -c d72c6
638637
Opening editor...
639638
Edited comment d72c68d
640639

641-
.ft P
642640
.fi
641+
.ft R
643642
.PP
644643
Export modified issues back to GitHub
645644
.ft C
@@ -654,8 +653,8 @@ Comment 6966d4d718c80cf8635e9276d6f391de70c22f93 hasn't been modified, skipping.
654653
Comment 85293a6904d0fbd6238fbb2e1c36fc65af9ffc60 hasn't been modified, skipping...
655654
Comment aea83723c0414ff135afcfb5165d64f8a7ad687c hasn't been modified, skipping...
656655

657-
.ft P
658656
.fi
657+
.ft R
659658
.PP
660659
Sub-command auto-completion
661660
.ft C
@@ -664,8 +663,8 @@ $ git issue [Tab]
664663
assign clone comment git init log pull show watcher
665664
attach close edit help list new push tag
666665

667-
.ft P
668666
.fi
667+
.ft R
669668
.PP
670669
Issue SHA auto-completion
671670
.ft C

git-issue.sh

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
# User agent string
2828
# shellcheck disable=SC2034
2929
# SC2034 : USER_AGENT appears unused. Verify use (or export if used externally)
30-
USER_AGENT=https://github.com/dspinellis/git-issue/tree/3565b3b
30+
USER_AGENT=https://github.com/dspinellis/git-issue/tree/ea66152
3131

3232
# Determine our script library path
3333
my_IFS=$IFS
@@ -1391,7 +1391,7 @@ Show multiple issues
13911391
* list -l formatstring: This will list issues in the specified format, given as an argument to -l
13921392
13931393
Work with multiple issues
1394-
* filter-apply command: Run command in every issue directory The following environment variables will be set:
1394+
* filter-apply command: Run command in every issue directory The following environment variables will be set:
13951395
13961396
Synchronize with remote repositories
13971397
push Update remote Git repository with local changes

0 commit comments

Comments
 (0)