curl: help category cleanups - #22447
Closed
bagder wants to merge 1 commit into
Closed
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an MQTT help category and updates option categorization/wording so curl --help and option documentation better reflect protocol applicability (including MQTT).
Changes:
- Introduce a new
mqtthelp category and include it in help output/tests. - Expand several option category bitmasks and cmdline-opts
Category:fields to include additional protocol categories. - Reword
--datadocumentation/help to be less HTTP-specific and mention MQTT PUBLISH behavior.
Reviewed changes
Copilot reviewed 26 out of 26 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/data/test1462 | Updates expected category list to include mqtt. |
| tests/data/data1461.txt | Updates expected --help output (including categories list and --data short text). |
| src/tool_listhelp.c | Adjusts per-option help categories; updates --data short description and adds MQTT category bit. |
| src/tool_help.h | Adds CURLHELP_MQTT category bit constant. |
| src/tool_help.c | Registers the new mqtt category descriptor for --help category. |
| scripts/managen | Tweaks wrapping logic for generated category bitmask lines. |
| docs/cmdline-opts/upload-flags.md | Adds more categories to align option classification with IMAP/upload usage. |
| docs/cmdline-opts/upload-file.md | Adds IMAP category to reflect use with IMAP uploads. |
| docs/cmdline-opts/unix-socket.md | Adds HTTP category to match protocol applicability. |
| docs/cmdline-opts/ssl.md | Adds FTP category to match supported protocols. |
| docs/cmdline-opts/ssl-reqd.md | Adds FTP category to match supported protocols. |
| docs/cmdline-opts/show-headers.md | Adds HTTP/FTP categories to match supported protocols. |
| docs/cmdline-opts/sasl-ir.md | Adds protocol categories (IMAP/POP3/LDAP/SMTP) for SASL usage. |
| docs/cmdline-opts/sasl-authzid.md | Adds protocol categories (LDAP/IMAP/POP3/SMTP) for SASL usage. |
| docs/cmdline-opts/remote-header-name.md | Adds HTTP category to match protocol applicability. |
| docs/cmdline-opts/proxy-header.md | Adds HTTP category to match protocol applicability. |
| docs/cmdline-opts/pass.md | Expands protocol categories for TLS/SCP/SFTP/SSH usage. |
| docs/cmdline-opts/oauth2-bearer.md | Adds HTTP category to match supported protocols. |
| docs/cmdline-opts/max-filesize.md | Adds FTP/HTTP/MQTT categories to match supported protocols. |
| docs/cmdline-opts/knownhosts.md | Expands categories for SCP/SFTP/SSH usage. |
| docs/cmdline-opts/key.md | Expands categories for TLS/SCP/SFTP/SSH usage. |
| docs/cmdline-opts/form-escape.md | Adds IMAP/SMTP categories to match supported protocols. |
| docs/cmdline-opts/data.md | Rewords --data docs to cover MQTT and updates categorization. |
| docs/cmdline-opts/compressed-ssh.md | Adds SFTP category to match supported protocols. |
| docs/cmdline-opts/basic.md | Adds HTTP category to match supported protocols. |
| docs/cmdline-opts/abstract-unix-socket.md | Adds HTTP category to match protocol applicability. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- add 'mqtt' as a category - add more protocol categories to several options - make --data worded better to also cover MQTT Closes #22447
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.