Page MenuHomeFreeBSD

Add device_delete_children(9) manual page
Needs ReviewPublic

Authored by asmodai on Thu, Dec 6, 4:16 PM.

Details

Reviewers
None
Group Reviewers
Doc Committers
manpages
Summary

Add a device_delete_children(9) manual page based on the comments in code.

Diff Detail

Repository
rS FreeBSD src repository
Lint
Lint OK
Unit
No Unit Test Coverage
Build Status
Buildable 21539
Build 20847: arc lint + arc unit

Event Timeline

asmodai created this revision.Thu, Dec 6, 4:16 PM
imp added inline comments.Thu, Dec 6, 7:25 PM
share/man/man9/device_delete_children.9
50

Do we need to document the error codes?

yuripv added a subscriber: yuripv.Sat, Dec 8, 9:04 PM
yuripv added inline comments.
share/man/man9/device_delete_children.9
37

(here and below) I'm not a native speaker so could very wrong.. Shouldn't this read "child devices" instead?

42

Add double quotes around device_t dev.

44

It's usually written as the following even if there's only one function discussed.

The
.Fn device_delete_children
function ...
asmodai updated this revision to Diff 51954.Thu, Dec 13, 3:14 PM

Address feedback from yuripv.

asmodai updated this revision to Diff 51955.Thu, Dec 13, 3:27 PM

Fix forgotten mention of children

asmodai marked 3 inline comments as done.Thu, Dec 13, 3:40 PM
asmodai added inline comments.
share/man/man9/device_delete_children.9
37

You are correct. I did some checking on various English grammar fora and it seems to be a mistaken use of children, indeed. You talk about "deleting the children from a device", but "deleting the child devices".

asmodai marked an inline comment as done and an inline comment as not done.Thu, Dec 13, 3:41 PM
asmodai updated this revision to Diff 51956.Thu, Dec 13, 3:42 PM

Clarify return values.

asmodai marked 3 inline comments as done.Thu, Dec 13, 3:44 PM
asmodai added inline comments.
share/man/man9/device_delete_children.9
50

@imp Hopefully this should clarify the return values.

asmodai updated this revision to Diff 51957.Thu, Dec 13, 3:47 PM
asmodai marked an inline comment as done.

Add Makefile entry back.