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

Avoid HTML comment preamble in man page output from Pandoc #399

Merged
merged 4 commits into from
Nov 19, 2024

Conversation

olleolleolle
Copy link
Member

@olleolleolle olleolleolle commented Aug 6, 2024

Description:

This PR changes the way man pages are generated, avoiding a preamble that mentions Pandoc. Fixes #398

That preamble is fine to have in HTML, not in man pages.

In addition, regenerate docs.


I will abide by the code of conduct.

@olleolleolle olleolleolle changed the title Fix help command Avoid preamble in man page output from Pandoc Aug 6, 2024
@olleolleolle
Copy link
Member Author

olleolleolle commented Aug 6, 2024

Aha, tests fail in an interesting way:

Untracked files:
  (use "git add <file>..." to include in what will be committed)
	%2FUsers%2Folle.jonsson%2Fopensource%2Fgemstash%2Ftmp%2Ftest_base%2Fgemstash.db

Somehow the path to the sqlite DB file is created URL-encoded.

Removing the CGI.escape around the db_path makes the test pass. See 14126ca

I guess this will fail on "space in the path" paths.
@olleolleolle olleolleolle changed the title Avoid preamble in man page output from Pandoc Avoid HTML comment preamble in man page output from Pandoc Aug 6, 2024
@segiddins segiddins merged commit 93a8a01 into rubygems:main Nov 19, 2024
12 checks passed
@olleolleolle olleolleolle deleted the fix-help-command branch November 20, 2024 08:40
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.

manpages contain <!-- Automatically generated by Pandoc -->
2 participants