summaryrefslogtreecommitdiffstats
path: root/man/repo-status.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/repo-status.1')
-rw-r--r--man/repo-status.198
1 files changed, 98 insertions, 0 deletions
diff --git a/man/repo-status.1 b/man/repo-status.1
new file mode 100644
index 00000000..fbae2c5d
--- /dev/null
+++ b/man/repo-status.1
@@ -0,0 +1,98 @@
1.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
2.TH REPO "1" "July 2021" "repo status" "Repo Manual"
3.SH NAME
4repo \- repo status - manual page for repo status
5.SH SYNOPSIS
6.B repo
7\fI\,status \/\fR[\fI\,<project>\/\fR...]
8.SH DESCRIPTION
9Summary
10.PP
11Show the working tree status
12.SH OPTIONS
13.TP
14\fB\-h\fR, \fB\-\-help\fR
15show this help message and exit
16.TP
17\fB\-j\fR JOBS, \fB\-\-jobs\fR=\fI\,JOBS\/\fR
18number of jobs to run in parallel (default: based on
19number of CPU cores)
20.TP
21\fB\-o\fR, \fB\-\-orphans\fR
22include objects in working directory outside of repo
23projects
24.SS Logging options:
25.TP
26\fB\-v\fR, \fB\-\-verbose\fR
27show all output
28.TP
29\fB\-q\fR, \fB\-\-quiet\fR
30only show errors
31.PP
32Run `repo help status` to view the detailed manual.
33.SH DETAILS
34.PP
35\&'repo status' compares the working tree to the staging area (aka index), and the
36most recent commit on this branch (HEAD), in each project specified. A summary
37is displayed, one line per file where there is a difference between these three
38states.
39.PP
40The \fB\-j\fR/\-\-jobs option can be used to run multiple status queries in parallel.
41.PP
42The \fB\-o\fR/\-\-orphans option can be used to show objects that are in the working
43directory, but not associated with a repo project. This includes unmanaged
44top\-level files and directories, but also includes deeper items. For example, if
45dir/subdir/proj1 and dir/subdir/proj2 are repo projects, dir/subdir/proj3 will
46be shown if it is not known to repo.
47.PP
48Status Display
49.PP
50The status display is organized into three columns of information, for example
51if the file 'subcmds/status.py' is modified in the project 'repo' on branch
52\&'devwork':
53.TP
54project repo/
55branch devwork
56.TP
57\fB\-m\fR
58subcmds/status.py
59.PP
60The first column explains how the staging area (index) differs from the last
61commit (HEAD). Its values are always displayed in upper case and have the
62following meanings:
63.TP
64\-:
65no difference
66.TP
67A:
68added (not in HEAD, in index )
69.TP
70M:
71modified ( in HEAD, in index, different content )
72.TP
73D:
74deleted ( in HEAD, not in index )
75.TP
76R:
77renamed (not in HEAD, in index, path changed )
78.TP
79C:
80copied (not in HEAD, in index, copied from another)
81.TP
82T:
83mode changed ( in HEAD, in index, same content )
84.TP
85U:
86unmerged; conflict resolution required
87.PP
88The second column explains how the working directory differs from the index. Its
89values are always displayed in lower case and have the following meanings:
90.TP
91\-:
92new / unknown (not in index, in work tree )
93.TP
94m:
95modified ( in index, in work tree, modified )
96.TP
97d:
98deleted ( in index, not in work tree )