libcurl option manpages consistency cleanup #7656
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
👉 View analysis in DeepCode’s Dashboard | Configure the bot👉 The DeepCode service and API will be deprecated in August, 2021. Here is the information how to migrate. Thank you for using DeepCode 🙏 ❤️ !If you are using our plugins, you might be interested in their successors: Snyk's JetBrains plugin and Snyk's VS Code plugin. |
bagder
force-pushed
the
bagder/opt-manpage-examples
branch
from
62a7b14
to
7f8179d
Compare
|
I'm not following. Availability of what? The particular options? We do provide the CURL_AT_LEAST_VERSION() macro for easier version checks if that's what mean.
Right, that’s exactly what I was thinking of, including the relevant CURL_AT_LEAST_VERSION(); snippet ready to be copy/pasted into code. That being said, it might be a tad repetitive and not really worth it since it’s so simple to use.
Just thinking about how we can lower the barrier to using libcurl as much as possible.
|
danielgustafsson
approved these changes
Sep 1, 2021
|
This is enough for this PR, no expansion planned. I'll just need to make sure all builds work properly with this. |
This comment has been minimized.
This comment has been minimized.
It is also the problem of build-time vs run-time. Using CURL_AT_LEAST_VERSION() will certainly make your program build with older libcurls but for cases where you build your program with a new libcurl and run it with an old, you need other checks so the CURL_AT_LEAST_VERSION() won't be enough so it would be very important to not mislead the user into believing so. I'm not sure how to best do that! |
|
It is also the problem of build-time vs run-time. Using CURL_AT_LEAST_VERSION() will certainly make your program build with older libcurls but for cases where you build your program with a new libcurl and run it with an old, you need other checks so the CURL_AT_LEAST_VERSION() won't be enough so it would be very important to not mislead the user into believing so. I'm not sure how to best do that!
Ah yes, that’s a very good point.
|
bagder
force-pushed
the
bagder/opt-manpage-examples
branch
from
b7a2cab
to
6f6114b
Compare
Extended manpage-syntax.pl (run by test 1173) to check that every man page for a libcurl option has an EXAMPLE section that is more than two lines. Then fixed all errors it found and added examples.
In every libcurl option man page there are now 8 mandatory sections that must use the right name in the correct order and test 1173 verifies this. Only 14 man pages needed adjustments. The sections and the order is as follows: - NAME - SYNOPSIS - DESCRIPTION - PROTOCOLS - EXAMPLE - AVAILABILITY - RETURN VALUE - SEE ALSO
... that they refer to actual existing libcurl options.
bagder
force-pushed
the
bagder/opt-manpage-examples
branch
from
1f20544
to
2fa9027
Compare
bagder
added a commit
that referenced
this pull request
Sep 4, 2021
In every libcurl option man page there are now 8 mandatory sections that must use the right name in the correct order and test 1173 verifies this. Only 14 man pages needed adjustments. The sections and the order is as follows: - NAME - SYNOPSIS - DESCRIPTION - PROTOCOLS - EXAMPLE - AVAILABILITY - RETURN VALUE - SEE ALSO Reviewed-by: Daniel Gustafsson Closes #7656
bagder
added a commit
that referenced
this pull request
Sep 4, 2021
bagder
added a commit
that referenced
this pull request
Sep 4, 2021
... that they refer to actual existing libcurl options. Reviewed-by: Daniel Gustafsson Closes #7656
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
All man pages for libcurl options now need to:
Failure to comply makes test 1173 error.