Document missing libgeom functions
ClosedPublic
Actions

Authored by romain on Oct 15 2017, 7:30 AM.

Details

Reviewers

mav
bjk
allanjude

Group Reviewers

manpages

Commits

rS324667: Add a quick description of the geom_getxml(3), geom_xml2tree(3),

Summary

Add a quick description of the geom_getxml(3), geom_xml2tree(3),
geom_gettree(3) and geom_deletetree(3) functions provided by libgeom and are
not documented in libgeom(3).

Diff Detail

Repository

rS FreeBSD src repository - subversion

Lint

Lint Not Applicable

Unit

Tests Not Applicable

Event Timeline

romain created this revision.Oct 15 2017, 7:30 AM

Herald added a reviewer: manpages. · View Herald TranscriptOct 15 2017, 7:30 AM

Herald added a subscriber: imp. · View Herald Transcript

A few line breaks are needed after sentence stops. You can use textproc/igor to check for this and other common man page errors.
Additionally, you need to bump the .Dd to the current date as this is a content change.
Thanks for adding these descriptions.

lib/libgeom/libgeom.3
299 ↗	(On Diff #34001)	You need to make a line break after a sentence stop.
310 ↗	(On Diff #34001)	Another line break is needed here.
321 ↗	(On Diff #34001)	An another line break here.

Add missing line breaks, update date and fix a typo found by igor(1).

These issues are now fixed, thank you for spotting them.

igor(1) still reports the following:

libgeom.3:299:contraction:OID, and returns [it's] value.

I guess it's a false positive?

Not sure about this, a native speaker can probably clear this up.

bjk added a subscriber: bjk.Oct 16 2017, 12:36 AM

bjk added inline comments.

lib/libgeom/libgeom.3
308 ↗	(On Diff #34007)	"a bunch of" is a little more colloquial than we average in man pages; "allocates the needed data structures" might be better. Also, "fills in" does not need a hyphen.
330 ↗	(On Diff #34007)	Either "The .Fn geom_deletetree function" or just ".Fn geom_deletetree", but not halfway in between.