We already have a README in the root directory that has yet another
obsolete description of the code hierarchy... maybe we could start by
fixing that.

Having documentation in the tree is helpful since then the description
can theoretically be kept in sync with the changing reality and
archived consistently via hg.  However so far that's just a
theoretical advantage, and unless we change our habits I don't see it
being an actual advantage.

Personally I think that having documentation in multiple places just
increases the number of versions that will get stale because we forget
to update them.  If we're only going to have one copy, the wiki seems
like the logical place to me.  One nice thing about the wiki is that
anywhere we're tempted to replicate the documentation (README files,
email responses, etc.) then we can just throw in the appropriate wiki
URL.

As far as Nate's original suggestion, I'd say we're better off putting
our energy into updating documentation than making modest
reorganizations to avoid that, or even having email discussions about
whether to do those reorganizations...

Steve
_______________________________________________
m5-dev mailing list
[email protected]
http://m5sim.org/mailman/listinfo/m5-dev

Reply via email to