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

docs: Add missing slashes to CURLOPT_SSLCERT documentation #12854

Closed

Conversation

JDepooter
Copy link
Contributor

When setting the CURLOPT_SSLCERT option to a certificate thumprint, it is required to have a backslash between the "store location", "store name" and "thumbprint" tokens. These slashes were present in the previous documentation, but were removed in the transition to curldown documentation.

This may indicate a bug in the nroff2cd script, so there may be more missing slashes in other files. Notably, the --cert documentation does not have this problem, despite having almost identical content. Perhaps because it uses single slashes instead of double.

In addition, I'll note that since the files are now .md files, the "<store location><store name><thumbprint>" text is showing up as "" when rendered on github, because angle brackets must be escaped in markdown. The text does show up correctly in the HTML documentation. (It will have the slashes if you view after this change is merged). If the angle brackets in the file are replaced with &lt; and &gt;, the file renders correctly on github. I don't know how adding escaping here would affect the other generated doc formats, so I have not added that change to this pull request. I can do so if desired.

When setting the CURLOPT_SSLCERT option to a certificate thumprint, it is required to have a backslash between the "store location", "store name" and "thumbprint" tokens. These slashes were present in the previous documentation, but were missed in the transition to markdown documentation.
@bagder bagder closed this in aefb0bd Feb 5, 2024
@bagder
Copy link
Member

bagder commented Feb 5, 2024

Thanks!

bagder added a commit that referenced this pull request Feb 5, 2024
Make sure we use \< and \> in markdown all over so that it renders
correctly, on GitHub and elsewhere. cd2nroff now outputs a warning if it
finds an unescaled angle bracket.

Ref: #12854
bagder added a commit that referenced this pull request Feb 6, 2024
Make sure we use \< and \> in markdown all over so that it renders
correctly, on GitHub and elsewhere. cd2nroff now outputs a warning if it
finds an unescaled angle bracket.

Ref: #12854
Closes #12869
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

None yet

2 participants