Re: [PATCH] getdirentries: Add a simple example rather than just referencing

[Nicholas Mc Guire <der.herr-kA1LtwSENNE@public.gmane.org>]

On Fri, Dec 11, 2015 at 07:52:27PM +0100, Michael Kerrisk (man-pages) wrote:
> Hello Nicholas,
> 
> On 11/10/2015 12:13 PM, Nicholas Mc Guire wrote:
> > The manpage of getdirentries basically just repeats the limited information
> > from dirent.h and does not explain the content of the returned buffer.
> 
> Agreed that an example in the page would be helpful.
> 
> > Further it refers the reader to "the Linux library source code for details", 
> > which is not really that helpful - a simple example including the need to
> > check available fields, and showing that the returned buffer contains 
> > struct direntries would simplify things.
> 
> There's a number of problems with the example program, starting with
> 
> $ cc -Wall  h.c
> h.c: In function ?main?:
> h.c:31:17: warning: format ?%llu? expects argument of type ?long long unsigned int?, but argument 3 has type ?int? [-Wformat=]
>                  );
> 
> Also, the program won't compile at all if _DIRENT_HAVE_D_TYPE happens 
> to be undefined.
> 
> There's also a rendering issue for the code when placed into a man page:
> the backslashes must be doubled (e.g., "\\n")
>
thanks for the feedback - looks like this needs some rework - will go 
fix things up and try a second - hopefully more useful version.

thx!
hofrat
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html