Skip to content

[skip changelog] Correct documentation re: arduino-cli config init behavior #781

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
Merged
merged 1 commit into from
Jul 6, 2020
Merged

[skip changelog] Correct documentation re: arduino-cli config init behavior #781

merged 1 commit into from
Jul 6, 2020
+3 −3

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jul 4, 2020 •
edited
Loading

Please check if the PR fulfills these requirements

  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • The PR follows our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • What kind of change does this PR introduce?

Documentation correction.

  • What is the current behavior?

Documentation of arduino-cli config init doesn't accurately or fully match its behavior (which can be somewhat unintuitive under certain conditions):

  • Configuration filename is now arduino-cli.yaml, not "cli-config.yml"
  • Default configuration file location is no longer correctly described as "$EXE_DIR". It is now directories.data.
  • Location of the written configuration file location may be customized via --dest-dir.
  • Current configuration is written, not the default configuration.
  • If configuration file already exists, it is updated with the current configuration.
  • What is the new behavior?

Documentation of arduino-cli config init matches its behavior.

  • Does this PR introduce a breaking change?

No.

@per1234
Correct documentation re: arduino-cli config init behavior
954e73b 
- Default configuration file location is no longer correctly described as "$EXE_DIR". It is now directories.data.
- Location of the written configuration file location may be customized via --dest-dir.
- Current configuration is written, not the default configuration.
- If configuration file already exists, it is updated with the current configuration.
@per1234 per1234 added the topic: documentation Related to documentation for the project label Jul 4, 2020
@per1234 per1234 merged commit 9238a6c into arduino:master Jul 6, 2020
@per1234 per1234 deleted the correct-arduino-cli-config-init-documentation branch July 6, 2020 10:46
@per1234 per1234 self-assigned this Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rsora rsora

Assignees

@per1234 per1234

Labels
topic: documentation Related to documentation for the project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@per1234 @rsora