Git Mailing List Archive mirror
 help / color / mirror / Atom feed
* [PATCH 0/2] doc: revisions: fixes and cleanups
@ 2023-05-04 16:34 Felipe Contreras
  2023-05-04 16:34 ` [PATCH 1/2] doc: revisions: fix missing escape Felipe Contreras
  2023-05-04 16:34 ` [PATCH 2/2] doc: revisions: add a bunch of missing quotes Felipe Contreras
  0 siblings, 2 replies; 3+ messages in thread
From: Felipe Contreras @ 2023-05-04 16:34 UTC (permalink / raw)
  To: git; +Cc: Denton Liu, Jeff King, Felipe Contreras

I spotted a bunch of issues in revisions.txt, one bug, and many style
issues.

Felipe Contreras (2):
  doc: revisions: fix missing escape
  doc: revisions: add a bunch of missing quotes

 Documentation/revisions.txt | 36 ++++++++++++++++++------------------
 1 file changed, 18 insertions(+), 18 deletions(-)

-- 
2.40.0+fc1


^ permalink raw reply	[flat|nested] 3+ messages in thread

* [PATCH 1/2] doc: revisions: fix missing escape
  2023-05-04 16:34 [PATCH 0/2] doc: revisions: fixes and cleanups Felipe Contreras
@ 2023-05-04 16:34 ` Felipe Contreras
  2023-05-04 16:34 ` [PATCH 2/2] doc: revisions: add a bunch of missing quotes Felipe Contreras
  1 sibling, 0 replies; 3+ messages in thread
From: Felipe Contreras @ 2023-05-04 16:34 UTC (permalink / raw)
  To: git; +Cc: Denton Liu, Jeff King, Felipe Contreras

In AsciiDoc `{foo}` is an attribute, if one doesn't want the attribute
replaced the left curly brace symbol has to be escaped.

For some reason asciidoc.py skips the whole line otherwise:

  --- a/gitrevisions.7
  +++ b/gitrevisions.7
  @@ -112,8 +112,10 @@ SPECIFYING REVISIONS

          [<branchname>]@{upstream}, e.g. master@{upstream}, @{u}
              A branch B may be set up to build on top of a branch X (configured
  -           with branch.<name>.merge) at a remote R (configured with the branch
  -           X taken from remote R, typically found at refs/remotes/R/X.
  +           with branch.<name>.merge) at a remote R (configured with
  +           branch.<name>.remote). B@{u} refers to the remote-tracking branch
  +           for the branch X taken from remote R, typically found at
  +           refs/remotes/R/X.

          [<branchname>]@{push}, e.g. master@{push}, @{push}
              The suffix @{push} reports the branch "where we would push to" if

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/revisions.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index 9aa58052bc..af764de153 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -99,7 +99,7 @@ some output processing may assume ref names in UTF-8.
 '[<branchname>]@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
   A branch B may be set up to build on top of a branch X (configured with
   `branch.<name>.merge`) at a remote R (configured with
-  `branch.<name>.remote`). B@{u} refers to the remote-tracking branch for
+  `branch.<name>.remote`). B@\{u} refers to the remote-tracking branch for
   the branch X taken from remote R, typically found at `refs/remotes/R/X`.
 
 '[<branchname>]@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
-- 
2.40.0+fc1


^ permalink raw reply related	[flat|nested] 3+ messages in thread

* [PATCH 2/2] doc: revisions: add a bunch of missing quotes
  2023-05-04 16:34 [PATCH 0/2] doc: revisions: fixes and cleanups Felipe Contreras
  2023-05-04 16:34 ` [PATCH 1/2] doc: revisions: fix missing escape Felipe Contreras
@ 2023-05-04 16:34 ` Felipe Contreras
  1 sibling, 0 replies; 3+ messages in thread
From: Felipe Contreras @ 2023-05-04 16:34 UTC (permalink / raw)
  To: git; +Cc: Denton Liu, Jeff King, Felipe Contreras

Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
---
 Documentation/revisions.txt | 36 ++++++++++++++++++------------------
 1 file changed, 18 insertions(+), 18 deletions(-)

diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index af764de153..bc1c6e5979 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -97,10 +97,10 @@ some output processing may assume ref names in UTF-8.
   before the current one.
 
 '[<branchname>]@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
-  A branch B may be set up to build on top of a branch X (configured with
-  `branch.<name>.merge`) at a remote R (configured with
-  `branch.<name>.remote`). B@\{u} refers to the remote-tracking branch for
-  the branch X taken from remote R, typically found at `refs/remotes/R/X`.
+  A branch 'B' may be set up to build on top of a branch 'X' (configured with
+  `branch.<name>.merge`) at a remote 'R' (configured with
+  `branch.<name>.remote`). 'B@\{u}' refers to the remote-tracking branch for
+  the branch 'X' taken from remote 'R', typically found at `refs/remotes/R/X`.
 
 '[<branchname>]@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
   The suffix '@\{push}' reports the branch "where we would push to" if
