{"thread":{"id":"59695","subject":"[PATCH 0/2] doc: revisions: fixes and cleanups","startedAt":"2023-05-04T16:34:29Z","lastAt":"2023-05-04T16:34:32Z","messageCount":3,"participants":["Felipe Contreras"],"isPatch":true,"patchVersion":1,"patchTotal":2},"messages":[{"id":"476599","messageId":"20230504163421.100400-1-felipe.contreras@gmail.com","threadId":"59695","inReplyTo":null,"subject":"[PATCH 0/2] doc: revisions: fixes and cleanups","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2023-05-04T16:34:19Z","receivedAt":"2023-05-04T16:34:29Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"I spotted a bunch of issues in revisions.txt, one bug, and many style\nissues.\n\nFelipe Contreras (2):\n  doc: revisions: fix missing escape\n  doc: revisions: add a bunch of missing quotes\n\n Documentation/revisions.txt | 36 ++++++++++++++++++------------------\n 1 file changed, 18 insertions(+), 18 deletions(-)\n\n-- \n2.40.0+fc1\n\n"},{"id":"476600","messageId":"20230504163421.100400-2-felipe.contreras@gmail.com","threadId":"59695","inReplyTo":"20230504163421.100400-1-felipe.contreras@gmail.com","subject":"[PATCH 1/2] doc: revisions: fix missing escape","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2023-05-04T16:34:20Z","receivedAt":"2023-05-04T16:34:31Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"In AsciiDoc `{foo}` is an attribute, if one doesn't want the attribute\nreplaced the left curly brace symbol has to be escaped.\n\nFor some reason asciidoc.py skips the whole line otherwise:\n\n  --- a/gitrevisions.7\n  +++ b/gitrevisions.7\n  @@ -112,8 +112,10 @@ SPECIFYING REVISIONS\n\n          [<branchname>]@{upstream}, e.g. master@{upstream}, @{u}\n              A branch B may be set up to build on top of a branch X (configured\n  -           with branch.<name>.merge) at a remote R (configured with the branch\n  -           X taken from remote R, typically found at refs/remotes/R/X.\n  +           with branch.<name>.merge) at a remote R (configured with\n  +           branch.<name>.remote). B@{u} refers to the remote-tracking branch\n  +           for the branch X taken from remote R, typically found at\n  +           refs/remotes/R/X.\n\n          [<branchname>]@{push}, e.g. master@{push}, @{push}\n              The suffix @{push} reports the branch \"where we would push to\" if\n\nSigned-off-by: Felipe Contreras <felipe.contreras@gmail.com>\n---\n Documentation/revisions.txt | 2 +-\n 1 file changed, 1 insertion(+), 1 deletion(-)\n\ndiff --git a/Documentation/revisions.txt b/Documentation/revisions.txt\nindex 9aa58052bc..af764de153 100644\n--- a/Documentation/revisions.txt\n+++ b/Documentation/revisions.txt\n@@ -99,7 +99,7 @@ some output processing may assume ref names in UTF-8.\n '[<branchname>]@\\{upstream\\}', e.g. 'master@\\{upstream\\}', '@\\{u\\}'::\n   A branch B may be set up to build on top of a branch X (configured with\n   `branch.<name>.merge`) at a remote R (configured with\n-  `branch.<name>.remote`). B@{u} refers to the remote-tracking branch for\n+  `branch.<name>.remote`). B@\\{u} refers to the remote-tracking branch for\n   the branch X taken from remote R, typically found at `refs/remotes/R/X`.\n \n '[<branchname>]@\\{push\\}', e.g. 'master@\\{push\\}', '@\\{push\\}'::\n-- \n2.40.0+fc1\n\n"},{"id":"476601","messageId":"20230504163421.100400-3-felipe.contreras@gmail.com","threadId":"59695","inReplyTo":"20230504163421.100400-1-felipe.contreras@gmail.com","subject":"[PATCH 2/2] doc: revisions: add a bunch of missing quotes","fromName":"Felipe Contreras","fromEmail":"felipe.contreras@gmail.com","sentAt":"2023-05-04T16:34:21Z","receivedAt":"2023-05-04T16:34:32Z","isPatch":true,"sender":{"key":"felipe.contreras@gmail.com","avatar":"https://avatars.githubusercontent.com/u/8358?v=4"},"body":"Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>\n---\n Documentation/revisions.txt | 36 ++++++++++++++++++------------------\n 1 file changed, 18 insertions(+), 18 deletions(-)\n\ndiff --git a/Documentation/revisions.txt b/Documentation/revisions.txt\nindex af764de153..bc1c6e5979 100644\n--- a/Documentation/revisions.txt\n+++ b/Documentation/revisions.txt\n@@ -97,10 +97,10 @@ some output processing may assume ref names in UTF-8.\n   before the current one.\n \n '[<branchname>]@\\{upstream\\}', e.g. 'master@\\{upstream\\}', '@\\{u\\}'::\n-  A branch B may be set up to build on top of a branch X (configured with\n-  `branch.<name>.merge`) at a remote R (configured with\n-  `branch.<name>.remote`). B@\\{u} refers to the remote-tracking branch for\n-  the branch X taken from remote R, typically found at `refs/remotes/R/X`.\n+  A branch 'B' may be set up to build on top of a branch 'X' (configured with\n+  `branch.<name>.merge`) at a remote 'R' (configured with\n+  `branch.<name>.remote`). 'B@\\{u}' refers to the remote-tracking branch for\n+  the branch 'X' taken from remote 'R', typically found at `refs/remotes/R/X`.\n \n '[<branchname>]@\\{push\\}', e.g. 'master@\\{push\\}', '@\\{push\\}'::\n   The suffix '@\\{push}' reports the branch \"where we would push to\" if\n@@ -129,7 +129,7 @@ from one location and push to another. In a non-triangular workflow,\n This suffix is also accepted when spelled in uppercase, and means the same\n thing no matter the case.\n \n-'<rev>{caret}[<n>]', e.g. 'HEAD{caret}, v1.5.1{caret}0'::\n+'<rev>{caret}[<n>]', e.g. 'HEAD{caret}', 'v1.5.1{caret}0'::\n   A suffix '{caret}' to a revision parameter means the first parent of\n   that commit object.  '{caret}<n>' means the <n>th parent (i.e.\n   '<rev>{caret}'\n@@ -137,7 +137,7 @@ thing no matter the case.\n   '<rev>{caret}0' means the commit itself and is used when '<rev>' is the\n   object name of a tag object that refers to a commit object.\n \n-'<rev>{tilde}[<n>]', e.g. 'HEAD{tilde}, master{tilde}3'::\n+'<rev>{tilde}[<n>]', e.g. 'HEAD{tilde}', 'master{tilde}3'::\n   A suffix '{tilde}' to a revision parameter means the first parent of\n   that commit object.\n   A suffix '{tilde}<n>' to a revision parameter means the commit\n@@ -278,8 +278,8 @@ The '..' (two-dot) Range Notation::\n  The '{caret}r1 r2' set operation appears so often that there is a shorthand\n  for it.  When you have two commits 'r1' and 'r2' (named according\n  to the syntax explained in SPECIFYING REVISIONS above), you can ask\n- for commits that are reachable from r2 excluding those that are reachable\n- from r1 by '{caret}r1 r2' and it can be written as 'r1..r2'.\n+ for commits that are reachable from 'r2' excluding those that are reachable\n+ from 'r1' by '{caret}r1 r2' and it can be written as 'r1..r2'.\n \n The '\\...' (three-dot) Symmetric Difference Notation::\n  A similar notation 'r1\\...r2' is called symmetric difference\n@@ -288,7 +288,7 @@ The '\\...' (three-dot) Symmetric Difference Notation::\n  It is the set of commits that are reachable from either one of\n  'r1' (left side) or 'r2' (right side) but not from both.\n \n-In these two shorthand notations, you can omit one end and let it default to HEAD.\n+In these two shorthand notations, you can omit one end and let it default to `HEAD`.\n For example, 'origin..' is a shorthand for 'origin..HEAD' and asks \"What\n did I do since I forked from the origin branch?\"  Similarly, '..origin'\n is a shorthand for 'HEAD..origin' and asks \"What did the origin do since\n@@ -340,22 +340,22 @@ Revision Range Summary\n ----------------------\n \n '<rev>'::\n-\tInclude commits that are reachable from <rev> (i.e. <rev> and its\n+\tInclude commits that are reachable from '<rev>' (i.e. '<rev>' and its\n \tancestors).\n \n '{caret}<rev>'::\n-\tExclude commits that are reachable from <rev> (i.e. <rev> and its\n+\tExclude commits that are reachable from '<rev>' (i.e. '<rev>' and its\n \tancestors).\n \n '<rev1>..<rev2>'::\n-\tInclude commits that are reachable from <rev2> but exclude\n-\tthose that are reachable from <rev1>.  When either <rev1> or\n-\t<rev2> is omitted, it defaults to `HEAD`.\n+\tInclude commits that are reachable from '<rev2>' but exclude\n+\tthose that are reachable from '<rev1>'.  When either '<rev1>' or\n+\t'<rev2>' is omitted, it defaults to `HEAD`.\n \n '<rev1>\\...<rev2>'::\n-\tInclude commits that are reachable from either <rev1> or\n-\t<rev2> but exclude those that are reachable from both.  When\n-\teither <rev1> or <rev2> is omitted, it defaults to `HEAD`.\n+\tInclude commits that are reachable from either '<rev1>' or\n+\t'<rev2>' but exclude those that are reachable from both.  When\n+\teither '<rev1>' or '<rev2>' is omitted, it defaults to `HEAD`.\n \n '<rev>{caret}@', e.g. 'HEAD{caret}@'::\n   A suffix '{caret}' followed by an at sign is the same as listing\n@@ -367,7 +367,7 @@ Revision Range Summary\n   as giving commit '<rev>' and all its parents prefixed with\n   '{caret}' to exclude them (and their ancestors).\n \n-'<rev>{caret}-<n>', e.g. 'HEAD{caret}-, HEAD{caret}-2'::\n+'<rev>{caret}-<n>', e.g. 'HEAD{caret}-', 'HEAD{caret}-2'::\n \tEquivalent to '<rev>{caret}<n>..<rev>', with '<n>' = 1 if not\n \tgiven.\n \n-- \n2.40.0+fc1\n\n"}]}