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

chore: clarify --use-profile command in config by using long form #1344

Merged
merged 1 commit into from
Oct 31, 2024
Merged

chore: clarify --use-profile command in config by using long form #1344

merged 1 commit into from
Oct 31, 2024

Conversation

tshepang
Copy link
Contributor

No description provided.

@simonsan simonsan changed the title had to check what the option means chore: clarify --use-profile command in config by using long form Oct 31, 2024
@simonsan
Copy link
Contributor

I'm not against it in general, as we should make rustic easily approachable. Though running rustic help and checking for -P which is the first option in Global or checking the config readme would help. What I think we should probably take as a general rule from it is: Use long versions of command options in public documentation.

@simonsan simonsan enabled auto-merge October 31, 2024 22:15
@simonsan simonsan mentioned this pull request Oct 31, 2024
Open
@simonsan simonsan added this pull request to the merge queue Oct 31, 2024
Merged via the queue into rustic-rs:main with commit bf5276a Oct 31, 2024
25 checks passed
@rustic-release-plz rustic-release-plz bot mentioned this pull request Oct 31, 2024
Merged
@simonsan
Copy link
Contributor

simonsan commented Nov 1, 2024

Forgot to say, thank you for the contribution! 🖖

@tshepang tshepang deleted the patch-1 branch November 4, 2024 06:09
aawsome added a commit that referenced this pull request Dec 2, 2024
@rustic-release-plz @aawsome
chore: release v0.9.5 (#1341)
f565eea 
## 🤖 New release
* `rustic-rs`: 0.9.4 -> 0.9.5 (✓ API compatible changes)

<details><summary><i><b>Changelog</b></i></summary><p>

<blockquote>

## [0.9.5](v0.9.4...v0.9.5)
- 2024-12-02

### Added

- *(commands)* More dump options
([#1339](#1339))
- shut down gracefully with ctrl+c
([#1364](#1364))
- Add --filter-jq option
([#1372](#1372))
- *(async)* use `is_async_compatible()` to determine backend
incompatibility and error out
([#1355](#1355))
- *(commands)* Add `mount` command
([#973](#973))

### Fixed

- *(commands)* run backup hooks before checking source dir
([#1374](#1374))
- *(commands)* Use spawn_blocking in webdav when calling rustic_core
([#1365](#1365))
- *(filesystem)* Use channels to communicate within webdav filesystem
([#1361](#1361))

### Other

- Add documentation for `minutely` keep option
([#1371](#1371))
- update snapshots to include minutely configuration options
- *(deps)* update rustic_core, bytes, and libc dependencies to latest
versions
- simplify lifetime annotations in OpenFileReader and TreeIterItem
implementations
- clean up whitespace and update clippy linting allowances
- *(deps)* update dependencies to latest versions
- *(deps)* update lockfile to get rid of vulnerable `url` version
- *(mount)* rename fields for clarity, add user options for mount
([#1353](#1353))
- *(deps)* update dependencies
- *(deps)* don't use rustic_core webdav feature
([#1367](#1367))
- Revert "fix(filesystem): Use channels to communicate within webdav
filesystem ([#1361](#1361))"
- Revert "feat(async): use `is_async_compatible()` to determine backend
incompatibility and error out
([#1355](#1355))"
- move `webdavfs` from `rustic_core` to `rustic-rs`
([#1363](#1363))
- *(clippy)* comment out unused lints in lib.rs
- *(clippy)* apply fixes automatically
- use BTreeMap for env in global options
([#1360](#1360))
- add tiny framework for testing rustic's compat with latest restic
([#1303](#1303))
- use snapshot tests for default config, show-config and completions
([#1359](#1359))
- *(deps)* update dependencies rustic_core, rustic_backend,
rustic_testing, and migrate to conflate 0.3
([#1357](#1357))
- fix typos
- *(build)* add platform-dependent settings and remove ci flag for extra
features
- clarify `--use-profile` command in config by using long form
([#1344](#1344))
- *(deps)* update core and testing crates
([#1340](#1340))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).

---------

Co-authored-by: rustic-release-plz[bot] <182542030+rustic-release-plz[bot]@users.noreply.github.com>
Co-authored-by: Alexander Weiss <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@simonsan simonsan simonsan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tshepang @simonsan