Page MenuHomeFreeBSD

Improve documentation of ${name}_limits and ${name}_login_class in rc.subr.8
ClosedPublic

Authored by 0mp on Apr 2 2018, 12:52 AM.
Referenced Files
Unknown Object (File)
Tue, Oct 7, 4:56 AM
Unknown Object (File)
Sun, Sep 28, 12:18 PM
Unknown Object (File)
Sat, Sep 20, 12:56 AM
Unknown Object (File)
Sep 8 2025, 11:51 PM
Unknown Object (File)
Sep 6 2025, 9:01 AM
Unknown Object (File)
Aug 3 2025, 7:01 AM
Unknown Object (File)
Jul 26 2025, 6:56 PM
Unknown Object (File)
Jul 15 2025, 1:17 AM

Details

Summary

Since the description of ${name}_limits did not mention anything about the default value I decided to improve it. Also, I documented the ${name}_login_class variable, which seems to be used by ${name}_limits only.

${name}_limits has been introduced in D14015.

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Thanks for writing missing documentation.

share/man/man8/rc.subr.8
590 ↗(On Diff #40976)

I know this is out of scope, strictly speaking, but referring to limits(1) twice is a bit ugly. The topmost reference can just be "Resource limits".

594 ↗(On Diff #40976)

This looks a bit strange comparing to the code in rc.subr which appends the _limits to -C _login_class. However, per the limits(1) man page, this is indeed how it works: manual resource specifications override a -C or -U setting. Resource limits from a login class can be tweaked by specifying -a.

I'm not sure this (-a) detail need be in the man page though.

599 ↗(On Diff #40976)

This should be .Li (or possibly .Dq Li) instead of .Em. The two .Em usages in the description of oomprotect below are also wrong.

@jilles Thank you for your feedback!

I've applied you suggestions. I did not change the description of the ${name}_limits mechanism, however. I don't know if we should include a note about the -a flag. Isn't the reference to limits(1) enough?

0mp marked 2 inline comments as done.Apr 2 2018, 10:33 PM
This revision is now accepted and ready to land.Apr 3 2018, 7:46 PM
This revision was automatically updated to reflect the committed changes.