@@ -129,7 +129,7 @@ from one location and push to another. In a non-triangular workflow,
 This suffix is also accepted when spelled in uppercase, and means the same
 thing no matter the case.
 
-'<rev>{caret}[<n>]', e.g. 'HEAD{caret}, v1.5.1{caret}0'::
+'<rev>{caret}[<n>]', e.g. 'HEAD{caret}', 'v1.5.1{caret}0'::
   A suffix '{caret}' to a revision parameter means the first parent of
   that commit object.  '{caret}<n>' means the <n>th parent (i.e.
   '<rev>{caret}'
@@ -137,7 +137,7 @@ thing no matter the case.
   '<rev>{caret}0' means the commit itself and is used when '<rev>' is the
   object name of a tag object that refers to a commit object.
 
-'<rev>{tilde}[<n>]', e.g. 'HEAD{tilde}, master{tilde}3'::
+'<rev>{tilde}[<n>]', e.g. 'HEAD{tilde}', 'master{tilde}3'::
   A suffix '{tilde}' to a revision parameter means the first parent of
   that commit object.
   A suffix '{tilde}<n>' to a revision parameter means the commit
@@ -278,8 +278,8 @@ The '..' (two-dot) Range Notation::
  The '{caret}r1 r2' set operation appears so often that there is a shorthand
  for it.  When you have two commits 'r1' and 'r2' (named according
  to the syntax explained in SPECIFYING REVISIONS above), you can ask
- for commits that are reachable from r2 excluding those that are reachable
- from r1 by '{caret}r1 r2' and it can be written as 'r1..r2'.
+ for commits that are reachable from 'r2' excluding those that are reachable
+ from 'r1' by '{caret}r1 r2' and it can be written as 'r1..r2'.
 
 The '\...' (three-dot) Symmetric Difference Notation::
  A similar notation 'r1\...r2' is called symmetric difference
@@ -288,7 +288,7 @@ The '\...' (three-dot) Symmetric Difference Notation::
  It is the set of commits that are reachable from either one of
  'r1' (left side) or 'r2' (right side) but not from both.
 
-In these two shorthand notations, you can omit one end and let it default to HEAD.
+In these two shorthand notations, you can omit one end and let it default to `HEAD`.
 For example, 'origin..' is a shorthand for 'origin..HEAD' and asks "What
 did I do since I forked from the origin branch?"  Similarly, '..origin'
 is a shorthand for 'HEAD..origin' and asks "What did the origin do since
@@ -340,22 +340,22 @@ Revision Range Summary
 ----------------------
 
 '<rev>'::
-	Include commits that are reachable from <rev> (i.e. <rev> and its
+	Include commits that are reachable from '<rev>' (i.e. '<rev>' and its
 	ancestors).
 
 '{caret}<rev>'::
-	Exclude commits that are reachable from <rev> (i.e. <rev> and its
+	Exclude commits that are reachable from '<rev>' (i.e. '<rev>' and its
 	ancestors).
 
 '<rev1>..<rev2>'::
-	Include commits that are reachable from <rev2> but exclude
-	those that are reachable from <rev1>.  When either <rev1> or
-	<rev2> is omitted, it defaults to `HEAD`.
+	Include commits that are reachable from '<rev2>' but exclude
+	those that are reachable from '<rev1>'.  When either '<rev1>' or
+	'<rev2>' is omitted, it defaults to `HEAD`.
 
 '<rev1>\...<rev2>'::
-	Include commits that are reachable from either <rev1> or
-	<rev2> but exclude those that are reachable from both.  When
-	either <rev1> or <rev2> is omitted, it defaults to `HEAD`.
+	Include commits that are reachable from either '<rev1>' or
+	'<rev2>' but exclude those that are reachable from both.  When
+	either '<rev1>' or '<rev2>' is omitted, it defaults to `HEAD`.
 
 '<rev>{caret}@', e.g. 'HEAD{caret}@'::
   A suffix '{caret}' followed by an at sign is the same as listing
@@ -367,7 +367,7 @@ Revision Range Summary
   as giving commit '<rev>' and all its parents prefixed with
   '{caret}' to exclude them (and their ancestors).
 
-'<rev>{caret}-<n>', e.g. 'HEAD{caret}-, HEAD{caret}-2'::
+'<rev>{caret}-<n>', e.g. 'HEAD{caret}-', 'HEAD{caret}-2'::
 	Equivalent to '<rev>{caret}<n>..<rev>', with '<n>' = 1 if not
 	given.
 
-- 
2.40.0+fc1


^ permalink raw reply related	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2023-05-04 16:34 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-05-04 16:34 [PATCH 0/2] doc: revisions: fixes and cleanups Felipe Contreras
2023-05-04 16:34 ` [PATCH 1/2] doc: revisions: fix missing escape Felipe Contreras
2023-05-04 16:34 ` [PATCH 2/2] doc: revisions: add a bunch of missing quotes Felipe Contreras

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).