Page MenuHomeFreeBSD
Differential D16765

Improve formatting of efidev(4)
ClosedPublic
Actions

Authored by 0mp on Aug 17 2018, 11:41 AM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Nov 15, 1:57 AM
Unknown Object (File)
Wed, Nov 6, 11:32 AM
Unknown Object (File)
Fri, Nov 1, 5:24 PM
Unknown Object (File)
Fri, Nov 1, 5:24 PM
Unknown Object (File)
Fri, Nov 1, 5:24 PM
Unknown Object (File)
Fri, Nov 1, 5:24 PM
Unknown Object (File)
Fri, Nov 1, 5:03 PM
Unknown Object (File)
Mon, Oct 28, 1:53 PM
View All 50 Files
Subscribers
imp
krion
mat

Details

Reviewers
bcr
kevans
mat
krion
Group Reviewers
manpages
Commits
rS338121: efidev.4: Improve formatting.
Summary

Changes:

  • Move some information out of the SYNOPSIS section because it is formated in a broken way by mandoc(1) otherwise.
  • Improve the formatting of the list of provided ioctls.
  • Use "Fa" for struct fields.
  • Pet mandoc and igor.

Also:

  • It looks like efirt(9) is missing.
  • /dev/efi does not have a description in the FILES section altough a -tags list is used.
Test Plan

igor & mandoc: OK

Diff Detail

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

Event Timeline

0mp created this revision.Aug 17 2018, 11:41 AM
Herald added a reviewer: manpages. · View Herald TranscriptAug 17 2018, 11:41 AM
Herald added a subscriber: imp. · View Herald Transcript
Harbormaster completed remote builds in B18888: Diff 46830.Aug 17 2018, 11:41 AM
kevans added a comment.Aug 17 2018, 12:06 PM

Can you define "missing"? =9 I had to double check, but I did seem to commit both the Makefile bits and the page itself- https://svnweb.freebsd.org/base/head/share/man/man9/efirt.9

share/man/man4/efidev.4
67 ↗(On Diff #46830)

I think this looks kinda goofy if we maintain how I had it in SYNOPSIS, perhaps better if the two paragraphs were joined in a way that feels less redundant.

111 ↗(On Diff #46830)

Typo in both your version and mine, should read data

0mp updated this revision to Diff 46834.Aug 17 2018, 12:51 PM
  • Fix a typo (s/aata/data)
  • Reword the part about disabling the driver via a tunable and put it into the SYNOPSIS section. Avoid the Nm macro, which causes funny formatting issues.
  • Move the note about the CPU architecture limitations to the BUGS section, which is defined as a section for limitations (according to mdoc(7)).
Harbormaster completed remote builds in B18891: Diff 46834.Aug 17 2018, 12:51 PM
0mp marked an inline comment as done.Aug 17 2018, 12:53 PM

Oh I see now! Sorry, I wasn't looking in the right place for the efirt manpage.

kevans accepted this revision.Aug 17 2018, 2:23 PM
This revision is now accepted and ready to land.Aug 17 2018, 2:23 PM
0mp requested review of this revision.Aug 20 2018, 8:26 PM
0mp added reviewers: mat, krion.
0mp added subscribers: krion, mat.

Thanks for reviewing those changes, @kevans!

@mat, @krion, it looks like everything is fine. May I ask you for an approval to commit?

mat accepted this revision.Aug 20 2018, 8:56 PM
This revision is now accepted and ready to land.Aug 20 2018, 8:56 PM
Closed by commit rS338121: efidev.4: Improve formatting. (authored by 0mp). · Explain WhyAug 20 2018, 10:16 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
head/
share/
man/
man4/
28 lines

Diff 47006

View Options

head/share/man/man4/efidev.4

Loading...