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.

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

How accurate is the documentation? #19

Open
zxcat opened this issue Oct 10, 2023 · 3 comments
Open

How accurate is the documentation? #19

zxcat opened this issue Oct 10, 2023 · 3 comments

Comments

@zxcat
Copy link
Contributor

zxcat commented Oct 10, 2023

Docs say rustic won't backup xattr:

Note that `rustic` does not back up some metadata associated with files. Of
particular note are::
- file creation date on Unix platforms
- inode flags on Unix platforms
- xattr information

But this PR says it backups and restores: rustic-rs/rustic#557

Because of this, some users simply will not start using rustic due to inaccurate information. And also it confuses. Maybe put some large note somewhere on the title page about documentation status?

Or is there some up to date docs?

@aawsome
Copy link
Member

aawsome commented Oct 10, 2023

TL;DR: The docu is not yet very accurate and may be even totally wrong. It is a first start where some pieces have been simply copy&pasted from the restic docu but may not be true for rustic.

However, you are invited to correct anything wrong; just use the "edit" button on the top right on the respeting page at https://rustic.cli.rs/docs/ and create a PR from your changes.

@zxcat
Copy link
Contributor Author

zxcat commented Oct 10, 2023

Ok I see, thanks.
To correct something, you need to know how it should be correct : )
I'll try rustic first to obtain such knowledge.

@aawsome
Copy link
Member

aawsome commented Oct 10, 2023

Actual, the best docu which is correct is the CLI docu you get by rustic -h or rustic <COMMAND> -h...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants