Skip to content

docs: replace GZIP compression by LZ4 and MD5/SHA1 signature by XXH128#1453

Merged
joergsteffens merged 3 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno/master/docs-replace-gzip-by-lz4
May 4, 2023
Merged

docs: replace GZIP compression by LZ4 and MD5/SHA1 signature by XXH128#1453
joergsteffens merged 3 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno/master/docs-replace-gzip-by-lz4

Conversation

@bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Apr 24, 2023 •
edited by joergsteffens
Loading

This PR propose to update our documentation by replacing the slowest compression algorithm we have (GZIP) by a modern and well supported format LZ4.
We also replaced the oldest MD5 or SHA1 signature exemple by the XXH128

OP#5451

Please check

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

If you have any questions or problems, please give a comment in the PR.

Helpful documentation and best practices

Checklist for the reviewer of the PR (will be processed by the Bareos team)

Make sure you check/merge the PR using devtools/pr-tool to have some simple automated checks run and a proper changelog record added.

General
  • Is the PR title usable as CHANGELOG entry?
  • Purpose of the PR is understood
  • Commit descriptions are understandable and well formatted
  • Check backport line
  • Required backport PRs have been created
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR

@bruno-at-bareos bruno-at-bareos added the documentation This PR changes only documentation label Apr 24, 2023
@bruno-at-bareos bruno-at-bareos requested a review from pstorz April 24, 2023 13:28
joergsteffens
joergsteffens requested changes Apr 24, 2023
View reviewed changes
docs/manuals/source/TasksAndConcepts/VolumeManagement.rst Outdated

:index:`\ <single: Volume; Management; Key Concepts and Resource Records>`\
.. index::
ingle: Volume; Management; Key Concepts and Resource Records
Copy link
Member

@joergsteffens joergsteffens Apr 24, 2023

Choose a reason for hiding this comment

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

Suggested change
ingle: Volume; Management; Key Concepts and Resource Records
single: Volume; Management; Key Concepts and Resource Records

Copy link
Contributor Author

@bruno-at-bareos bruno-at-bareos Apr 24, 2023

Choose a reason for hiding this comment

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

tx applied

docs/manuals/source/TasksAndConcepts/VolumeManagement.rst Outdated

:index:`\ <single: Pool; Options to Limit the Volume Usage>`\
.. index::
single: Pool; Options to Limit the Volume Usage>`\
Copy link
Member

@joergsteffens joergsteffens Apr 24, 2023

Choose a reason for hiding this comment

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

Suggested change
single: Pool; Options to Limit the Volume Usage>`\
single: Pool; Options to Limit the Volume Usage>`\

Copy link
Contributor Author

@bruno-at-bareos bruno-at-bareos Apr 24, 2023

Choose a reason for hiding this comment

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

ty applied also fixing end of line ;-)

@bruno-at-bareos bruno-at-bareos removed the request for review from pstorz April 27, 2023 10:02
bruno-at-bareos and others added 2 commits May 4, 2023 14:11
@bruno-at-bareos
doc: replace gzip by lz4 and md5 by xxh128
981ef86 
- doc: update index syntax
- doc: Add summary sentence for use lz4 compression.
- doc: Fix some space issues
- doc: cleanup and reorder

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>

(cherry picked from commit a6db72a)
@joergsteffens @bruno-at-bareos
doc: fix formatting
30e9932 
(cherry picked from commit 8dcd29c)
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/docs-replace-gzip-by-lz4 branch from ec8c0f1 to 30e9932 Compare May 4, 2023 12:24
@joergsteffens joergsteffens merged commit 23fe150 into bareos:master May 4, 2023
@bruno-at-bareos bruno-at-bareos mentioned this pull request May 4, 2023
Merged
11 tasks
@bruno-at-bareos bruno-at-bareos deleted the dev/bruno/master/docs-replace-gzip-by-lz4 branch June 12, 2023 09:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joergsteffens joergsteffens joergsteffens approved these changes

Assignees

@joergsteffens joergsteffens

Labels

documentation This PR changes only documentation requires backport to 22

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bruno-at-bareos @joergsteffens