Page MenuHomeFreeBSD

Initial uefi(8) man page
ClosedPublic

Authored by emaste on Oct 17 2014, 3:12 AM.
Tags
None
Referenced Files
Unknown Object (File)
Tue, Jan 7, 3:18 PM
Unknown Object (File)
Dec 9 2024, 2:19 AM
Unknown Object (File)
Dec 7 2024, 3:32 AM
Unknown Object (File)
Dec 2 2024, 7:57 AM
Unknown Object (File)
Dec 2 2024, 7:57 AM
Unknown Object (File)
Dec 2 2024, 7:56 AM
Unknown Object (File)
Dec 2 2024, 7:56 AM
Unknown Object (File)
Dec 2 2024, 7:56 AM
Subscribers

Diff Detail

Repository
rS FreeBSD src repository - subversion
Lint
Lint Skipped
Unit
Tests Skipped

Event Timeline

emaste retitled this revision from to Initial uefi(8) man page.
emaste updated this object.
emaste edited the test plan for this revision. (Show Details)
emaste added a reviewer: Doc Committers.
brueffer added a reviewer: brueffer.
brueffer added a subscriber: brueffer.
brueffer added inline comments.
share/man/man8/uefi.8
44 ↗(On Diff #2013)

double "in"

48 ↗(On Diff #2013)

Further down only the "file system" spelling is used, so it should be consistent here.

61 ↗(On Diff #2013)

firmare -> firmware

82 ↗(On Diff #2013)

laods -> loads

101 ↗(On Diff #2013)

This should be something like the following:

[...]
for use by
.Xr bsdinstall 8
and the
.Ar bootcode
argument to
.Xr gpart 8 .

130 ↗(On Diff #2013)

The first sort key in SEE ALSO is section, then manpage name (and no period at the end):

.Sh SEE ALSO
.Xr vt 4 ,
.Xr msdosfs 5 ,
.Xr boot 8 ,
.Xr gpart 8

This revision now requires changes to proceed.Oct 17 2014, 7:58 AM
emaste edited edge metadata.

address review feedback from brueffer

brueffer edited edge metadata.
This revision is now accepted and ready to land.Oct 17 2014, 11:42 AM
emaste edited edge metadata.

connect uefi.8 to the build

emaste updated this revision to Diff 2016.

Closed by commit rS273218 (authored by @emaste).

textproc/igor checks for whitespace and spelling problems, among others. It is a good idea to run it on man pages and even plain text files before commit:
igor -R Makefile | less -RS
igor -R uefi.8 | less -RS

For man pages, it is also useful to run
mandoc -Tlint uefi.8

head/share/man/man8/Makefile
35

There is a bunch of trailing whitespace on this line.

head/share/man/man8/uefi.8
34

Trailing whitespace.

46

spelling: "parition"

103

Trailing whitespace.

head/share/man/man8/uefi.8
33

uefi.8:33:.Sh DESCRIPTION used here:but .Sh SYNOPSIS has not been defined

Presumably this can be ignored

113

Should this be renamed to BUGS (and moved to the end)?

This revision is now accepted and ready to land.Oct 17 2014, 2:52 PM

Move CAVEATS to end as suggested by mandoc -T lint

share/man/man8/uefi.8
133 ↗(On Diff #2021)

It seems mandoc -Tlint treats CAVEATS as BUGS

head/share/man/man8/uefi.8
33

Yes. A typical man page has a minimum set of eight sections in order. Man pages that do not apply to ordinary commands leave out the synopsis.

113

Kind of depends on how you look at it. "Bug" says "it is present but does not work correctly" while caveats could be warnings about differences from expectations or unimplemented things.

head/share/man/man8/uefi.8
113

Ok - these are legitimately CAVEATS I think. I was mainly confused by mandoc -Tlint's complaint about ordering, as mdoc(7) does not describe CAVEATS, but mandoc -Tlint seems to treat it as BUGS.

emaste updated this revision to Diff 2024.

Closed by commit rS273235 (authored by @emaste).