Order of default actions? #873

New Issue

Open

opened 2024-05-22 21:57:23 +00:00 by sshaikh · 5 comments

sshaikh commented 2024-05-22 21:57:23 +00:00

Copy Link

What I'm trying to do and why

My reading of the docs is that in the absence of any verbs, borgmatic will: prune, compact, create and check. However, based on the hooks that execute, the actual order is: create, compact, prune, check.

Steps to reproduce

Run sudo borgmatic -c config.yaml with simple echos on the after_ hooks.

Actual behavior

No response

Expected behavior

No response

Other notes / implementation ideas

No response

borgmatic version

1.8.11

borgmatic installation method

pipx

Borg version

1.2.8

Python version

3.11.2

Database version (if applicable)

No response

Operating system and version

Debian GNU/Linux 12 (bookworm)

### What I'm trying to do and why My reading of the docs is that in the absence of any verbs, borgmatic will: prune, compact, create and check. However, based on the hooks that execute, the actual order is: create, compact, prune, check. ### Steps to reproduce Run `sudo borgmatic -c config.yaml` with simple `echo`s on the after_ hooks. ### Actual behavior _No response_ ### Expected behavior _No response_ ### Other notes / implementation ideas _No response_ ### borgmatic version 1.8.11 ### borgmatic installation method pipx ### Borg version 1.2.8 ### Python version 3.11.2 ### Database version (if applicable) _No response_ ### Operating system and version Debian GNU/Linux 12 (bookworm)

sshaikh commented 2024-05-22 22:01:46 +00:00

Author

Copy Link

setting verbosity to 1 seems to confirm the behavior.

setting verbosity to 1 seems to confirm the behavior.

sshaikh commented 2024-05-23 14:10:59 +00:00

Author

Copy Link

In the CLI reference I see this:

Simple, configuration-driven backup software for servers and workstations. If
no actions are given, then borgmatic defaults to: create, prune, compact, and
check.

Which is closer to what I see when running it, so perhaps this is a documentation issue (even though I think prune, compact, create, check is the most appropriate order, so maybe the solution here is to always be explicit).

In the CLI reference I see this: ``` Simple, configuration-driven backup software for servers and workstations. If no actions are given, then borgmatic defaults to: create, prune, compact, and check. ``` Which is closer to what I see when running it, so perhaps this is a documentation issue (even though I think prune, compact, create, check is the most appropriate order, so maybe the solution here is to always be explicit).

witten referenced this issue from a commit 2024-06-05 18:22:31 +00:00

Use (current) default action order whenever actions are mentioned (#873).

witten commented 2024-06-05 18:28:39 +00:00

Owner

Copy Link

Thanks for taking the time to file this! The default ordering is indeed create, prune, compact, check, but where in the docs are you seeing that the actual order is otherwise? There were a few cases where the actions happened to be listed in the non-default order in the docs (see the linked changeset), but I didn't find anywhere that outright said the default order is other than create, prune, compact, check. Of particular interest is the start of these docs.

Which is closer to what I see when running it, so perhaps this is a documentation issue (even though I think prune, compact, create, check is the most appropriate order, so maybe the solution here is to always be explicit).

That actually used to be the default order in older versions of borgmatic. See #304 for the details on why it was changed. But yeah, you can specify any order you like on the command-line.

Thanks for taking the time to file this! The default ordering is indeed `create`, `prune`, `compact`, `check`, but where in the docs are you seeing that the actual order is otherwise? There were a few cases where the actions happened to be listed in the non-default order in the docs (see the linked changeset), but I didn't find anywhere that outright said the default order is other than `create`, `prune`, `compact`, `check`. Of particular interest is the start of [these docs](https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#biggish-data). > Which is closer to what I see when running it, so perhaps this is a documentation issue (even though I think prune, compact, create, check is the most appropriate order, so maybe the solution here is to always be explicit). That actually used to be the default order in older versions of borgmatic. See #304 for the details on why it was changed. But yeah, you can specify any order you like on the command-line.

sshaikh commented 2024-06-05 18:52:06 +00:00

Author

Copy Link

I may have missed the "prior version" label in the below:

Prior to version 1.7.9 The default action ordering was prune, compact, create, and check.

That said, I still believe that the default I'm seeing is create, compact, prune, check but I'll see if I can confirm that.

I may have missed the "prior version" label in the below: ``` Prior to version 1.7.9 The default action ordering was prune, compact, create, and check. ``` That said, I still believe that the default I'm seeing is create, compact, prune, check but I'll see if I can confirm that.

witten commented 2024-06-05 19:00:19 +00:00

Owner

Copy Link

Hmm, yeah, let me know if you're somehow seeing that still.. ideally with logs! Here's the relevant code from main that applies the default ordering:

        for default_action_name in ('create', 'prune', 'compact', 'check'):

Hmm, yeah, let me know if you're somehow seeing that still.. ideally with logs! Here's the relevant code from `main` that applies the default ordering: ```python for default_action_name in ('create', 'prune', 'compact', 'check'): ```

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

spot-check

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   

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#873

No description provided.