Sample cron job should have --verbosity 1 #826

New Issue

Closed

opened 2024-02-09 01:21:29 +00:00 by jstraceski · 3 comments

jstraceski commented 2024-02-09 01:21:29 +00:00

Copy Link

What I'm trying to do and why

The borgmatic cron job has --verbosity -1 when I believe that it should be --verbosity 1 (without the dash).

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 The [borgmatic](https://projects.torsion.org/borgmatic-collective/borgmatic/src/branch/main/sample/cron/borgmatic) cron job has `--verbosity -1` when I believe that it should be `--verbosity 1` (without the dash). ### 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 commented 2024-02-09 02:11:42 +00:00

Owner

Copy Link

Thanks for filing this. I believe that the -1 verbosity is actually intentional. Here's the commit message when that change was made:

Author: Jeffery To
Date:   Tue Dec 8 17:13:23 2020 +0800

    Reduce console output in sample crontab/systemd service files.
    
    As borgmatic will log to syslog in the sample crontab/systemd service
    files, this makes console output redundant. (cron will mail any console
    output to the root user; systemd will log any console output to syslog.)
    
    This adds --verbosity -1 to both files to reduce console output to the
    minimum.

If you have reason to believe this is incorrect, please let me know. Thanks!

Thanks for filing this. I believe that the `-1` verbosity is actually intentional. Here's the commit message when that change was made: ``` Author: Jeffery To Date: Tue Dec 8 17:13:23 2020 +0800 Reduce console output in sample crontab/systemd service files. As borgmatic will log to syslog in the sample crontab/systemd service files, this makes console output redundant. (cron will mail any console output to the root user; systemd will log any console output to syslog.) This adds --verbosity -1 to both files to reduce console output to the minimum. ``` If you have reason to believe this is incorrect, please let me know. Thanks!

witten added the

question / support

label 2024-02-09 02:12:00 +00:00

jstraceski commented 2024-02-09 17:10:01 +00:00

Author

Copy Link

Ah ok, I see, that makes a lot of sense. I realize now that when I had searched through the man entry for borgmatic for the -1 value I had actually been looking though the sudo man entry. I guess a follow up question would be if man is supposed to work for borgmatic in general, I see that the --help command is implemented here (https://torsion.org/borgmatic/docs/reference/command-line/). But regardless, thanks for the explanation!

Ah ok, I see, that makes a lot of sense. I realize now that when I had searched through the man entry for borgmatic for the `-1` value I had actually been looking though the sudo man entry. I guess a follow up question would be if man is supposed to work for borgmatic in general, I see that the --help command is implemented here (https://torsion.org/borgmatic/docs/reference/command-line/). But regardless, thanks for the explanation!

witten commented 2024-02-09 17:45:27 +00:00

Owner

Copy Link

The borgmatic project does not include man pages, as --help and online documentation are the canonical sources of information. In theory, man pages could be included, but ideally I'd want them to be auto-generated from command-line arguments (the same way --help output is) so that docs don't have to be maintained in multiple places.

I'll close this for now, but please feel free to file another ticket if you encounter any other issues (documentation or otherwise).

The borgmatic project does not include man pages, as `--help` and online documentation are the canonical sources of information. In theory, man pages _could_ be included, but ideally I'd want them to be auto-generated from command-line arguments (the same way `--help` output is) so that docs don't have to be maintained in multiple places. I'll close this for now, but please feel free to file another ticket if you encounter any other issues (documentation or otherwise).

witten closed this issue 2024-02-09 17:45:27 +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#826

No description provided.