Skip to content

FAQ: minor improvements#20812

Open
rybak wants to merge 3 commits intocurl:masterfrom
rybak:faq-markdown-tweaks
Open

FAQ: minor improvements#20812
rybak wants to merge 3 commits intocurl:masterfrom
rybak:faq-markdown-tweaks

Conversation

@rybak
Copy link
Contributor

@rybak rybak commented Mar 4, 2026

Three minor improvements for the file docs/FAQ.md. Details are in the individual commit messages.

rybak added 3 commits March 4, 2026 10:12
During conversion of `docs/FAQ` into Markdown, 'man ld' has incorrectly
kept one of its quotes when it was surrounded by backticks for inline
code formatting.  A space on the left of it was lost as well.

Fix the formatting in the new `docs/FAQ.md`.
I've also considered using a local file link syntax, which most Markdown
renderers can convert into a clickable link:

	[docs/THANKS](./docs/THANKS)

but there are already several examples of linking to https://curl.se for
similar files in FAQ.md.
Wrap `lib/config-*.h` in backticks to format it as inline code to make
the formatting of the instructions in "How do I port libcurl to my OS?"
consistent.

Side note: some Markdown syntax parsers can get confused by an unescaped
and unpaired asterisk, which can get interpreted as starting an unclosed
italics block.
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.

3 participants