blob: db8723fb22009058a218effae8dbcb05eaa27b66 [file] [log] [blame]
Roger Shimizu0a1f5332021-06-20 21:41:05 +09001.\" DO NOT MODIFY THIS FILE! It was generated by help2man.
Mike Frysingerd47d9ff2022-07-10 05:15:19 -04002.TH REPO "1" "July 2022" "repo status" "Repo Manual"
Roger Shimizu0a1f5332021-06-20 21:41:05 +09003.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
Mike Frysingerdf8b1cb2021-07-26 15:59:20 -040018number of jobs to run in parallel (default: based on
19number of CPU cores)
Roger Shimizu0a1f5332021-06-20 21:41:05 +090020.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
Mike Frysingerd47d9ff2022-07-10 05:15:19 -040031.SS Multi\-manifest options:
32.TP
33\fB\-\-outer\-manifest\fR
34operate starting at the outermost manifest
35.TP
36\fB\-\-no\-outer\-manifest\fR
37do not operate on outer manifests
38.TP
39\fB\-\-this\-manifest\-only\fR
40only operate on this (sub)manifest
41.TP
42\fB\-\-no\-this\-manifest\-only\fR, \fB\-\-all\-manifests\fR
43operate on this manifest and its submanifests
Roger Shimizu0a1f5332021-06-20 21:41:05 +090044.PP
45Run `repo help status` to view the detailed manual.
46.SH DETAILS
47.PP
48\&'repo status' compares the working tree to the staging area (aka index), and the
49most recent commit on this branch (HEAD), in each project specified. A summary
50is displayed, one line per file where there is a difference between these three
51states.
52.PP
53The \fB\-j\fR/\-\-jobs option can be used to run multiple status queries in parallel.
54.PP
55The \fB\-o\fR/\-\-orphans option can be used to show objects that are in the working
56directory, but not associated with a repo project. This includes unmanaged
57top\-level files and directories, but also includes deeper items. For example, if
58dir/subdir/proj1 and dir/subdir/proj2 are repo projects, dir/subdir/proj3 will
59be shown if it is not known to repo.
60.PP
61Status Display
62.PP
63The status display is organized into three columns of information, for example
64if the file 'subcmds/status.py' is modified in the project 'repo' on branch
65\&'devwork':
66.TP
67project repo/
68branch devwork
69.TP
70\fB\-m\fR
71subcmds/status.py
72.PP
73The first column explains how the staging area (index) differs from the last
74commit (HEAD). Its values are always displayed in upper case and have the
75following meanings:
76.TP
77\-:
78no difference
79.TP
80A:
81added (not in HEAD, in index )
82.TP
83M:
84modified ( in HEAD, in index, different content )
85.TP
86D:
87deleted ( in HEAD, not in index )
88.TP
89R:
90renamed (not in HEAD, in index, path changed )
91.TP
92C:
93copied (not in HEAD, in index, copied from another)
94.TP
95T:
96mode changed ( in HEAD, in index, same content )
97.TP
98U:
99unmerged; conflict resolution required
100.PP
101The second column explains how the working directory differs from the index. Its
102values are always displayed in lower case and have the following meanings:
103.TP
104\-:
105new / unknown (not in index, in work tree )
106.TP
107m:
108modified ( in index, in work tree, modified )
109.TP
110d:
111deleted ( in index, not in work tree )