documentation

documentation

am 31.01.2011 22:39:03 von Roberto Spadim

hi guys, where=B4s 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=B4s the most updated (official)?

--=20
Roberto Spadim
Spadim Technology / SPAEmpresarial
--
To unsubscribe from this list: send the line "unsubscribe linux-raid" i=
n
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html

Re: documentation

am 31.01.2011 22:43:07 von mathias.buren

On 31 January 2011 21:39, Roberto Spadim wrote:
> hi guys, where´s the official documentation page (wiki)? is it a=
t
> 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)?
>
> --
> Roberto Spadim
> Spadim Technology / SPAEmpresarial
> --
> 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.ht=
ml
>

http://neil.brown.name/blog/mdadm has info.

// Mathias
--
To unsubscribe from this list: send the line "unsubscribe linux-raid" i=
n
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html

Re: documentation

am 31.01.2011 22:58:51 von NeilBrown

On Mon, 31 Jan 2011 19:39:03 -0200 Roberto Spadim r>
wrote:

> hi guys, where=B4s 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=B4s the most updated (official)?
>=20

"official" has always struck me as a rather strange term in this sort o=
f
context. It implies that there is an 'office' which the 'official' hol=
ds.
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 part=
icular
man 4 md
is worth a read.
- An archive of this mailing line (linux-raid) is likely to be the bes=
t
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 w=
hich
should be reasonably reliable. (that is the same location as the lin=
k 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=20
http://neil.brown.name/blog/SoftRaid sometimes contain useful inform=
ation
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=3DIL 7015
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" i=
n
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html

Re: documentation

am 31.01.2011 23:14:12 von Roberto Spadim

nice =3D]
could we put these information at
(Documentation/md.txt) i didn=B4t read yet, but could we put there?
hehehe if i don=B4t have linux-raid@vger.kernel.org as a maillist i
would read from there first, after wikipedia, and after try google...
i think documentation at source code level is nice, a documentattion
(.txt file) at linux source code, maybe is good, maybe not... maybe in
future everythink is at wikipedia or kernel documentation or stay at
txt file, the point is, a easy to find place (if only have source
code: md.txt, if have internet google or wikipedia or yahoo or another
search system)
thanks neil!

2011/1/31 NeilBrown :
> On Mon, 31 Jan 2011 19:39:03 -0200 Roberto Spadim br>
> wrote:
>
>> hi guys, where=B4s 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=B4s the most updated (official)?
>>
>
> "official" has always struck me as a rather strange term in this sort=
of
> context. =A0It implies that there is an 'office' which the 'official'=
holds.
> I wonder what this 'office' is....
>
> However to be useful instead of philosophical:
>
> =A0- the source code is the definitive documentation. =A0However few =
people can
> =A0 read it very well.
> =A0- the man pages in the mdadm package are the formal documentation =
that I am
> =A0 most likely to update in anything close to a timely manner. =A0In=
particular
> =A0 =A0 man 4 md
> =A0 is worth a read.
> =A0- An archive of this mailing line (linux-raid) is likely to be the=
best
> =A0 informal source of documentation. =A0It contains lots of valuable
> =A0 information, but of course is not structured very well.
> =A0- https://linux-raid.wiki.kernel.org/ is a community-maintained wi=
ki which
> =A0 should be reasonably reliable. (that is the same location as the =
link that
> =A0 you found above).
> =A0- the doco in the kernel (Documentation/md.txt) is hardly ever upd=
ated and so
> =A0 is probably badly out of date. =A0Sorry.
> =A0- As has been mentioned, http://neil.brown.name/blog/mdadm and
> =A0 http://neil.brown.name/blog/SoftRaid sometimes contain useful inf=
ormation
> =A0 but I don't write as often as I would like to.
> =A0- This is a Book: Managing RAID on Linux
> =A0 =A0 http://oreilly.com/catalog/9781565927308/index.html?CMP=3DIL 7=
015
> =A0 however it is now about 8 years old, so it will be missing a lot =
of new
> =A0 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 =A0http://vger.kernel.org/majordomo-info.html
>



--=20
Roberto Spadim
Spadim Technology / SPAEmpresarial
--
To unsubscribe from this list: send the line "unsubscribe linux-raid" i=
n
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html

Re: documentation

am 01.02.2011 10:37:26 von hansBKK

For others googling later, there's also good user-level intro
information in SLES and RHEL's doc sets

http://www.google.com/search?q=raid+site%3Adocs.redhat.com
http://www.google.com/search?q=raid+site%3Awww.novell.com%2F documentation

Re the concept of "official" in the concept of open-source, to me it
means the docs maintained by those who "own" the project.

Otherwise, there is often a "canonical" central location maintained by
the community, which although perhaps not complete nor kept up to date
should at least point to the more authoritative sources for those
learning about the topic.

My two cents: I for one would vote for http://raid.wiki.kernel.org/ as
this, and since Neil's time is better spent coding than updating
user-level docs, those of us that would like to see better-maintained
documentation should dig in and help create it. Of course whatever
Neil can find the time to add at dev-tech levels is invaluable, and
should at least be pointed to by the "official" wiki.
--
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

Re: documentation

am 01.02.2011 14:49:43 von Roberto Spadim

nice! my vote to raid.wiki.kernel.org
there=B4s links on wikipedia to it? linux source code documentation?

2011/2/1 :
> For others googling later, there's also good user-level intro
> information in SLES and RHEL's doc sets
>
> http://www.google.com/search?q=3Draid+site%3Adocs.redhat.com
> http://www.google.com/search?q=3Draid+site%3Awww.novell.com% 2Fdocumen=
tation
>
> Re the concept of "official" in the concept of open-source, to me it
> means the docs maintained by those who "own" the project.
>
> Otherwise, there is often a "canonical" central location maintained b=
y
> the community, which although perhaps not complete nor kept up to dat=
e
> should at least point to the more authoritative sources for those
> learning about the topic.
>
> My two cents: I for one would vote for http://raid.wiki.kernel.org/ a=
s
> this, and since Neil's time is better spent coding than updating
> user-level docs, those of us that would like to see better-maintained
> documentation should dig in and help create it. Of course whatever
> Neil can find the time to add at dev-tech levels is invaluable, and
> should at least be pointed to by the "official" wiki.
> --
> 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 =A0http://vger.kernel.org/majordomo-info.html
>



--=20
Roberto Spadim
Spadim Technology / SPAEmpresarial
--
To unsubscribe from this list: send the line "unsubscribe linux-raid" i=
n
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html