Documentation/guilt.txt

   1 guilt(7)
   2 ========
   3
   4 NAME
   5 ----
   6 guilt - quilt on top of git
   7
   8 SYNOPSIS
   9 --------
  10 'guilt' COMMAND [ARGS]
  11
  12 DESCRIPTION
  13 -----------
  14
  15 Andrew Morton originally developed a set of scripts for maintaining kernel
  16 patches outside of any SCM tool. Others extended these into a suite called
  17 quilt. The basic idea behind quilt is to maintain patches instead of
  18 maintaining source files. Patches can be added, removed or reordered, and
  19 they can be refreshed as you fix bugs or update to a new base revision.
  20 quilt is very powerful, but it is not integrated with the underlying SCM
  21 tools. This makes it difficult to visualize your changes.
  22
  23 Guilt allows one to use quilt functionality on top of a Git repository.
  24 Changes are maintained as patches which are committed into Git.  Commits can
  25 be removed or reordered, and the underlying patch can be refreshed based on
  26 changes made in the working directory. The patch directory can also be
  27 placed under revision control, so you can have a separate history of changes
  28 made to your patches.
  29
  30 PATCHES DIRECTORY
  31 -----------------
  32
  33 In Guilt, all the patches are stored in .git/patches/$branch/, where $branch
  34 is the name of the branch being worked on. This means that one can have a
  35 independent series of patches for each branch present in the repository.
  36 Each of these per-branch directories contains 3 special files:
  37
  38 guards: This file contains any guards that should be applied to the
  39 series when pushing. It is only present when guards are selected.
  40
  41 series: This file contains a list of all the patch filenames relative to the
  42 per-branch patch directory. Empty and commented out lines are ignored.
  43
  44 status: This file contains the state of the stack. What patches are applied.
  45
  46 HOOKS
  47 -----
  48 Any guilt operation may execute zero or more hook scripts which can be used
  49 to run any housekeeping commands or even abort the execution of the command.
  50
  51 include::hooks.txt[]
  52
  53 GUILT COMMANDS
  54 --------------
  55 All commands must be called without a dash. e.g. 'guilt add'
  56
  57 include::cmds.txt[]
  58
  59 Author
  60 ------
  61 Written by Josef "Jeff" Sipek <jeffpc@josefsipek.net>
  62
  63 Documentation
  64 --------------
  65 Documentation by Brandon Philips <brandon@ifup.org> and Josef "Jeff" Sipek
  66 <jeffpc@josefsipek.net>
  67
  68 include::footer.txt[]