diff options
author | Roger Shimizu <rosh@debian.org> | 2021-06-20 21:41:05 +0900 |
---|---|---|
committer | Mike Frysinger <vapier@google.com> | 2021-07-16 20:11:41 +0000 |
commit | 0a1f533e2835c856473e3e4046341a4d2f66764b (patch) | |
tree | 0902c039b76525f1c6785cec561df46265fdb787 /man/repo-status.1 | |
parent | 927d29a8afa26a3f1aec841f2150c65e3931ef9b (diff) | |
download | git-repo-0a1f533e2835c856473e3e4046341a4d2f66764b.tar.gz |
Add script 'release/update-manpages' to generate manpages
Debian package started to ship manpages for repo since 2.8 [1]
And it's about for one year. So I think it should be upstreamed.
The script depends on help2man, which is available in both debian [2]
and ubuntu [3].
[1] https://tracker.debian.org/news/1150858/accepted-repo-28-1-source-into-unstable
[2] https://tracker.debian.org/pkg/help2man
[3] https://launchpad.net/ubuntu/+source/help2man
Change-Id: Ide2b356d0944ebde34cc96c6d5a782655bd72288
Signed-off-by: Roger Shimizu <rosh@debian.org>
Reviewed-on: https://gerrit-review.googlesource.com/c/git-repo/+/309782
Reviewed-by: Mike Frysinger <vapier@google.com>
Diffstat (limited to 'man/repo-status.1')
-rw-r--r-- | man/repo-status.1 | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/man/repo-status.1 b/man/repo-status.1 new file mode 100644 index 00000000..6037ae1a --- /dev/null +++ b/man/repo-status.1 | |||
@@ -0,0 +1,97 @@ | |||
1 | .\" DO NOT MODIFY THIS FILE! It was generated by help2man. | ||
2 | .TH REPO "1" "July 2021" "repo status" "Repo Manual" | ||
3 | .SH NAME | ||
4 | repo \- repo status - manual page for repo status | ||
5 | .SH SYNOPSIS | ||
6 | .B repo | ||
7 | \fI\,status \/\fR[\fI\,<project>\/\fR...] | ||
8 | .SH DESCRIPTION | ||
9 | Summary | ||
10 | .PP | ||
11 | Show the working tree status | ||
12 | .SH OPTIONS | ||
13 | .TP | ||
14 | \fB\-h\fR, \fB\-\-help\fR | ||
15 | show this help message and exit | ||
16 | .TP | ||
17 | \fB\-j\fR JOBS, \fB\-\-jobs\fR=\fI\,JOBS\/\fR | ||
18 | number of jobs to run in parallel (default: 4) | ||
19 | .TP | ||
20 | \fB\-o\fR, \fB\-\-orphans\fR | ||
21 | include objects in working directory outside of repo | ||
22 | projects | ||
23 | .SS Logging options: | ||
24 | .TP | ||
25 | \fB\-v\fR, \fB\-\-verbose\fR | ||
26 | show all output | ||
27 | .TP | ||
28 | \fB\-q\fR, \fB\-\-quiet\fR | ||
29 | only show errors | ||
30 | .PP | ||
31 | Run `repo help status` to view the detailed manual. | ||
32 | .SH DETAILS | ||
33 | .PP | ||
34 | \&'repo status' compares the working tree to the staging area (aka index), and the | ||
35 | most recent commit on this branch (HEAD), in each project specified. A summary | ||
36 | is displayed, one line per file where there is a difference between these three | ||
37 | states. | ||
38 | .PP | ||
39 | The \fB\-j\fR/\-\-jobs option can be used to run multiple status queries in parallel. | ||
40 | .PP | ||
41 | The \fB\-o\fR/\-\-orphans option can be used to show objects that are in the working | ||
42 | directory, but not associated with a repo project. This includes unmanaged | ||
43 | top\-level files and directories, but also includes deeper items. For example, if | ||
44 | dir/subdir/proj1 and dir/subdir/proj2 are repo projects, dir/subdir/proj3 will | ||
45 | be shown if it is not known to repo. | ||
46 | .PP | ||
47 | Status Display | ||
48 | .PP | ||
49 | The status display is organized into three columns of information, for example | ||
50 | if the file 'subcmds/status.py' is modified in the project 'repo' on branch | ||
51 | \&'devwork': | ||
52 | .TP | ||
53 | project repo/ | ||
54 | branch devwork | ||
55 | .TP | ||
56 | \fB\-m\fR | ||
57 | subcmds/status.py | ||
58 | .PP | ||
59 | The first column explains how the staging area (index) differs from the last | ||
60 | commit (HEAD). Its values are always displayed in upper case and have the | ||
61 | following meanings: | ||
62 | .TP | ||
63 | \-: | ||
64 | no difference | ||
65 | .TP | ||
66 | A: | ||
67 | added (not in HEAD, in index ) | ||
68 | .TP | ||
69 | M: | ||
70 | modified ( in HEAD, in index, different content ) | ||
71 | .TP | ||
72 | D: | ||
73 | deleted ( in HEAD, not in index ) | ||
74 | .TP | ||
75 | R: | ||
76 | renamed (not in HEAD, in index, path changed ) | ||
77 | .TP | ||
78 | C: | ||
79 | copied (not in HEAD, in index, copied from another) | ||
80 | .TP | ||
81 | T: | ||
82 | mode changed ( in HEAD, in index, same content ) | ||
83 | .TP | ||
84 | U: | ||
85 | unmerged; conflict resolution required | ||
86 | .PP | ||
87 | The second column explains how the working directory differs from the index. Its | ||
88 | values are always displayed in lower case and have the following meanings: | ||
89 | .TP | ||
90 | \-: | ||
91 | new / unknown (not in index, in work tree ) | ||
92 | .TP | ||
93 | m: | ||
94 | modified ( in index, in work tree, modified ) | ||
95 | .TP | ||
96 | d: | ||
97 | deleted ( in index, not in work tree ) | ||