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.

Sign up for GitHub

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

Jump to bottom

docs: improve curl man page references #11963

Closed
wants to merge 2 commits into from
Closed

docs: improve curl man page references #11963

wants to merge 2 commits into from

Conversation

bagder
Copy link
Member

@bagder bagder commented Sep 27, 2023 •
edited

  1. References to curl symbols are now checked that they indeed exist as man pages. This for \f references as well as the names referenced in the SEE ALSO section. Allowlist curl.1 since it is not always built in builds
  2. References to curl symbols that lack section now causes warning, since that will prevent them from getting linked properly
  3. Check for "bare" references to curl functions and warn, they should be references

@github-actions github-actions bot added the tests label Sep 27, 2023
@bagder
manpage-syntax: verify curl man page references
f35bf39 
1. References to curl symbols are now checked that they indeed exist as
   man pages. This for \f references as well as the names referenced in the
   SEE ALSO section.

   Allowlist curl.1 since it is not always built in builds

2. References to curl symbols that lack section now causes warning, since that
   will prevent them from getting linked properly

3. Check for "bare" references to curl functions and warn, they should be
   references

Closes #11963
@bagder
docs: update curl man page references
b8ccabb 
Detected by the manpage-syntax update
@bagder bagder closed this in 2b8937c Sep 28, 2023
bagder added a commit that referenced this pull request Sep 28, 2023
@bagder
docs: update curl man page references
f11a5d2 
Detected by the manpage-syntax update

Closes #11963
@bagder bagder deleted the bagder/man-refs branch September 28, 2023 20:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
documentation tests
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@bagder