{"thread":{"id":"8131","subject":"[StGIT PATCH v3] Document patch syntax.","startedAt":"2007-05-13T14:11:54Z","lastAt":"2007-05-13T14:11:54Z","messageCount":1,"participants":["Yann Dirson"],"isPatch":true,"patchVersion":3,"patchTotal":null},"messages":[{"id":"42024","messageId":"20070513141144.20793.96515.stgit@gandelf.nowhere.earth","threadId":"8131","inReplyTo":null,"subject":"[StGIT PATCH v3] Document patch syntax.","fromName":"Yann Dirson","fromEmail":"ydirson@altern.org","sentAt":"2007-05-13T14:11:54Z","receivedAt":"2007-05-13T14:11:54Z","isPatch":true,"sender":{"key":"ydirson@altern.org","avatar":"https://avatars.githubusercontent.com/u/1190950?v=4"},"body":"\nAcked-by: Karl Hasselström <kha@treskal.com>\n\nSigned-off-by: Yann Dirson <ydirson@altern.org>\n---\n\n Documentation/stg.txt |   25 +++++++++++++++++++++++++\n 1 files changed, 25 insertions(+), 0 deletions(-)\n\ndiff --git a/Documentation/stg.txt b/Documentation/stg.txt\nindex af57c37..4f9d18e 100644\n--- a/Documentation/stg.txt\n+++ b/Documentation/stg.txt\n@@ -51,6 +51,31 @@ Development branch::\n In such a setup, not all commits on your branch need to be StGIT\n patches; there may be regular GIT commits below your stack base.\n \n+Patches\n+~~~~~~~\n+\n+Many StGIT commands take references to StGIT patches as arguments.\n+Patches in the stack are identified with short names, each of which\n+must be unique in the stack.\n+\n+Patches in the current stack are just referred to by their name.  Some\n+commands allow you to specify a patch in another stack of the repository;\n+this is done by suffixing the patch name with an '@' sign followed by the\n+branch name (eg. 'thispatch@otherbranch').\n+\n+A number of positions in the stack related to the patch are also\n+accessible through '//' suffixes.  For example, 'patch//top' is\n+equivalent to 'patch', and 'patch//bottom' refers to the commit below\n+'patch' (i.e. the patch below, or the stack base if this is the\n+bottom-most patch).  Similarly '//top.old' and '//bottom.old'\n+refer to the previous version of the patch (before the last\n+stglink:push[] or stglink:refresh[] operation).  When referring to the\n+current patch, its name can be omitted (eg. 'currentpatch//bottom.old'\n+can be abbreviated as 'bottom.old').\n+\n+If you need to pass a given StGIT reference to a git command,\n+stglink:id[] will convert it to a git commit id.\n+\n OPTIONS\n -------\n \n"}]}