Skip to contentSkip to conversation

gitworkflows.txt: fix broken subsection underline

PATCH In review Martin Ågren 3 participants 3 messages Jul 18, 2020 – Aug 10, 2020 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 gitworkflows.txt: fix broken subsection underline

AsciiDoctor renders the "~~~~~~~~~" literally. That's not our intention:
it is supposed to indicate a level 2 subsection. In 828197de8f ("docs:
adjust for the recent rename of pu to seen", 2020-06-25), the length of this section header grew by two characters but we didn't adjust the number of ~ characters accordingly. AsciiDoc handles this discrepancy ok and still picks this up as a subsection title, but Asciidoctor is not as forgiving.

---
 Documentation/gitworkflows.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/gitworkflows.txt +1 -1
index 2db7ba7842..47cf97f9be 100644
@@ -292,7 +292,7 @@ described in the previous section.
 
 
 Branch management for next and seen after a feature release
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 After a feature release, the integration branch 'next' may optionally be
 rewound and rebuilt from the tip of 'master' using the surviving
Signature · 1 line
2.28.0.rc1
#1 lore raw
Quoted 8 lines · Martin Ågren

AsciiDoctor renders the "~~~~~~~~~" literally. That's not our intention:
it is supposed to indicate a level 2 subsection. In 828197de8f ("docs:
adjust for the recent rename of pu to seen", 2020-06-25), the length of this section header grew by two characters but we didn't adjust the number of ~ characters accordingly. AsciiDoc handles this discrepancy ok and still picks this up as a subsection title, but Asciidoctor is not as forgiving.

Quoted 4 lines
---
 Documentation/gitworkflows.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Nicely spotted and this obviously want to be in the final release, as it comes from 828197de (docs: adjust for the recent rename of pu to seen, 2020-06-25), which is a post 2.27 development.

Thanks.

Quoted 14 lines
Documentation/gitworkflows.txt +1 -1
index 2db7ba7842..47cf97f9be 100644
@@ -292,7 +292,7 @@ described in the previous section.
 
 
 Branch management for next and seen after a feature release
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 After a feature release, the integration branch 'next' may optionally be
 rewound and rebuilt from the tip of 'master' using the surviving
#2 lore raw
In reply to Martin Ågren

Hi Martin,

Quoted 7 lines · Martin Ågren

AsciiDoctor renders the "~~~~~~~~~" literally. That's not our intention:
it is supposed to indicate a level 2 subsection. In 828197de8f ("docs:
adjust for the recent rename of pu to seen", 2020-06-25), the length of this section header grew by two characters but we didn't adjust the number of ~ characters accordingly. AsciiDoc handles this discrepancy ok and still picks this up as a subsection title, but Asciidoctor is not as forgiving.

Thanks for catching that _before_ the release. Much, much appreciated!

Ciao,
Dscho

Quoted 23 lines
---
 Documentation/gitworkflows.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Documentation/gitworkflows.txt +1 -2
index 2db7ba7842..47cf97f9be 100644
@@ -292,7 +292,7 @@ described in the previous section.
 
 
 Branch management for next and seen after a feature release
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 After a feature release, the integration branch 'next' may optionally be
 rewound and rebuilt from the tip of 'master' using the surviving
--

2.28.0.rc1