Page MenuHomeFreeBSD

Document missing libgeom functions
ClosedPublic

Authored by romain on Oct 15 2017, 7:30 AM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Dec 27, 2:21 PM
Unknown Object (File)
Tue, Dec 24, 11:45 PM
Unknown Object (File)
Fri, Dec 20, 10:33 PM
Unknown Object (File)
Fri, Dec 20, 9:54 PM
Unknown Object (File)
Mon, Dec 2, 7:52 PM
Unknown Object (File)
Nov 8 2024, 2:56 PM
Unknown Object (File)
Oct 31 2024, 11:00 AM
Unknown Object (File)
Sep 30 2024, 10:16 AM

Details

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 Passed
Unit
No Test Coverage
Build Status
Buildable 12057
Build 12364: arc lint + arc unit

Event Timeline

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

You need to make a line break after a sentence stop.

310

Another line break is needed here.

321

An another line break here.

romain marked 3 inline comments as done.

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 inline comments.
lib/libgeom/libgeom.3
308

"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

Either "The .Fn geom_deletetree function" or just ".Fn geom_deletetree", but not halfway in between.

romain marked 2 inline comments as done.

Address issues spotted by @bjk

@bjk thank you for the feedback, this should be fixed now!

This revision is now accepted and ready to land.Oct 16 2017, 7:52 AM

Thanks for the update!

allanjude added a subscriber: allanjude.

Approved By: allanjude

This revision was automatically updated to reflect the committed changes.