Page MenuHomeFreeBSD

x86: Create manpage for mca subsystem
AcceptedPublic

Authored by jtl on Sun, Dec 7, 10:43 PM.
Tags
None
Referenced Files
Unknown Object (File)
Sun, Dec 28, 5:36 AM
Unknown Object (File)
Thu, Dec 25, 11:19 PM
Unknown Object (File)
Sat, Dec 20, 12:26 AM
Unknown Object (File)
Fri, Dec 19, 9:40 AM
Unknown Object (File)
Thu, Dec 18, 10:05 AM
Unknown Object (File)
Thu, Dec 18, 8:43 AM
Unknown Object (File)
Wed, Dec 17, 8:42 PM
Unknown Object (File)
Sun, Dec 14, 5:46 AM
Subscribers

Details

Reviewers
markj
jhb
Summary

Create a manpage for the mca subsystem.

Sponsored by: Netflix

Diff Detail

Repository
rG FreeBSD src repository
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

jtl requested review of this revision.Sun, Dec 7, 10:43 PM
share/man/man4/mca.4
6

We no longer need to write this, see

https://docs.freebsd.org/en/articles/license-guide/

28

We dropped i386. You're not going to back port this, right? Thus this is only for amd64?

Updated license and clarified this is only applicable to amd64 in main.

jtl marked 2 inline comments as done.Mon, Dec 8, 3:49 PM
jtl added inline comments.
share/man/man4/mca.4
6

Thanks! I've updated the license text.

28

I updated this to amd64. I may actually backport this, but I can modify it as part of the MFC. There may be other changes which are needed as part of any MFC.

Thanks for writing this.

I wonder how to make the page more discoverable. I'd think we should have platform-specific man pages which describe platform features, so amd64.4 could link to mca.4, pkru.3, etc.. But that's a larger project of course.

share/man/man4/mca.4
21
32

Should we mention the syslog facility/level?

This revision is now accepted and ready to land.Sun, Dec 14, 4:14 PM
share/man/man4/mca.4
32

I would perhaps say "the system log" rather than "Syslog".

64–66

This language will probably read less stale in the more distant future.

67
78

You don't have to, but if you would find it more readable, you could create a table with columns instead of a tagged list. See for example bhyve_config(5) which uses separate columns for the default value and description. siginfo(3) is another manual page that uses a .Bl -column.

In this case I could imagine a column for the name, one for if the sysctl is writable (Y/N), one for the default value, and the last for the description.

101

I don't know that Haswell needs to be quoted here?

266

Maybe Xr syslogd(8) here?

Not sure if it's worth adding a mention of mcelog in ports? (I'm not convinced mcelog is very useful)