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

Change the minor version on the docs for rsync optionally needed #882

Merged
merged 1 commit into from
Jan 17, 2024

Conversation

martinmarques
Copy link
Contributor

There's a requirement in the docs which is optional if you don't use rsync mode. This stated that you needed version 3.0.4 or better, yet this was not true as we need at least version 3.1.0 to use --ignore-missing-args.

This commit sets the documentation right so there's no confusion regarding the minimum version of rsync that is required to run barman with rsync.

@@ -10,7 +10,7 @@
- python-dateutil
- setuptools
- PostgreSQL >= 10 (next version will require PostgreSQL >= 11)
- rsync >= 3.0.4 (optional)
- rsync >= 3.1.2 (optional)
Copy link
Contributor

Choose a reason for hiding this comment

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

The PR looks good.

From the changelog and PR description/commit message I can see we actually require 3.1.0 for --ignore-missing-args to be available.

I can see an internal comment about 3.1.2 being the oldest available in supported operating systems, so I guess that's why we are setting 3.1.2 here. But that seems more of a packaging characteristic than a requirement of Barman.

With that in mind I wonder if we should take some of the following actions:

  • Set 3.1.0 as a requirement, and have >= 3.1.0 in the package requirements; or
  • Adjust the commit message/PR description to clarify why we are setting 3.1.2 in the markdown docs file instead of 3.1.0, just so the history will make sense if one ever attempts to inspect the commit log

I know this comment seems an overkill, but I felt I should raise it just in case

Thoughts?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

think this makes sense. I'll push another commit to over-write the version dropping to 3.1.0

There's a requirement in the docs which is optional if you don't
use rsync mode. This stated that you needed version 3.0.4 or
better, yet this was not true as we need at least version 3.1.0
to use `--ignore-missing-args`.

This commit sets the documentation right so there's no confusion
regarding the minimum version of rsync that is required to run
barman with rsync.

This never came up because all supported OS distributions already
have rsync 3.1.2 or newer.

Signed-off-by: Martín Marqués <martin.marques@enterprisedb.com>
Copy link

edb-sonar-app bot commented Jan 15, 2024

Quality Gate passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No Coverage information No data about Coverage
0.0% 0.0% Duplication on New Code

See analysis details on SonarQube

@martinmarques martinmarques merged commit 39488fe into master Jan 17, 2024
9 checks passed
@martinmarques martinmarques deleted the dev/BAR-137 branch January 17, 2024 15:29
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.

2 participants