diff options
| author | Teddy Wing | 2019-06-10 12:23:33 +0200 |
|---|---|---|
| committer | Teddy Wing | 2019-06-10 12:23:33 +0200 |
| commit | 5b6e2772733e9d30b60a4550482cbca56f87117d (patch) | |
| tree | 7ae34812a11f321a4c466bf5a47a8bf061bcc71a /doc/code-review.1 | |
| parent | 6bbcbe9b067175a50c907510c345e8416acbb39d (diff) | |
| download | code-review-5b6e2772733e9d30b60a4550482cbca56f87117d.tar.bz2 | |
Add a man page
Not very detailed at the moment, just copies the usage output. Would be
nice to make this more descriptive, and even better to have separate man
pages for each subcommand.
Diffstat (limited to 'doc/code-review.1')
| -rw-r--r-- | doc/code-review.1 | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/code-review.1 b/doc/code-review.1 new file mode 100644 index 0000000..e671bff --- /dev/null +++ b/doc/code-review.1 @@ -0,0 +1,74 @@ +'\" t +.\" Title: code-review +.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 06/10/2019 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "CODE\-REVIEW" "1" "06/10/2019" "\ \&" "\ \&" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +code-review \- Tools for code review +.SH "SYNOPSIS" +.sp +\fBcode\-review\fR [\-\-help] <command> [<args>] +.SH "DESCRIPTION" +.sp +A collection of tools that facilitate code review on the command line\&. +.SH "OPTIONS" +.PP +\-h, \-\-help +.RS 4 +Print usage help\&. +.RE +.SH "COMMANDS" +.PP +changed\-files +.RS 4 +List names of files changed +.RE +.PP +commits +.RS 4 +One\-line log of commits +.RE +.PP +diff +.RS 4 +Unified diff of changes +.RE +.PP +difftool +.RS 4 +Diff of all changes with Vim and Fugitive +.RE +.PP +start +.RS 4 +Start a review with a given base revision +.RE +.PP +stat +.RS 4 +Stat file changes +.RE |