Skip to content

Codeblocks with configuration comments not rendered properly #6

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

Closed
jericson opened this issue Apr 9, 2025 · 1 comment
Closed

Codeblocks with configuration comments not rendered properly #6

jericson opened this issue Apr 9, 2025 · 1 comment

Comments

@jericson
Copy link
Member

jericson commented Apr 9, 2025

For some reason, configuration examples that start with # (i.e., comments) don't get rendered properly. See for example man5/config:

Image

C code seems to work fine. Same with the table in man3/OPENSSL_s390xcap. I used the following code to find spot check for problems:

find . -name \*.pod | xargs grep '^\W*#' | grep -v '#include' | grep -v '#define' | grep -v '#if' | grep -v '#endif'| grep -v '<<' | grep -v '#else'

When I make the docs locally, I don't see the problems in the generated HTML files. For instance, when I open openssl/doc/html/man5/config.html, I see this:

Image

My guess is the problem has something to do with syntax highlighting, but I haven't looked closely at how POD is processed into HTML here.

@quarckster
Copy link
Contributor

Thank you for the submitting this issue. The problem was in the markdown headings regular expression. I pushed the fix and rebuilt all branches.

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

No branches or pull requests

2 participants