Skip to contentSkip to conversation

git-merge-tree.txt: replace spurious HTML entity

PATCH In review Andreas Schwab 3 participants 3 messages Mar 4, 2023 – Mar 5, 2023 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 git-merge-tree.txt: replace spurious HTML entity

---
 Documentation/git-merge-tree.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-merge-tree.txt +1 -1
index 88ee942101..ffc4fbf7e8 100644
@@ -108,7 +108,7 @@ This is an integer status followed by a NUL character.  The integer status is:
 
      0: merge had conflicts
      1: merge was clean
-     <0: something prevented the merge from running (e.g. access to repository
+     <0: something prevented the merge from running (e.g. access to repository
 	 objects denied by filesystem)
 
 [[OIDTLT]]
Signature · 7 lines
2.39.1


-- 
Andreas Schwab, [email protected]
GPG Key fingerprint = 7578 EB47 D4E5 4D69 2510  2552 DF73 E780 A9DA AEC1
"And now for something completely different."
#1 lore raw
Quoted 11 lines · Andreas Schwab
---
 Documentation/git-merge-tree.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-merge-tree.txt +0 -0
index 88ee942101..ffc4fbf7e8 100644

Documentation/git-merge-tree.txt This is an integer status followed by a NUL character. The integer status is: · line 112

Quoted 6 lines
Documentation/git-merge-tree.txt +1 -1
@@ -108,7 +108,7 @@ This is an integer status followed by a NUL character.  The integer status is:
 
      0: merge had conflicts
      1: merge was clean
-     &lt;0: something prevented the merge from running (e.g. access to repository
+     <0: something prevented the merge from running (e.g. access to repository
         objects denied by filesystem)

I'm sure I'm the one who put it there, but I don't remember any details. I think it unlikely I would have jumped to '&lt;' without trying '<' and hitting an error first, though maybe I really did. Also, there could have been other edits since then; perhaps this was only needed when other characters appeared later on the line? Or maybe the '&lt;' is only needed by asciidoc and not asciidoctor (or vice versa; I have no clue which I was using)? Should we add a "lessthan" field in Documentation/asciidoc.conf under "[attributes]" and use "{lessthan}"?

Or, if this one really is spurious, should the same html entity in Documentation/git-rev-list.txt be expunged as well?

Cc'ing brian who knows way more about asciidoc than I...

#2 lore raw
Quoted 14 lines · Elijah Newren
Quoted 12 lines · Andreas Schwab
---
 Documentation/git-merge-tree.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/git-merge-tree.txt +0 -0
index 88ee942101..ffc4fbf7e8 100644
@@ -108,7 +108,7 @@ This is an integer status followed by a NUL character.  The integer status is:
 
Quoted 15 lines

Documentation/git-merge-tree.txt This is an integer status followed by a NUL character. The integer status is: · line 112

Quoted 5 lines
Documentation/git-merge-tree.txt +1 -1
      0: merge had conflicts
      1: merge was clean
-     &lt;0: something prevented the merge from running (e.g. access to repository
+     <0: something prevented the merge from running (e.g. access to repository
         objects denied by filesystem)

I'm sure I'm the one who put it there, but I don't remember any details. I think it unlikely I would have jumped to '&lt;' without trying '<' and hitting an error first, though maybe I really did. Also, there could have been other edits since then; perhaps this was only needed when other characters appeared later on the line? Or maybe the '&lt;' is only needed by asciidoc and not asciidoctor (or vice versa; I have no clue which I was using)? Should we add a "lessthan" field in Documentation/asciidoc.conf under "[attributes]" and use "{lessthan}"?

For what it's worth I checked with both asciidoc and asciidoctor in multiple output formats and < works fine. I even checked an ancient version of asciidoc and it works fine.

It doesn't seem like &lt; was ever needed, and it doesn't work because it's a literal section.

Quoted 2 lines

Or, if this one really is spurious, should the same html entity in Documentation/git-rev-list.txt be expunged as well?

<= is automatically replaced with ⇐ as explained in the documentation [1]. However, to prevent substitutions one doesn't need HTML coding, just doing \<= is enough.

I don't know why people try to guess what asciidoc and asciidoctor should do, they both follow the same specification, and I haven't seen a problem in git documentation caused by either one of them not following the spec, only by git not following the spec.

Just follow the spec.

Cheers.

[1] https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/

Signature · 1 line
Felipe Contreras