Misleading arg name: borgmatic prune --files runs borg prune --list #571

New Issue

Closed

opened 2022-08-09 08:55:24 +00:00 by real-or-random · 6 comments

real-or-random commented 2022-08-09 08:55:24 +00:00

Copy Link

What I'm trying to do and why

borg prune has a --list argument that makes borg show the list of pruned/kept archives, see https://borgbackup.readthedocs.io/en/1.1.18/usage/prune.html. This is very helpful together with --dry-run, after modifying the "keep" rules.

Steps to reproduce (if a bug)

borgmatic prune --list

Actual behavior (if a bug)

borgmatic runs action "prune" and "list"

Expected behavior (if a bug)

borgmatic passes --list option to borg
(Well, let's call it "preferred" behavior instead.)

Other notes / implementation ideas

This is tough. Maybe it's finally time to drop the old -- actions, maybe for Borg 2.

Workaround:

extra_borg_options:
    prune: --list

One could probably even use --override but yeah, it's not elegant.

#### What I'm trying to do and why borg prune has a `--list` argument that makes borg show the list of pruned/kept archives, see https://borgbackup.readthedocs.io/en/1.1.18/usage/prune.html. This is very helpful together with `--dry-run`, after modifying the "keep" rules. #### Steps to reproduce (if a bug) `borgmatic prune --list` #### Actual behavior (if a bug) borgmatic runs action "prune" and "list" #### Expected behavior (if a bug) borgmatic passes `--list` option to borg (Well, let's call it "preferred" behavior instead.) #### Other notes / implementation ideas This is tough. Maybe it's finally time to drop the old `--` actions, maybe for Borg 2. Workaround: ``` extra_borg_options: prune: --list ``` One could probably even use `--override` but yeah, it's not elegant.

real-or-random commented 2022-08-09 12:44:57 +00:00

Author

Copy Link

Just noticed that borg create has also --list but apparently we cover this via verbosity. Related: #195

Ah no, so borgmatic create --files results in borg --list.

According to the code in https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/master/borgmatic/borg/prune.py#L64 , the same works for prune but calling it --files` doesn't make a lot of sense here.

It's very confusing.

Maybe it's finally time to drop the old -- actions, maybe for Borg 2.

I tend to believe that this is the cleanest approach.

Just noticed that `borg create` has also `--list` but apparently we cover this via verbosity. Related: https://projects.torsion.org/borgmatic-collective/borgmatic/issues/195 Ah no, so `borgmatic create --files` results in `borg --list`. According to the code in https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/master/borgmatic/borg/prune.py#L64 , the same works for prune but calling it --files` doesn't make a lot of sense here. It's very confusing. > Maybe it's finally time to drop the old -- actions, maybe for Borg 2. I tend to believe that this is the cleanest approach.

real-or-random changed title from No way to run `borg prune --list` to Misleading arg name: `borgmatic prune --files` runs `borg prune --list` 2022-08-09 13:06:53 +00:00

witten commented 2022-08-09 22:53:34 +00:00

Owner

Copy Link

Okay, so just to make sure I understand, you've identified at least two potential problems with borgmatic's current behavior:

1.--list is an alias for the borgmatic list action rather than actually passing --list to Borg, which is unexpected.
2. You don't want to use --files but would rather use --list.

The first point, I totally get. The UX principle of least surprise and everything.

On point 2, the intent with --files is that (for create), it does more than just --list, it also passes a --filter argument to Borg so that it doesn't show all file types by default.

So is that behavior you don't want/expect? Or is it more that you expect borgmatic to support all/most Borg parameters? It certainly doesn't in all cases, although I guess you could make an argument this is one that should be supported.

Maybe it's finally time to drop the old -- actions, maybe for Borg 2

I'd be open to that, although borgmatic won't necessarily need to make breaking changes to support Borg 2. Related: #557.

Okay, so just to make sure I understand, you've identified at least two potential problems with borgmatic's current behavior: 1.`--list` is an alias for the `borgmatic list` action rather than actually passing `--list` to Borg, which is unexpected. 2. You don't want to use `--files` but would rather use `--list`. The first point, I totally get. The UX principle of least surprise and everything. On point 2, the intent with `--files` is that (for `create`), it does *more* than just `--list`, it also passes a `--filter` argument to Borg so that it doesn't show all file types by default. So is that behavior you don't want/expect? Or is it more that you expect borgmatic to support all/most Borg parameters? It certainly doesn't in all cases, although I guess you could make an argument this is one that should be supported. > Maybe it's finally time to drop the old -- actions, maybe for Borg 2 I'd be open to that, although borgmatic won't _necessarily_ need to make breaking changes to support Borg 2. Related: #557.

real-or-random commented 2022-08-10 10:11:08 +00:00

Author

Copy Link

On point 2, the intent with --files is that (for create), it does more than just --list, it also passes a --filter argument to Borg so that it doesn't show all file types by default.

Ah no, I think you're misunderstanding my point 2. --files totally makes sense for create.

However, not only create accepts --files but also prune. And this is a way to invoke borg prune --list (at least from looking at the code, I haven't tried it). But this is nonsense. borg prune --list lists archives, not files.

It certainly doesn't in all cases, although I guess you could make an argument this is one that should be supported.

Yes, I think this would be nice to have yes, it's indepedent of the two points I raise here.

> On point 2, the intent with `--files` is that (for `create`), it does *more* than just `--list`, it also passes a `--filter` argument to Borg so that it doesn't show all file types by default. > Ah no, I think you're misunderstanding my point 2. `--files` totally makes sense *for `create`*. However, not only `create` accepts `--files` but also `prune`. And this is a way to invoke `borg prune --list` (at least from looking at the code, I haven't tried it). But this is nonsense. `borg prune --list` lists archives, not files. > It certainly doesn't in all cases, although I guess you could make an argument this is one that should be supported. Yes, I think this would be nice to have yes, it's indepedent of the two points I raise here.

witten referenced this issue from a commit 2022-08-21 21:26:56 +00:00

Drop only-style actions like "--create", rename "prune --files" to "prune --list", and add "--list" alias to "create" and "export-tar" (#571).

witten commented 2022-08-21 21:29:40 +00:00

Owner

Copy Link

Done in master and will be part of the next release. Here are the changes:

• BREAKING: Remove old-style command-line action flags like "--create, "--list", etc.
• BREAKING: Rename "--files" flag on "prune" action to "--list".
• Add "--list" as alias for "--files" flag on "create" and "export-tar" actions.

Thanks for suggesting this!

Done in master and will be part of the next release. Here are the changes: * BREAKING: Remove old-style command-line action flags like "--create, "--list", etc. * BREAKING: Rename "--files" flag on "prune" action to "--list". * Add "--list" as alias for "--files" flag on "create" and "export-tar" actions. Thanks for suggesting this!

witten closed this issue 2022-08-21 21:29:40 +00:00

witten commented 2022-08-22 05:00:03 +00:00

Owner

Copy Link

Just released in borgmatic 1.7.0!

Just released in borgmatic 1.7.0!

real-or-random commented 2022-08-22 08:52:11 +00:00

Author

Copy Link

Awesome, thanks! Let's hope it won't break too many old configs. ;)

Awesome, thanks! Let's hope it won't break too many old configs. ;)

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

command-hook-steps

2.0.11

2.0.10

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.9.14

1.9.13

1.9.12

1.9.11

1.9.10

1.9.9

1.9.8

1.9.7

1.9.6

1.9.5

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.14

1.8.13

1.8.12

1.8.11

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

blocked

breaking

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

No Label

Milestone

No items

No Milestone

Assignees

Clear assignees

witten

No Assignees

2 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#571