fix(iroh-cli)!: Improve cli and configuration file #2532
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
- Error on unknown fields. - Make it possible to express GcPolicy in the TOML config file. This was not possible before.
- Update header of iroh. - Directly point to config file docs. - Use consistent style.
flub
added a commit
to n0-computer/iroh.computer
that referenced
this pull request
Jul 23, 2024
This updates the configuration docs: - Document the config directory distinct from the data directory. - Explain where the config file is looked for. - Explain the configuration file format. - Add a full example. - Document the environment variables. This depends on n0-computer/iroh#2532 as the GcPolicy was not configurable before.
|
I'm confused by the PR title. Is it missing a |
flub
changed the title
lol, i forgot how to write PR titles |
dignifiedquire
approved these changes
Jul 24, 2024
matheus23
pushed a commit
that referenced
this pull request
Nov 14, 2024
## Description The configuration file behaviour is improved: - Unknown fields will now cause an error rather than be silently ignored. - Make it possible to express GcPolicy in the TOML config file. This was not possible before. It was possible to disable it before, but it was disabled by default so that was rather moot. The --help output is improved: - Update header of iroh. - Directly point to config file docs. - Use consistent style. <!-- A summary of what this pull request achieves and a rough list of changes. --> ## Breaking Changes - Unknown fields in the configuration file will now cause an error. - Configuring the GC Policy in the configuration file has changed. <!-- Optional, if there are any breaking changes document them, including how to migrate older code. --> ## Notes & open questions <!-- Any notes, remarks or open questions you have to make about the --> <!-- PR. --> ## Change checklist - [ ] Self-review. - [x] Documentation updates following the [style guide](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#appendix-a-full-conventions-text), if relevant. - [x] Tests if relevant. - [x] All breaking changes documented.
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.
Description
The configuration file behaviour is improved:
Unknown fields will now cause an error rather than be silently ignored.
Make it possible to express GcPolicy in the TOML config file. This
was not possible before. It was possible to disable it before, but
it was disabled by default so that was rather moot.
The --help output is improved:
Breaking Changes
Unknown fields in the configuration file will now cause an error.
Configuring the GC Policy in the configuration file has changed.
Notes & open questions
Change checklist