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