mailing list of musl libc
 help / color / mirror / code / Atom feed
From: Rich Felker <dalias@aerifal.cx>
To: musl@lists.openwall.com
Subject: Re: Request for volunteers
Date: Sun, 30 Jun 2013 08:13:45 -0400	[thread overview]
Message-ID: <20130630121345.GR29800@brightrain.aerifal.cx> (raw)
In-Reply-To: <CAPLrYEQnRfCK_EHocfs-wCheVc9c3jM-wNUg=sXSn3SwmJ-cFQ@mail.gmail.com>

On Sun, Jun 30, 2013 at 01:02:03PM +0200, Daniel Cegiełka wrote:
> Rich, you missed something:
> 
> 6. Man pages for musl. We need to describe the functions and
> namespaces in header files.

This is a good topic for discussion. My documentation goal for 1.0 has
been aligned with the earlier docs outline proposal I sent to the list
a while back. Full man pages would be a much bigger task, and it's not
even something a volunteer could do without some major collaboration
with people who have a detailed understanding of every function in
musl. (Sadly, wrong man pages are probably worse than no man pages.)

What might be better for the near future is to get the POSIX man pages
project updated to match POSIX-2008+TC1 so that users of musl who want
man pages for libc functions can install them and have them match the
current version. Separate man pages could then be made for nonstandard
functions or functions that require significant implementation
specific documentation, possibly based on the Linux man pages project,
but with glibc-specific information just removed (for functions that
are predominantly kernel-level) or changed (where documenting musl
semantics matters).

Rich


  reply	other threads:[~2013-06-30 12:13 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-06-30  5:52 Rich Felker
2013-06-30 10:48 ` Szabolcs Nagy
2013-07-01  3:51   ` Rich Felker
2013-07-01 20:58     ` Szabolcs Nagy
2013-07-01 23:59       ` Rich Felker
2013-07-02  2:19         ` Szabolcs Nagy
2013-07-02  7:49           ` Rich Felker
2013-07-16 16:20             ` Szabolcs Nagy
2013-07-17 15:41               ` Rich Felker
2013-06-30 11:02 ` Daniel Cegiełka
2013-06-30 12:13   ` Rich Felker [this message]
2013-06-30 22:29     ` idunham
2013-07-01  3:31       ` Rich Felker
2013-07-01 17:42         ` Isaac
2013-07-01 17:46           ` Alex Caudill
2013-07-01 21:12           ` Isaac
2013-07-01  3:13     ` Rob Landley
2013-07-01  3:43       ` Rich Felker
2013-06-30 15:25 ` Nathan McSween
2013-06-30 22:59   ` Luca Barbato
2013-07-01 11:42 ` LM
2013-07-04 18:05 ` Rob Landley
2013-07-08  7:40   ` Szabolcs Nagy
2013-07-09  2:14     ` Rob Landley
2013-07-09  2:57       ` Matthew Fernandez
2013-07-08 14:45   ` Rich Felker
2013-07-09  2:54     ` Rich Felker
2013-07-08 14:12 ` Anthony G. Basile
2013-07-01 17:44 Felix Janda
2013-07-02  1:08 ` Michael Kerrisk (man-pages)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20130630121345.GR29800@brightrain.aerifal.cx \
    --to=dalias@aerifal.cx \
    --cc=musl@lists.openwall.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.vuxu.org/mirror/musl/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).