On Wed, Apr 18, 2012 at 11:45:45PM -0400, Lawrence Teo wrote: > The inet(3) man page has always been rather difficult to read for > me, primarily because the order of the inet_* functions in the > DESCRIPTION section is not the same as their order in SYNOPSIS. > > In addition, the descriptions of various functions are grouped > together in large paragraphs, making it hard to look up a specific > function. For example, the description of inet_pton() is sandwiched > deep within the first large paragraph that also describes three > other functions. > > To address these issues, this diff: > > - reorganizes the SYNOPSIS and DESCRIPTION sections so that their > order is in sync; > > - separates the description of each function into its own paragraph > for readability (where possible); > > - moves the contents of the DIAGNOSTICS section to the description > of inet_addr() and inet_network(), because that information is > more useful there; and > > - lists the functions according to their logical meaning, e.g. > inet_aton(), inet_addr(), inet_network(), and inet_pton() are > listed together as a group because these functions are related to > converting a character string to its Internet address / network > number. >
to be honest, DIAGNOSTICS should probably have been a RETURN VALUES section. but there is other return value stuff mixed into the text, so i've accepted its removal. but properly there should probably be such a section. anyway i agree your diff is an improvement and have committed it. thanks! jmc
