diff options
| -rw-r--r-- | Makefile | 5 | ||||
| -rw-r--r-- | doc/code-review.1 | 74 | ||||
| -rw-r--r-- | doc/code-review.1.txt | 34 |
3 files changed, 113 insertions, 0 deletions
diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..78d4de9 --- /dev/null +++ b/Makefile @@ -0,0 +1,5 @@ +.PHONY: doc +doc: doc/code-review.1 + +doc/code-review.1: doc/code-review.1.txt + a2x --no-xmllint --format manpage $< 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 diff --git a/doc/code-review.1.txt b/doc/code-review.1.txt new file mode 100644 index 0000000..276399f --- /dev/null +++ b/doc/code-review.1.txt @@ -0,0 +1,34 @@ +code-review(1) +============== + +NAME +---- +code-review - Tools for code review + +SYNOPSIS +-------- +*code-review* [--help] <command> [<args>] + +DESCRIPTION +----------- +A collection of tools that facilitate code review on the command line. + +OPTIONS +------- +-h, --help:: + Print usage help. + +COMMANDS +-------- +changed-files:: + List names of files changed +commits:: + One-line log of commits +diff:: + Unified diff of changes +difftool:: + Diff of all changes with Vim and Fugitive +start:: + Start a review with a given base revision +stat:: + Stat file changes |