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

docs: borg commands updated with --repo option #8681

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

vancheese
Copy link

REPO::ARCHIVE formatting has been replaced in the documentation with --repo

Only python files have been updated

All modified commands have been tested

This should replaces the initial PR

@ThomasWaldmann
Copy link
Member

Guess you also need to apply some other of your fixes:

  • all .rst files that are NOT autogenerated (see "this is autogenerated" comment in first line)
  • maybe check you have localized the correct place for all changes in the original PR

Copy link

codecov bot commented Mar 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.82%. Comparing base (1559a1e) to head (1b73cc6).
Report is 22 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #8681      +/-   ##
==========================================
- Coverage   81.83%   81.82%   -0.02%     
==========================================
  Files          74       74              
  Lines       13319    13348      +29     
  Branches     1963     1971       +8     
==========================================
+ Hits        10900    10922      +22     
- Misses       1755     1761       +6     
- Partials      664      665       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@vancheese
Copy link
Author

I've updated the pull request with the non-autoupdated rst files

Copy link
Member

@ThomasWaldmann ThomasWaldmann left a comment

Choose a reason for hiding this comment

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

some stuff i found.

@@ -329,14 +329,14 @@ Reading backup data from stdin
There are two methods to read from stdin. Either specify ``-`` as path and
pipe directly to borg::

backup-vm --id myvm --stdout | borg create REPO::ARCHIVE -
backup-vm --id myvm --stdout | borg create --repo REPO ARCHIVE -
Copy link
Member

Choose a reason for hiding this comment

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

this is a auto-generated file, you need to edit the respective .py file to change contents here.

see comment in line 1 of this file.

Copy link
Member

Choose a reason for hiding this comment

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

did you see my comment?

@@ -712,14 +712,14 @@ def build_parser_create(self, subparsers, common_parser, mid_common_parser):
There are two methods to read from stdin. Either specify ``-`` as path and
pipe directly to borg::

backup-vm --id myvm --stdout | borg create REPO::ARCHIVE -
backup-vm --id myvm --stdout | borg create --repo /path/to/repo ARCHIVE -
Copy link
Member

Choose a reason for hiding this comment

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

is there a reason why you changed REPO to /path/to/repo?

Copy link
Member

Choose a reason for hiding this comment

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

did you see my comment?


Or use ``--content-from-command`` to have Borg manage the execution of the
command and piping. If you do so, the first PATH argument is interpreted
as command to execute and any further arguments are treated as arguments
to the command::

borg create --content-from-command REPO::ARCHIVE -- backup-vm --id myvm --stdout
borg create --content-from-command --repo /path/to/repo ARCHIVE -- backup-vm --id myvm --stdout
Copy link
Member

Choose a reason for hiding this comment

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

same here.

Copy link
Member

Choose a reason for hiding this comment

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

did you see my comment?

@ThomasWaldmann ThomasWaldmann changed the title Documentation: python commands updated to new repo structure docs: borg commands updated with --repo option Mar 3, 2025
@vancheese
Copy link
Author

Dumbness re not being able to read comments in code resolved ... sorry for the inconvience

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