Documentation/stg-new.txt

   1 stg-new(1)
   2 ==========
   3 Yann Dirson <ydirson@altern.org>
   4 v0.12.1, February 2007
   5
   6 NAME
   7 ----
   8 stg-new - stgdesc:new[]
   9
  10 SYNOPSIS
  11 --------
  12 stg new [OPTIONS] <name>
  13
  14 DESCRIPTION
  15 -----------
  16
  17 Create a new, empty patch with the given <name> on the current stack.
  18 The new patch is created on top of the currently applied patches, and
  19 is made the new top of the stack.  The local changes in the working
  20 tree are not included in the patch. A stglink:refresh[] command is
  21 needed for this.
  22
  23 An editor will be launched to edit the commit message to be used for
  24 the patch, unless the '--message' flag already specified one.  The
  25 'patchdescr.tmpl' template file is used if available to pre-fill the
  26 editor.  The editor to use is taken from the first of the following
  27 sources of information, and defaults to 'vi':
  28
  29 . the 'stgit.editor' GIT configuration variable
  30 . the 'EDITOR' environment variable
  31
  32 The message and other GIT commit attributes can be modified later
  33 using stglink:refresh[].
  34
  35 AUTHOR AND COMMITTER INFORMATION
  36 --------------------------------
  37
  38 The author name (resp. email) to record in the StGIT patch is taken
  39 from the first of the following sources for the information:
  40
  41 . the '--authname' (resp. '--authemail') or '--author' flag on command-line
  42 . the 'GIT_AUTHOR_NAME' (resp. 'GIT_AUTHOR_EMAIL') environment variable
  43 . the 'user.name' (resp. 'user.email') GIT configuration variable
  44
  45 Similarly, the committer name (resp. email) is taken from the first of
  46 the following sources:
  47
  48 . the '--commname' (resp. '--commemail') flag on command-line
  49 . the 'GIT_COMMITTER_NAME' (resp. 'GIT_COMMITTER_EMAIL') environment variable
  50 . the 'user.name' (resp. 'user.email') GIT configuration variable
  51
  52 The GIT commit generated by stglink:refresh[] will use these
  53 informations when available.  If one of them is not available, GIT
  54 will pick the value from your machine's configuration at that time, as
  55 described in gitlink:git-commit-tree[1].
  56
  57 OPTIONS
  58 -------
  59
  60 <name>::
  61         The short name that will be used as to identify the patch in
  62         other StGIT commands.  Must be unique in the stack.  May only
  63         contain alphanumeric characters, dashes and underscores.
  64
  65 --message=<message>::
  66 -m <message>::
  67         Use <message> as the patch description.
  68
  69 --showpatch::
  70 -s::
  71         Show the patch content in the editor buffer.  This flag does
  72         nothing if '-m' is also specified.
  73
  74 --author="Name <email@company>"::
  75 -a "Name <email@company>"::
  76         Use "Name <email@company>" as the author details.  This form
  77         sets both 'authname' and 'authemail'.
  78
  79 --authname=<name>::
  80         Use <name> as the author name
  81 --authemail=<email>::
  82         Use <email> as the author e-mail
  83 --authdate=<date>::
  84         Use <date> as the author date
  85
  86 --commname=<name>::
  87         Use <name> as the committer name
  88 --commemail=<email>::
  89         Use <email> as the committer e-mail
  90
  91 FILES
  92 -----
  93
  94         <templates>/patchdescr.tmpl
  95
  96 ENVIRONMENT VARIABLES
  97 ---------------------
  98
  99         GIT_AUTHOR_NAME
 100         GIT_AUTHOR_EMAIL
 101         GIT_AUTHOR_DATE
 102         GIT_COMMITTER_NAME
 103         GIT_COMMITTER_EMAIL
 104         EDITOR
 105
 106 GIT CONFIGURATION VARIABLES
 107 ---------------------------
 108
 109         user.name
 110         user.email
 111         stgit.editor
 112
 113 StGIT
 114 -----
 115 Part of the StGIT suite - see gitlink:stg[7].