From mboxrd@z Thu Jan  1 00:00:00 1970
X-Msuck: nntp://news.gmane.org/gmane.linux.lib.musl.general/2280
Path: news.gmane.org!not-for-mail
From: Rich Felker <dalias@aerifal.cx>
Newsgroups: gmane.linux.lib.musl.general
Subject: New docs outline
Date: Thu, 15 Nov 2012 17:20:04 -0500
Message-ID: <20121115222004.GA29041@brightrain.aerifal.cx>
Reply-To: musl@lists.openwall.com
NNTP-Posting-Host: plane.gmane.org
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
X-Trace: ger.gmane.org 1353018016 8222 80.91.229.3 (15 Nov 2012 22:20:16 GMT)
X-Complaints-To: usenet@ger.gmane.org
NNTP-Posting-Date: Thu, 15 Nov 2012 22:20:16 +0000 (UTC)
To: musl@lists.openwall.com
Original-X-From: musl-return-2281-gllmg-musl=m.gmane.org@lists.openwall.com Thu Nov 15 23:20:27 2012
Return-path: <musl-return-2281-gllmg-musl=m.gmane.org@lists.openwall.com>
Envelope-to: gllmg-musl@plane.gmane.org
Original-Received: from mother.openwall.net ([195.42.179.200])
	by plane.gmane.org with smtp (Exim 4.69)
	(envelope-from <musl-return-2281-gllmg-musl=m.gmane.org@lists.openwall.com>)
	id 1TZ7nO-0000g6-TX
	for gllmg-musl@plane.gmane.org; Thu, 15 Nov 2012 23:20:27 +0100
Original-Received: (qmail 23894 invoked by uid 550); 15 Nov 2012 22:20:16 -0000
Mailing-List: contact musl-help@lists.openwall.com; run by ezmlm
Precedence: bulk
List-Post: <mailto:musl@lists.openwall.com>
List-Help: <mailto:musl-help@lists.openwall.com>
List-Unsubscribe: <mailto:musl-unsubscribe@lists.openwall.com>
List-Subscribe: <mailto:musl-subscribe@lists.openwall.com>
Original-Received: (qmail 23886 invoked from network); 15 Nov 2012 22:20:16 -0000
Content-Disposition: inline
User-Agent: Mutt/1.5.21 (2010-09-15)
Xref: news.gmane.org gmane.linux.lib.musl.general:2280
Archived-At: <http://permalink.gmane.org/gmane.linux.lib.musl.general/2280>

This is just a rough draft of an outline for the nice documentation
I'd eventually like to have for musl. Sending it to the list as a way
to make sure it doesn't get forgotten, and as a way of bouncing around
ideas on it..

1. Introduction and scope
2. Conformance statements
3. Supported systems
4. Build and installation
5. Installed components
   A. Dynamic linking runtime
   B. Development files
6. Filesystem layout dependencies
   ... required and optional directories/devices/mounts/files ....
7. Basic (developer) usage information.
8. Implementation-defined behavior
9. Further documented behavior guarantees
10. Coding style
11. Source tree layout
12. Implementation internals (malloc, pthread, stdio, etc.)
13. Porting