> 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. I didn't realize that there was anything in the README about the hierarchy, but I don't see how it is obsolete. There are lots of missing details of course, but I don't see how what's there is wrong.
> 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. Heh. True. > 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. I guess my problem is that I don't know what is on the wiki and I actually find it a pain to edit. (It turns out that there is support for offline editing and even a wikipedia-mode.el file). It's got a bunch of unlinked pages that aren't easy to find and nobody has taken the time to create some sort of logical hierarchy and a table of contents. That said, I'll try harder. > 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... Sounds reasonable. When I'm done with my current changes, I'll figure out if there is a wiki article that describes the hierarchy, remove what's in the current README, and add a link to the wiki article. Nate _______________________________________________ m5-dev mailing list [email protected] http://m5sim.org/mailman/listinfo/m5-dev
