linux-raid.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: NeilBrown <neilb@suse.de>
To: Roberto Spadim <roberto@spadim.com.br>
Cc: Linux-RAID <linux-raid@vger.kernel.org>
Subject: Re: documentation
Date: Tue, 1 Feb 2011 08:58:51 +1100	[thread overview]
Message-ID: <20110201085851.2b665f1a@notabene.brown> (raw)
In-Reply-To: <AANLkTindmhPU3Lazk33XPaS_Pw7AL52LXKeXAML6F3Y=@mail.gmail.com>

On Mon, 31 Jan 2011 19:39:03 -0200 Roberto Spadim <roberto@spadim.com.br>
wrote:

> hi guys, where´s the official documentation page (wiki)? is it at
> linux kernel source code? or at a wikipedia or another wiki page?
> i found this:
> http://www.linuxfoundation.org/collaborate/workgroups/linux-raid
> at wikipedia
> and some documentation inside kernel source code
> what´s the most updated (official)?
> 

"official" has always struck me as a rather strange term in this sort of
context.  It implies that there is an 'office' which the 'official' holds.
I wonder what this 'office' is....

However to be useful instead of philosophical:

 - the source code is the definitive documentation.  However few people can
   read it very well.
 - the man pages in the mdadm package are the formal documentation that I am
   most likely to update in anything close to a timely manner.  In particular
     man 4 md
   is worth a read.
 - An archive of this mailing line (linux-raid) is likely to be the best
   informal source of documentation.  It contains lots of valuable
   information, but of course is not structured very well.
 - https://linux-raid.wiki.kernel.org/ is a community-maintained wiki which
   should be reasonably reliable. (that is the same location as the link that
   you found above).
 - the doco in the kernel (Documentation/md.txt) is hardly ever updated and so
   is probably badly out of date.  Sorry.
 - As has been mentioned, http://neil.brown.name/blog/mdadm and 
   http://neil.brown.name/blog/SoftRaid sometimes contain useful information
   but I don't write as often as I would like to.
 - This is a Book: Managing RAID on Linux
     http://oreilly.com/catalog/9781565927308/index.html?CMP=IL7015
   however it is now about 8 years old, so it will be missing a lot of new
   stuff.

Hope that helps,
NeilBrown
--
To unsubscribe from this list: send the line "unsubscribe linux-raid" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

  parent reply	other threads:[~2011-01-31 21:58 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2011-01-31 21:39 documentation Roberto Spadim
2011-01-31 21:43 ` documentation Mathias Burén
2011-01-31 21:58 ` NeilBrown [this message]
2011-01-31 22:14   ` documentation Roberto Spadim
2011-02-01  9:37     ` documentation hansbkk
2011-02-01 13:49       ` documentation Roberto Spadim

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=20110201085851.2b665f1a@notabene.brown \
    --to=neilb@suse.de \
    --cc=linux-raid@vger.kernel.org \
    --cc=roberto@spadim.com.br \
    /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.
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).