From: nwmcsween@gmail.com
To: "musl@lists.openwall.com" <musl@lists.openwall.com>
Subject: Re: New docs outline
Date: Thu, 15 Nov 2012 14:38:37 -0800 [thread overview]
Message-ID: <99507C20-19E2-4A14-BD5F-3ECC61A79BF8@gmail.com> (raw)
In-Reply-To: <20121115222004.GA29041@brightrain.aerifal.cx>
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@aerifal.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
next prev parent reply other threads:[~2012-11-15 22:38 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-11-15 22:20 Rich Felker
2012-11-15 22:38 ` nwmcsween [this message]
2012-11-15 23:36 ` Rich Felker
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=99507C20-19E2-4A14-BD5F-3ECC61A79BF8@gmail.com \
--to=nwmcsween@gmail.com \
--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).