Page MenuHomeFreeBSD

periodic script to create backup of gmirror information
ClosedPublic

Authored by rew on Jul 12 2020, 3:45 AM.

Details

Summary

Added a periodic script to create backups of information for any gmirrors (i.e. the output from gmirror list).

Documented the variables 'daily_backup_gmirror_enable' and 'daily_backup_gmirror_verbose' in periodic.conf(5).

The default for these two new variables have been set to "NO" in the default periodic.conf.

Fixed a comment for 'daily_backup_gpart_verbose' from previous diff review.

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=86388

Diff Detail

Repository
rS FreeBSD src repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

rew requested review of this revision.Jul 12 2020, 3:45 AM
rew created this revision.
rew edited the summary of this revision. (Show Details)
rew removed a subscriber: allanjude.

Install the new 222.backup-gmirror periodic script.

Changed exit code from 3 (output that must not be masked) -> 2 (invalid configuration)
when backups are enabled but no gmirrors are present.

clarify new variables in periodic.conf(5).

re-worded comments

bcr added inline comments.
share/man/man5/periodic.conf.5
270 ↗(On Diff #75412)

We discourage the use of "you" in documentation. I think this sentence is easy to rewrite:
"... when the diff output ... to be reported in the daily output."

0mp requested changes to this revision.Aug 5 2020, 11:08 AM
0mp added inline comments.
share/man/man5/periodic.conf.5
264 ↗(On Diff #75412)

It's better to use mdoc macros instead of backticks for literal code.

This revision now requires changes to proceed.Aug 5 2020, 11:08 AM
usr.sbin/periodic/periodic.conf
86 ↗(On Diff #75412)

Typo

Updating D25631: periodic script to create backup of gmirror information

fix typos per 0mp

rewrite sentence to remove "you" per bcr

share/man/man5/periodic.conf.5
264 ↗(On Diff #75412)

According to style.mdoc(5), the preferred style is '.Dq Li' for literal shell commands (as you've shown).

In periodic.conf(5), the stylized shell commands use the mdoc macros with the following format '.Nm gmirror Cm list'.

Should we use mdoc macros that are consistent with the rest of periodic.conf(5) using '.Nm $COMMAND Cm $SUBCOMMAND' or follow style.mdoc(5)?

rew marked 2 inline comments as done.Aug 5 2020, 5:14 PM
share/man/man5/periodic.conf.5
264 ↗(On Diff #75412)

Please keep it consistent with the rest of the manual then. Thank you :)

Updating D25631: periodic script to create backup of gmirror information

use mdoc macros for literal code per 0mp

rew marked 2 inline comments as done.Aug 5 2020, 7:35 PM

Approved By: allanjude (mentor)

gbe added a subscriber: gbe.

LGTM, since all previous comments regarding man page issues are addressed.

This revision was not accepted when it landed; it landed in state Needs Review.Sat, Nov 7, 4:15 AM
This revision was automatically updated to reflect the committed changes.