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.197
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
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: 4)
19.TP
20\fB\-o\fR, \fB\-\-orphans\fR
21include objects in working directory outside of repo
22projects
23.SS Logging options:
24.TP
25\fB\-v\fR, \fB\-\-verbose\fR
26show all output
27.TP
28\fB\-q\fR, \fB\-\-quiet\fR
29only show errors
30.PP
31Run `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
35most recent commit on this branch (HEAD), in each project specified. A summary
36is displayed, one line per file where there is a difference between these three
37states.
38.PP
39The \fB\-j\fR/\-\-jobs option can be used to run multiple status queries in parallel.
40.PP
41The \fB\-o\fR/\-\-orphans option can be used to show objects that are in the working
42directory, but not associated with a repo project. This includes unmanaged
43top\-level files and directories, but also includes deeper items. For example, if
44dir/subdir/proj1 and dir/subdir/proj2 are repo projects, dir/subdir/proj3 will
45be shown if it is not known to repo.
46.PP
47Status Display
48.PP
49The status display is organized into three columns of information, for example
50if the file 'subcmds/status.py' is modified in the project 'repo' on branch
51\&'devwork':
52.TP
53project repo/
54branch devwork
55.TP
56\fB\-m\fR
57subcmds/status.py
58.PP
59The first column explains how the staging area (index) differs from the last
60commit (HEAD). Its values are always displayed in upper case and have the
61following meanings:
62.TP
63\-:
64no difference
65.TP
66A:
67added (not in HEAD, in index )
68.TP
69M:
70modified ( in HEAD, in index, different content )
71.TP
72D:
73deleted ( in HEAD, not in index )
74.TP
75R:
76renamed (not in HEAD, in index, path changed )
77.TP
78C:
79copied (not in HEAD, in index, copied from another)
80.TP
81T:
82mode changed ( in HEAD, in index, same content )
83.TP
84U:
85unmerged; conflict resolution required
86.PP
87The second column explains how the working directory differs from the index. Its
88values are always displayed in lower case and have the following meanings:
89.TP
90\-:
91new / unknown (not in index, in work tree )
92.TP
93m:
94modified ( in index, in work tree, modified )
95.TP
96d:
97deleted ( in index, not in work tree )