> > > Suppose that someone wants to integrate some code and in the process of > > developing it some documentation is also produced. Currently there is > > no good place to stick this documentation in the source tree. What do > > you think about having usr/doc subtree for such documentation? > > Assuming the documentation is not intended for users of the end-product > (which should be in manpages and docs.sun.com books, of course), I'd > prefer the documentation live next to the source, in the same directory. > Having them side-by-side makes it more likely that they will be kept > in-sync. We do this in numerous places -- e.g.: > > usr/src/lib/README.Makefiles > usr/src/cmd/cmd-inet/sbin/dhcpagent/README
It works if the code is localized, but what if the implementation spreads a whole bunch of places? Also, while we have README precedents, there are no other types of docs we may have (project-related white papers, design notes, etc). -- akolb _______________________________________________ opensolaris-code mailing list [email protected] http://mail.opensolaris.org/mailman/listinfo/opensolaris-code
