Project

General

Profile

Bug #4237

net_* and hook_* man pages are wrong

Added by Robert Mustacchi about 7 years ago. Updated about 7 years ago.

Status:
Resolved
Priority:
Low
Category:
manpage - manual pages
Start date:
2013-10-18
Due date:
% Done:

100%

Estimated time:
Difficulty:
Medium
Tags:
Gerrit CR:

Description

This ticket covers issues with the following manual pages:

  • net_hook_register
  • net_protocol_lookup
  • net_protcol_release
  • net_instance_alloc
  • hook_t
  • net_instance_t

All of these manual pages doesn't match the reality of the function. Specifically it may have the incorrect number of arguments and wrong types.

net_instance_alloc specifies the wrong variable to use for a version.

The hook_t doesn't mention the important semantics of the return value of the h_func. Okay, really there is no documentation for it, except kind of gleamed from an example on opensolaris.org and the source code.

net_instance_t needs to mention that it is illegal for nin_create to return NULL.

#1

Updated by Robert Mustacchi about 7 years ago

  • Status changed from New to Resolved
  • % Done changed from 90 to 100

Resolved in fe77cc0407fb667ddc04e1a8f2e203bb7b9c80e1.

Also available in: Atom PDF