save-entropy.sh: Add manual page

[fernape]

Summary

PR: 223998
Reported by: AJ Jordan <[e-mail]>

Test Plan

• Apply patch
• cd libexec/save-entropy && make
• man ./save-entropy.sh.8
• mandoc -T lint, igor and vale outputs clean

[lwhsu]

It is better to put in section 8 and named as save-entropy.8 as it's installed as /usr/libexec/save-entropy ?

[fernape]

• Move to section 8 as suggested by lwhsu

[carlavilla]

Thanks for adding this!

[lwhsu]

I also suggested that trim the .sh suffix as it's installed as /usr/libexec/save-entropy.

[fernape]

• s/save-entropy.sh/save-entropy/
  
  We drop the .sh at install time.

[fernape]

In D41768#951995, @lwhsu wrote:

I also suggested that trim the .sh suffix as it's installed as /usr/libexec/save-entropy.

Sorry, I just realized after updating the review.

[lwhsu]

libexec/save-entropy/save-entropy.sh.8

2 ↗

(On Diff #127049)

Now we use BSD-2-Clause

Ref: rG4d846d260e2b9a3d4d0a701462568268cbfe7a5b

[fernape]

libexec/save-entropy/save-entropy.sh.8

2 ↗

(On Diff #127049)

I wasn't aware of that. We have a mix of things in src regarding to license.
Before I change that, is it sufficient with the SPDX identifier?
We have files with the identifier plus the verbatim text of the license, other with only the identifier...

[lwhsu]

libexec/save-entropy/save-entropy.sh.8

2 ↗

(On Diff #127049)

I think at least you need your name in the copyright announcement. For this kind of single file as a whole, I would say providing the verbatim is fine. Just be sure you copy-pasted from the correct template.

[fernape]

• Change SPDX ID

[fernape]

libexec/save-entropy/save-entropy.sh.8

2 ↗

(On Diff #127049)

I think at least you need your name in the copyright announcement. For this kind of single file as a whole, I would say providing the verbatim is fine. Just be sure you copy-pasted from the correct template.

Thanks.

I change the SPDX ID. The text was already that from the 2-Clause BSD License as copied from https://opensource.org/license/bsd-2-clause/

[lwhsu]

libexec/save-entropy/save-entropy.8

43

how about putting a period symbol to the end of the sentence:

.Pa /dev/random .

45

how about s/typically/by default/ ?

57

A period symbol to the end of the sentence?

.Xr cron 8 .

82

Not sure if we want to add

.Xr rc.conf 5 ,

as entropy_s* also described there.

[fernape]

Address feedback:

• Rewording
• Add full stops where needed
• Add Xr to rc.conf
• Use macro for standard exit status

[lwhsu]

Thanks very much!

BTW, as a doc committer, you don't actually need src committer's approval to commit to manual pages in the src repository.

[fernape]

In D41768#952244, @lwhsu wrote:

Thanks very much!

Thank you!

BTW, as a doc committer, you don't actually need src committer's approval to commit to manual pages in the src repository.

I know, but it is always good to have an extra pair of eyes. The final version is much better than the first one.

[delphij]

It's probably worth mentioning that the script will not do anything in a jail (because it doesn't provide much value).

libexec/save-entropy/save-entropy.8

33

Nit: these are used for "startup" (rc(8)); boot-time entropy file (loader.conf(8) entropy_cache_load and entropy_cache_name) are only updated one time at startup and not touched by save-entropy.

42

43

53

Minor nit: Technically entropy_dir is used by /etc/rc.d/random too, so we should probably say:

Specify the directory for saved entropy files.

[pauamma_gundo.com]

libexec/save-entropy/save-entropy.8

41

Why "files" here when the previous line mentions a single file? (If "files" is correct as hinted later on, perhaps "Several files may be saved to in successive invocations; all are used...")

[delphij]

libexec/save-entropy/save-entropy.8

41

Why "files" here when the previous line mentions a single file? (If "files" is correct as hinted later on, perhaps "Several files may be saved to in successive invocations; all are used...")

It should be "files" and the line above should probably say "to a specified location" instead.

[fernape]

• save-entropy: Add manual page
• Address feedback.

[fernape]

Thank you for all the feedback.

libexec/save-entropy/save-entropy.8

53

I also noted that this is a shared setting.

[delphij]

Thank you

[fernape]

Thank you all for the review.