| Message ID | 20200718201723.10889-1-martin.agren@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | gitworkflows.txt: fix broken subsection underline | expand |
Martin Ågren <martin.agren@gmail.com> writes: > 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. > > Signed-off-by: Martin Ågren <martin.agren@gmail.com> > --- > 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. > > diff --git a/Documentation/gitworkflows.txt b/Documentation/gitworkflows.txt > index 2db7ba7842..47cf97f9be 100644 > --- a/Documentation/gitworkflows.txt > +++ b/Documentation/gitworkflows.txt > @@ -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
Hi Martin, On Sat, 18 Jul 2020, Martin Ågren wrote: > 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 > > Signed-off-by: Martin Ågren <martin.agren@gmail.com> > --- > Documentation/gitworkflows.txt | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/gitworkflows.txt b/Documentation/gitworkflows.txt > index 2db7ba7842..47cf97f9be 100644 > --- a/Documentation/gitworkflows.txt > +++ b/Documentation/gitworkflows.txt > @@ -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 > >
diff --git a/Documentation/gitworkflows.txt b/Documentation/gitworkflows.txt index 2db7ba7842..47cf97f9be 100644 --- a/Documentation/gitworkflows.txt +++ b/Documentation/gitworkflows.txt @@ -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
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. Signed-off-by: Martin Ågren <martin.agren@gmail.com> --- Documentation/gitworkflows.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)