| Message ID | 20190405225115.3882-3-tmz@pobox.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | [1/2] Documentation/git-show-branch: drop last use of {apostrophe} | expand |
On Sat, 6 Apr 2019 at 00:51, Todd Zullinger <tmz@pobox.com> wrote: > > The second paragraph in the CONFIGURATION section intends to emphasize > the word 'must' with bold type. Adjust the formatting slightly to > provide similar results between asciidoc and asciidoctor. I don't think this explains the problem you're solving well enough. It also doesn't make it clear enough, IMHO, how what we're doing here solves that problem. How about something like this? The second paragraph in the CONFIGURATION section intends to emphasize the word 'must' with bold type. It does so by writing it as *must*, and this works fine with AsciiDoc. It usually works great with Asciidoctor, too, but in this particular instance, we have another "*" earlier in the paragraph. We do escape it, and it is rendered literally just like we want it to, but Asciidoctor then ends up tripping on the second (or third) of the asterisks in this paragraph. Since that asterisk is (part of) a literal example, we can set it in monospace, by giving it as `*`. Adjust the whole paragraph in this way. There's lots more monospacing to be done in this document, but since our main motivation is addressing AsciiDoc/Asciidoctor discrepancies like this one, let's just convert this one paragraph. I think what's happening could be related to the fix in the first patch. There, it's ok to explicitly escape only the first '. The second one is matched to it and gets escaped implicitly. Something like that could be happening here, too, just that we don't want it to. (Should we escape the implicit escaping? ...) Just speculation, though. Martin
Martin Ågren wrote: > I think what's happening could be related to the fix in the first patch. > There, it's ok to explicitly escape only the first '. The second one is > matched to it and gets escaped implicitly. Something like that could be > happening here, too, just that we don't want it to. (Should we escape > the implicit escaping? ...) Just speculation, though. It could well be a similar issue. I think I tried adding an escape to the existing \* and/or to elsewhere in the block of text, without success. But I didn't try very hard though, as adjusting the test to use `*` seemed like an improvement. Thanks,
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt index b99029520d..81aaef8e4e 100644 --- a/Documentation/git-svn.txt +++ b/Documentation/git-svn.txt @@ -1100,10 +1100,10 @@ listed below are allowed: tags = tags/*/project-a:refs/remotes/project-a/tags/* ------------------------------------------------------------------------ -Keep in mind that the '\*' (asterisk) wildcard of the local ref -(right of the ':') *must* be the farthest right path component; +Keep in mind that the `*` (asterisk) wildcard of the local ref +(right of the `:`) *must* be the farthest right path component; however the remote wildcard may be anywhere as long as it's an -independent path component (surrounded by '/' or EOL). This +independent path component (surrounded by `/` or EOL). This type of configuration is not automatically created by 'init' and should be manually entered with a text-editor or using 'git config'.
The second paragraph in the CONFIGURATION section intends to emphasize the word 'must' with bold type. Adjust the formatting slightly to provide similar results between asciidoc and asciidoctor. Signed-off-by: Todd Zullinger <tmz@pobox.com> --- I debated changing 'must' from bold to italic in this hunk. There are two other emphasized uses of 'must' in git-svn.txt. One is bold and one is italic. So I left this one bold and simply adjusted the "'" quotes to "`" around the "*" and ":" characters. This is the more minimal fix to keep the output rendered the same in asciidoc and asciidoctor. Documentation/git-svn.txt | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)