Project

General

Profile

Bug #4607

t_bind man page should list the members of netbuf struct before explaining them

Added by Sachidananda Urs over 6 years ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
-
Start date:
2014-02-16
Due date:
% Done:

0%

Estimated time:
Difficulty:
Medium
Tags:
needs-triage
Gerrit CR:

Description

t_bind(3nsl) explains the members of struct netbuf without listing them. Which is quite confusing.

Last paragraph in page 1 of the manual states:

The parameter req  is  used  to  request  that  an  address,
represented  by  the netbuf structure, be bound to the given
transport endpoint. The parameter len specifies  the  number
of  bytes  in  the  address,  and  buf points to the address
buffer. The parameter maxlen has  no  meaning  for  the  req
argument.

While reading the manual, the origins of len, buf, and maxlen are quite confusing.

We should list the netbuf structure in the manual before mentioning about len, buf, and maxlen

struct netbuf {
        unsigned int maxlen;
        unsigned int len;
#if defined(_XPG5)
        void *buf;
#else
        char *buf;
#endif
};

Also available in: Atom PDF