Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[epub/PDF] refspec: Broken formatting due to interpreted monospaced text #1913

Open
4 of 5 tasks
vadcx opened this issue Nov 7, 2023 · 2 comments
Open
4 of 5 tasks
Labels

Comments

@vadcx
Copy link

vadcx commented Nov 7, 2023

There's no existing/similar bug report.

  • I have searched the existing issues

This report is about a single actionable bug.

  • I'm reporting a single actionable bug

This report is about the ProGit book, version 2, English language.

  • This bug is not about a translation or old version

Bug covers book website/pdf

  • I confirm the bug is about the book as found on the website/pdf

Problem is present in the Pro Git book on the website?

  • This bug also affects the Pro Git book as published on the website.

Which version of the book is affected?

Source files

Describe the bug:

What was supposed to be monospaced inline code is interpreted by asciidoctor for formatting characters, breaking in a few places. This affects PDF, EPUB, but NOT the HTML/website. I didn't check MOBI.

The solution is to either escape the formatting charcaters manually with backslash \ or instead use the literal monospace syntax: `+inline here+`

I suppose it's easier to mass replace single backticks with the new literal monospace syntax instead of hunting down all occurrences one by one? Personally I don't know the syntax of asciidoctor enough to do the latter, but the replacement seems easy enough.

Steps to reproduce:

Git Internals -> The Refspec, page 432 in PDF. The plus sign is missing and the paragraph has broken code formatting

Expected behavior:

Correct formatting

Screenshots:

Website (correct):
gitpro-plus-website

Epub (broken)
gitpro-plus-epub

PDF (broken)
gitpro-plus-pdf

Additional context:

A comment by jnavila implies its the new syntax that the book wasn't adapted for. One single occurrence of this type of error was fixed in PR: #1300

refspec.asc:

The format of the refspec is, first, an optional `+`, followed by `<src>:<dst>`, where `<src>` is the pattern for references on the remote side and `<dst>` is where those references will be tracked locally.
The `+` tells Git to update the reference even if it isn't a fast-forward.

PS: Oh my such strict bug templates are a pain to adhere to, if you already typed it all out properly anyway...

Device

No response

Operating system

No response

Browser/application + version

No response

@vadcx vadcx added the bug label Nov 7, 2023
@Chealer
Copy link

Chealer commented Dec 16, 2024

Thank you very much @vadcx , this persists and I was about to report the same. I recommend to add "refspec" and "PDF" in this ticket's title.

P.S. Regarding the bug reporting templates, that's painful indeed. I had just reported that in ticket #2000.

@vadcx vadcx changed the title Broken formatting due to interpreted monospaced text [epub/PDF] refspec: Broken formatting due to interpreted monospaced text Dec 16, 2024
@vadcx
Copy link
Author

vadcx commented Dec 16, 2024

@Chealer thanks, edited the title. I understand the frustration too well, when the bug reporting systems have poor search. Worst offender of all Bugzilla (imo)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants