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