aboutsummaryrefslogtreecommitdiffstats
path: root/doc/git-todo.1.txt
diff options
context:
space:
mode:
authorTeddy Wing2020-10-03 17:08:57 +0200
committerTeddy Wing2020-10-03 17:08:57 +0200
commitfc94501bd6aa696de449321aa41770bc96a4bb34 (patch)
tree18cc96b0112124fe82b28a8d2fe808250d2b59c4 /doc/git-todo.1.txt
parentbea8ea75c62c2f7c6959f12e1af652aa324827a9 (diff)
downloadgit-todo-fc94501bd6aa696de449321aa41770bc96a4bb34.tar.bz2
Add man page
Copied some of the structure and the Makefile recipe from 'git-suggestion'.
Diffstat (limited to 'doc/git-todo.1.txt')
-rw-r--r--doc/git-todo.1.txt31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/git-todo.1.txt b/doc/git-todo.1.txt
new file mode 100644
index 0000000..61f8627
--- /dev/null
+++ b/doc/git-todo.1.txt
@@ -0,0 +1,31 @@
+git-todo(1)
+===========
+
+NAME
+----
+git-todo - Output recent TODO lines
+
+SYNOPSIS
+--------
+'git todo' [options] [<ref>]
+
+DESCRIPTION
+-----------
+Find TODO lines and output them in a grep-style format including the name
+of the file containing them and their line number.
+
+By default, outputs all TODO lines since `master`.
+
+OPTIONS
+-------
+-h, --help::
+ Print usage help.
+
+-V, --version::
+ Print the program version.
+
+EXAMPLES
+--------
+Show TODOs since the `v1.0.0` tag:
+
+ $ git todo v1.0.0