Page MenuHomeFreeBSD

ctl.conf(5): fix LUN size in UCL format example.
ClosedPublic

Authored by rew on Oct 8 2020, 6:30 AM.
Tags
None
Referenced Files
Unknown Object (File)
Mar 22 2024, 5:07 PM
Unknown Object (File)
Mar 22 2024, 5:07 PM
Unknown Object (File)
Mar 22 2024, 11:39 AM
Unknown Object (File)
Mar 22 2024, 11:39 AM
Unknown Object (File)
Mar 22 2024, 11:39 AM
Unknown Object (File)
Mar 8 2024, 7:51 PM
Unknown Object (File)
Dec 22 2023, 10:17 PM
Unknown Object (File)
Dec 22 2023, 10:17 PM
Subscribers

Details

Summary

Remove quotes around size in the LUN section. The
UCL configuration is expecting a number here. Also, change
the suffix to 'Gb'. UCL format does recognize 'G' on its own,
but that uses a base 10 multiplier where 'Gb' uses a 2 power
multiplier.

Document the differences between valid suffixes when using
a configuration file in general syntax style or UCL format. The
valid suffixes for general syntax are those supported by expand_number(3),
those specifiers are K, M, G, T, P and E. The UCL format valid suffixes
are kKmMgG|b - for example, 4Gb is equivalent to 4gb.

Diff Detail

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

Event Timeline

rew requested review of this revision.Oct 8 2020, 6:30 AM
bcr added a subscriber: bcr.

OK from manpages. Remember to bump the .Dd when you commit this content change.

To me this looks very confusing, because I read Gb as gigabits, not gigabytes. Unless it is indeed gigabits for some reason, can we use more common GB suffix instead?

Updating D26716: ctl.conf(5): fix LUN size in UCL format example.

Yep, it appears libucl will handle the GB suffix all the same.

updated the example configuration file to use GB.

0mp requested changes to this revision.Oct 8 2020, 10:51 AM
0mp added a subscriber: 0mp.
0mp added inline comments.
usr.sbin/ctld/ctl.conf.5
430 ↗(On Diff #78010)

I am pretty sure we need spaces around comas here, otherwise comas are also bold.

433 ↗(On Diff #78010)

I think I'd remove Sy styling from |.

This revision now requires changes to proceed.Oct 8 2020, 10:51 AM
usr.sbin/ctld/ctl.conf.5
431 ↗(On Diff #78010)

Also, missing Oxford aka serial comma before or.

434 ↗(On Diff #78010)

Ditto (missing serial comma).

Updating D26716: ctl.conf(5): fix LUN size in UCL format example.

fix styling as suggested by 0mp

fix punctuation as noted by danfe

I haven't written or used the UCL code, but it makes sense to me.

This LGTM (with .Dd bump pre-commit, as mentioned).

Approved by: kevans (mentor)

This revision was not accepted when it landed; it landed in state Needs Review.Oct 13 2020, 6:00 PM
This revision was automatically updated to reflect the committed changes.