From fc94501bd6aa696de449321aa41770bc96a4bb34 Mon Sep 17 00:00:00 2001 From: Teddy Wing Date: Sat, 3 Oct 2020 17:08:57 +0200 Subject: Add man page Copied some of the structure and the Makefile recipe from 'git-suggestion'. --- doc/git-todo.1.txt | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 doc/git-todo.1.txt (limited to 'doc/git-todo.1.txt') 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] [] + +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 -- cgit v1.2.3