[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Date: Thu, 15 Nov 2012 14:38:37 -0800
From: nwmcsween@...il.com
To: "musl@...ts.openwall.com" <musl@...ts.openwall.com>
Subject: Re: New docs outline
I would really like a set coding style, currently musl utilizes whatever whomever decided to write at the time, usually for pedantic things such as parens around sizeof, spacing around operators, etc. I also wouldn't mind Linux style function documentation.
On Nov 15, 2012, at 2:20 PM, Rich Felker <dalias@...ifal.cx> wrote:
> 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
Powered by blists - more mailing lists
Confused about mailing lists and their use?
Read about mailing lists on Wikipedia
and check out these
guidelines on proper formatting of your messages.
