Configuration doc errors #689

New Issue

Closed

opened 2023-05-04 13:19:09 +00:00 by Hofer-Julian · 4 comments

Hofer-Julian commented 2023-05-04 13:19:09 +00:00

Copy Link

While browsing through the configuration docs, I think I've spotted two errors.
https://torsion.org/borgmatic/docs/reference/configuration/

1. consistency.checks gives as example - name: repository. This should be repository, right?
2. The indentation in consistency.checks.frequency looks wrong to me.

While browsing through the configuration docs, I think I've spotted two errors. https://torsion.org/borgmatic/docs/reference/configuration/ 1. `consistency.checks` gives as example `- name: repository`. This should be `repository`, right? 2. The indentation in `consistency.checks.frequency` looks wrong to me.

Hofer-Julian commented 2023-05-04 13:27:03 +00:00

Author

Copy Link

Mmmh, I think I've understood now what the docs mean.

You are supposed to write it like this if you want multiple checks, right?

consistency:
    checks:
        - name: repository
        - name: archives

Mmmh, I think I've understood now what the docs mean. You are supposed to write it like this if you want multiple checks, right? ```yaml consistency: checks: - name: repository - name: archives ```

witten commented 2023-05-04 15:59:19 +00:00

Owner

Copy Link

You are supposed to write it like this if you want multiple checks, right?

That's correct! More details here: https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#consistency-check-configuration and https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#check-frequency

That shows the expected indentation for frequency as well.

> You are supposed to write it like this if you want multiple checks, right? That's correct! More details here: https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#consistency-check-configuration and https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#check-frequency That shows the expected indentation for `frequency` as well.

witten added the

question / support

label 2023-05-04 15:59:26 +00:00

Hofer-Julian commented 2023-05-04 17:35:21 +00:00

Author

Copy Link

Makes sense.

Also, great job with the tool in general, already a happy user for years :)

Makes sense. Also, great job with the tool in general, already a happy user for years :)

Hofer-Julian closed this issue 2023-05-04 17:35:21 +00:00

witten commented 2023-05-04 17:37:25 +00:00

Owner

Copy Link

Glad to hear it!

Glad to hear it!

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

No description provided.