Page MenuHomeFreeBSD
Differential D25631

periodic script to create backup of gmirror information
ClosedPublic
Actions

Authored by rew on Jul 12 2020, 3:45 AM.
Tags
None
Referenced Files
Unknown Object (File)
Sat, Dec 21, 8:22 AM
Unknown Object (File)
Sat, Dec 21, 8:01 AM
Unknown Object (File)
Sat, Dec 21, 6:13 AM
Unknown Object (File)
Thu, Dec 5, 6:28 AM
Unknown Object (File)
Tue, Dec 3, 8:01 PM
Unknown Object (File)
Nov 18 2024, 1:16 PM
Unknown Object (File)
Nov 12 2024, 9:40 AM
Unknown Object (File)
Nov 12 2024, 6:30 AM
View All Files
Subscribers
bcr
gbe
imp

Details

Reviewers
allanjude
0mp
kevans
Group Reviewers
manpages
Commits
rS367443: Add a periodic script to backup output generated from `gmirror list`.
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

Lint
Lint Passed
Unit
No Test Coverage
Build Status
Buildable 32267
Build 29757: arc lint + arc unit

Event Timeline

rew requested review of this revision.Jul 12 2020, 3:45 AM
rew created this revision.
Harbormaster completed remote builds in B32267: Diff 74344.Jul 12 2020, 3:45 AM
rew added reviewers: allanjude, 0mp.Jul 12 2020, 3:58 AM
rew edited the summary of this revision. (Show Details)
rew removed a subscriber: allanjude.
rew updated this revision to Diff 74432.Jul 14 2020, 9:55 AM

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.

Harbormaster completed remote builds in B32314: Diff 74432.Jul 14 2020, 9:55 AM
rew updated this revision to Diff 75412.Aug 5 2020, 7:49 AM

clarify new variables in periodic.conf(5).

re-worded comments

Herald added a reviewer: manpages. · View Herald TranscriptAug 5 2020, 7:49 AM
Herald added a subscriber: imp. · View Herald Transcript
Harbormaster completed remote builds in B32766: Diff 75412.Aug 5 2020, 7:50 AM
rew added a reviewer: kevans.Aug 5 2020, 7:51 AM
bcr added a subscriber: bcr.Aug 5 2020, 10:34 AM
bcr added inline comments.
share/man/man5/periodic.conf.5
270

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

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
0mp added inline comments.Aug 5 2020, 11:09 AM
usr.sbin/periodic/periodic.conf
86

Typo

rew updated this revision to Diff 75433.Aug 5 2020, 5:00 PM

Updating D25631: periodic script to create backup of gmirror information

fix typos per 0mp

rewrite sentence to remove "you" per bcr

Harbormaster completed remote builds in B32774: Diff 75433.Aug 5 2020, 5:00 PM
rew added inline comments.Aug 5 2020, 5:10 PM
share/man/man5/periodic.conf.5
264

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
0mp added inline comments.Aug 5 2020, 6:06 PM
share/man/man5/periodic.conf.5
264

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

rew updated this revision to Diff 75445.Aug 5 2020, 7:33 PM

Updating D25631: periodic script to create backup of gmirror information

use mdoc macros for literal code per 0mp

Harbormaster completed remote builds in B32781: Diff 75445.Aug 5 2020, 7:33 PM
rew marked 2 inline comments as done.Aug 5 2020, 7:35 PM
allanjude accepted this revision.Aug 18 2020, 1:28 PM

Approved By: allanjude (mentor)

rew mentioned this in D25638: Add periodic script to backup zfs and zpool information.Oct 4 2020, 7:17 PM
gbe accepted this revision as: manpages.Oct 8 2020, 2:55 PM
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.Nov 7 2020, 4:15 AM
Closed by commit rS367443: Add a periodic script to backup output generated from `gmirror list`. (authored by rew). · Explain Why
This revision was automatically updated to reflect the committed changes.
rew added a commit: rS367443: Add a periodic script to backup output generated from `gmirror list`..
gbe mentioned this in rS368514: MFC r367436 and r367443 by rew:.Dec 10 2020, 1:26 PM

Revision Contents
Changeset List

PathSize
share/
man/
man5/
11 lines
usr.sbin/
periodic/
etc/
daily/
74 lines
6 lines

Diff 74344

View Options

share/man/man5/periodic.conf.5

Loading...
View Options

usr.sbin/periodic/etc/daily/222.backup-gmirror

Loading...
View Options

usr.sbin/periodic/periodic.conf

Loading...