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

Escape notepad++ default installation path #1970

Merged
merged 1 commit into from
Aug 13, 2024
Merged

Conversation

z-hed
Copy link
Contributor

@z-hed z-hed commented Aug 9, 2024

Changes

  • Add a single backslash to the Notepad++ editor path in A3.1 Setup and Config.

Context

It appears that the pair of "++" in the Notepad++ path may be interpreted as an inline passthrough by Asciidoctor. The double pluses are omitted in the rendered text (both on git-scm.com and the .pdf in the latest release.) The resulting command is incorrect if copied and pasted into the terminal, which is exactly what I had done when I noticed the problem.

If GitHub's web editor is rendering my change correctly, a single backslash in the first pair of double pluses is enough to fix the issue. After reading the contributing guidelines, I figured this is a minor enough correction that I did not need to open an issue first, but I have not contributed before. Constructive criticism welcomed. Thank you for your time.

@@ -59,7 +59,7 @@ Accompanying the configuration instructions in <<ch01-getting-started#_editor>>,
|Kate (Linux) |`git config --global core.editor "kate --block"`
|nano |`git config --global core.editor "nano -w"`
|Notepad (Windows 64-bit) |`git config core.editor notepad`
|Notepad++ (Windows 64-bit) |`git config --global core.editor "'C:\Program Files\Notepad++\notepad++.exe' -multiInst -notabbar -nosession -noPlugin"` (Also see note below)
|Notepad++ (Windows 64-bit) |`git config --global core.editor "'C:\Program Files\Notepad+\+\notepad++.exe' -multiInst -notabbar -nosession -noPlugin"` (Also see note below)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting. Only the second + needs to be escaped? The other three are fine?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe escaping any one of the four + that surrounds \notepad should stop it from being considered as an enclosing pair of double pluses.

When I experimented with escaping more than one, the literal backslashes appeared in the output, possibly because by that point there was no special meaning to actually escape and they were interpreted literally.

@ben ben merged commit b3af68c into progit:main Aug 13, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants