docs: handle `git describe` failing
[guilt.git] / Documentation / guilt-init.txt
bloba857520b50c32d1014a72ad28b7c8f04839f7a83
1 guilt-init(1)
2 =============
4 NAME
5 ----
6 guilt-init - Initialize guilt for use in a git repository
8 SYNOPSIS
9 --------
10 include::usage-guilt-init.txt[]
12 DESCRIPTION
13 -----------
14 Initialize a git repository for use with guilt
16 OPTIONS
17 -------
18 -a::
19         Automatically create stack top, bottom, and base tags (sets
20         guilt.autotag config variable to 1). This is the default in most
21         cases. For more details about autotagging default option handling,
22         see guilt(7).
24 -n::
25         Do not automatically create stack top, bottom, and base tags (sets
26         guilt.autotag config variable to 0).
28 EXAMPLES
29 --------
30 First, get a repository to work on. Here's one that we'll use as an example:
32 $ git-clone git://git.kernel.org/pub/scm/linux/kernel/jsipek/guilt-hello.git
34 Now, it initialize the patches directory using guilt's init command:
36 $ cd hello
38 $ guilt-init
40 Author
41 ------
42 Written by Josef "Jeff" Sipek <jeffpc@josefsipek.net>
44 Documentation
45 -------------
46 Documentation by Brandon Philips <brandon@ifup.org>
48 include::footer.txt[]