Explain usage of monitor --config in command help
#2249
Merged
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
The `--config` flag of the `arduino-cli monitor` command is used to configure the communication port used by the monitor. Previously the command line help did not provide any guidance for the usage of this flag, which might lead the users to wonder: - How can the configuration options available for use via the flag be determined? - What is the format for the configuration option argument? The information is provided in the FAQ page of the documentation, but that is not as convenient a source of information as the command line help and the user may not even be aware of its existence. The command help is hereby adjusted to provide the user with this information: - Create a conceptual linkage between the `--config` and `--describe` flags by using the "communication port settings" terminology in the references of both. - Document the argument format. In addition to the comma-separated list format I documented here, an alternative usage of passing multiple `--config` flags is also supported. I chose the former because I felt that the descriptions of the latter in either command line notation (e.g., `[--config <ID>=<value>]...`) or in prose (e.g., "The format is <ID>=<value>. Can be used multiple times for multiple settings.") were less clear.
per1234
added
type: enhancement
|
The failing tests in the "Test Go" workflow run is unrelated to the changes proposed here and also occurs on the |
MatteoPologruto
approved these changes
Jul 24, 2023
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.
Please check if the PR fulfills these requirements
See how to contribute
before creating one)
our contributing guidelines
UPGRADING.mdhas been updated with a migration guide (for breaking changes)configuration.schema.jsonupdated if new parameters are added.What kind of change does this PR introduce?
docs update
What is the current behavior?
The
--configflag of thearduino-cli monitorcommand is used to configure the communication port used by the monitor.Previously the command line help did not provide any guidance for the usage of this flag, which might lead the users to wonder (#2070):
The information is provided in the FAQ page of the documentation (#2247), but that is not as convenient a source of information as the command line help and the user may not even be aware of its existence.
What is the new behavior?
Adjust the command help to provide the user with the missing information by:
--configand--describeflags by using the "communication port settings" terminology in the references of both.In addition to the comma-separated list format I documented here, an alternative usage of passing multiple
--configflags is also supported. I chose the former because I felt that the descriptions of the latter in either command line notation (e.g.,[--config <ID>=<value>]...) or in prose (e.g., "The format is <ID>=<value>. Can be used multiple times for multiple settings.") were less clear.Does this PR introduce a breaking change, and is titled accordingly?
No breaking change.