diff options
Diffstat (limited to 'git-precheck.1')
| -rw-r--r-- | git-precheck.1 | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/git-precheck.1 b/git-precheck.1 new file mode 100644 index 0000000..e0861b2 --- /dev/null +++ b/git-precheck.1 @@ -0,0 +1,67 @@ +.TH GIT\-PRECHECK 1 git\-sonar + +.SH NAME +git\-precheck \- detect "unready" state of a git repository + +.SH SYNOPSIS +.B git\-precheck +.RB [ \-\-quiet ] +.RB [ \-\-ignore\-dirty ] +.RB [ \-\-ignore\-untracked ] + +.SH DESCRIPTION +If +.B git\-precheck +is run inside a git repository, it examines the repo for any in\-progress git +operations or unclean state and returns an exit code indicating the status. +Otherwise, +.B git\-precheck +reports that it is not in any git worktree. +.P +If +.B \-\-quiet +is not given, a line of text is printed describing each condition found. + +.SH OPTIONS +.TP +.B \-\-quiet +Don't actually print anything. +.TP +.B \-\-ignore\-dirty +Don't consider the presence of uncommitted changes to tracked files as an +unclean state. +.TP +.B \-\-ignore\-untracked +Don't consider the presence of untracked files as an unclean state. + +.SH EXIT STATUS +.TP +.B 0 +If inside a repository and all checks return normal +.TP +.B 1 +If untracked files are detected +.TP +.B 2 +If dirty/modified files are detected +.TP +.B 3 +If any ongoing git operation is in progress +.TP +.B 4 +If not inside a git repository +.P +.B git\-precheck +will exit with any other value if an error occurs. + +.SH SEE ALSO +.BR git\-sonar (1), +.BR git\-status (1) + +.SH LICENSE +.B git\-precheck +is part of the +.B git\-sonar +project, made available under the terms of the +.B MIT +license. |