Re: utimensat (man-pages-2.61 is released)

[Michael Kerrisk]

> On Jul 8 2007 09:30, Michael Kerrisk wrote:
> >> On Jul 7 2007 18:26, Michael Kerrisk wrote:
> >> >
> >> >I recently released man-pages-2.61.
> >> 
> >> utimensat() was introduced in Linux 2.6.22-rc1.
> >
> >Yes, I am aware.
> >
> >> I am kindly hinting that it does not yet have a manpage yet :)
> >
> >Such a hint is a good idea.  But strangely, you send it to me,
> >rather than the author of the system call.  Why is that?
> 
> Related manpages (futimesat(2)) does not list an author.
> So I were to guess who wrote it: you, or Ulrich, or a contributor.

An author of which -- the man page itself, or the system call?
Looking at the source of almost any page in man-pages certainly
shows the author of the page.  In the case of the futimesat(2)
man page: yes, I was the author.

So yes, I sometimes write pages for system calls that were 
written by others.  But this suffers serious limitations:

* Many people are changing the kernel-userland API; leaving me
  to write the documentation does not scale well.  (To begin
  with there is the problem: how can I even tell what has
  changed in a new release?  But here I must thank Andrew,
  who helps a bit by forwarding me things he notices.)

* I am fallible: I sometimes make mistakes of understanding
  when interpreting other people's code.

* Even when I do not make mistakes, when I write a man page by
  reading someone else's code, all I am doing is interpreting.
  The implementation may not match the (code) author's
  intention (aka a bug).  I may just be accurately documented
  buggy behaviour, or accurately describing design mistakes.
  (Yes, sometimes I'm smart enough to recognize the bugs and
  call them, but that is far from guaranteed.)

Cheers,

Michael

-- 
Michael Kerrisk
maintainer of Linux man pages Sections 2, 3, 4, 5, and 7 

Want to help with man page maintenance?  
Grab the latest tarball at
http://www.kernel.org/pub/linux/docs/manpages , 
read the HOWTOHELP file and grep the source 
files for 'FIXME'.

-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/