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

Tiny wording clarification in restic-stats.1. #4769

Merged
merged 1 commit into from
Apr 18, 2024

Conversation

will-ca
Copy link
Contributor

@will-ca will-ca commented Apr 17, 2024

What does this PR change? What problem does it solve?

$ man restic-stats is currently more ambiguous than the web docs while describing file-by-contents. It doesn't actually say what happens when a file is "unique".

See:

restic/doc/manual_rest.rst

Lines 300 to 303 in 55d56db

- ``restore-size`` (default) counts the size of the restored files.
- ``files-by-contents`` counts the total size of unique files as given by their
contents. This can be useful since a file is considered unique only if it has
unique contents. Keep in mind that a small change to a large file (even when the

Was the change previously discussed in an issue or on the forum?

No.

Checklist

  • I have read the contribution guidelines.
  • I have enabled maintainer edits.
  • I have added tests for all code changes.
  • I have added documentation for relevant changes (in the manual).
  • There's a new file in changelog/unreleased/ that describes the changes for our users (see template).
  • I have run gofmt on the code in all commits.
  • All commit messages are formatted in the same style as the other commits in the repo.
  • I'm done! This pull request is ready for review.

Copy link
Member

@MichaelEischer MichaelEischer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

restic-stats.1 is autogenerated from cmd/restic/cmd_stats.go. Please fix the description there.

Copy link
Member

@MichaelEischer MichaelEischer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@MichaelEischer MichaelEischer added this pull request to the merge queue Apr 18, 2024
Merged via the queue into restic:master with commit 228b35f Apr 18, 2024
13 checks passed
@will-ca will-ca deleted the patch-1 branch April 23, 2024 00:46
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

Successfully merging this pull request may close these issues.

None yet

2 participants