Misleading help in prune #808

New Issue

Closed

opened 2024-01-03 11:16:46 +00:00 by debuglevel · 1 comment

debuglevel commented 2024-01-03 11:16:46 +00:00

Contributor

Copy Link

What I'm trying to do and why

I just stumbled upon this help:

# borgmatic prune --help
usage: borgmatic prune [--repository REPOSITORY] [--stats] [--list] [--oldest TIMESPAN] [--newest TIMESPAN] [--older TIMESPAN] [--newer TIMESPAN] [-h]

Prune archives according to the retention policy (with Borg 1.2+, run compact afterwards to actually free space)
                                                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

I thought this action would automatically run compact afterwards, but when I looked into the source it does not seem to do that. Now I think this is just a hint, that the user should run compact afterwards to actually free space.

It might be a good idea to remove or change this hint; e.g. "with Borg 1.2+, you have to run compact afterwards to actually free space". As I'm not a native speaker, I better refrain from submitting a pull request ;-).

Steps to reproduce

No response

Actual behavior

No response

Expected behavior

No response

Other notes / implementation ideas

No response

borgmatic version

No response

borgmatic installation method

No response

Borg version

No response

Python version

No response

Database version (if applicable)

No response

Operating system and version

No response

### What I'm trying to do and why I just stumbled upon this help: ``` # borgmatic prune --help usage: borgmatic prune [--repository REPOSITORY] [--stats] [--list] [--oldest TIMESPAN] [--newest TIMESPAN] [--older TIMESPAN] [--newer TIMESPAN] [-h] Prune archives according to the retention policy (with Borg 1.2+, run compact afterwards to actually free space) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``` I thought this action would automatically run `compact` afterwards, but when I looked into the source it does not seem to do that. Now I think this is just a hint, that the *user* should `run compact afterwards to actually free space`. It might be a good idea to remove or change this hint; e.g. "with Borg 1.2+, *you have to* run compact afterwards to actually free space". As I'm not a native speaker, I better refrain from submitting a pull request ;-). ### Steps to reproduce _No response_ ### Actual behavior _No response_ ### Expected behavior _No response_ ### Other notes / implementation ideas _No response_ ### borgmatic version _No response_ ### borgmatic installation method _No response_ ### Borg version _No response_ ### Python version _No response_ ### Database version (if applicable) _No response_ ### Operating system and version _No response_

witten referenced this issue from a commit 2024-01-03 18:04:45 +00:00

Clarify prune action help concerning running compact afterwards (#808).

witten commented 2024-01-03 18:05:41 +00:00

Owner

Copy Link

Thanks for taking the time to file this. I've modified the help to hopefully clarify this point so that the next user won't be tripped up by this important detail!

Thanks for taking the time to file this. I've modified the help to hopefully clarify this point so that the next user won't be tripped up by this important detail!

witten closed this issue 2024-01-03 18:05:41 +00:00

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

spot-check

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.16

1.5.15

1.5.14

1.5.13

1.5.12

1.5.11

1.5.10

1.5.9

1.5.8

1.5.7

1.5.7.dev0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.22

1.4.21

1.4.20

1.4.19

1.4.18

1.4.17

1.4.16

1.4.15

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Labels

Clear labels   

bug

  

data loss

  

design finalized

  

good first issue

  

new feature area

  

question / support

  

security

  

waiting for response

No Label

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

Milestone

Clear milestone

No items

No Milestone

Assignees

Clear assignees

No Assignees

2 Participants

Notifications

Subscribe

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#808

No description provided.