Paul Armstrong wrote: >>>> I put the first draft from Paul on genunix, so we can >>>> work on it together and at least fill in the links he suggests. >>>> >>>> >> http://www.genunix.org/wiki/index.php/Developer_HOWTO >> >>> Cool. Thank you. I've made a couple of updates from tonight's searches >>> (although I suspect there are better links than the ones I've put in). >>> >>> >> You bet, I'll try to do some more with on those definitions this week if >> we hear back form the ARC on difference between PSARC >> and ARC, etc. >> > > I've updated it with the comments from John and Lisa (temporary holding area, > should be added to some glossary really) as well as a few other links I came > across. > > Two other questions that're relevant to this doc and came up as I was writing > a man page for a new command tonight: > * Where do docs link in? > * What should I do with small unit tests like the one I wrote for my new > binary? > > The docs consolidation is separate from OS/Net so it doesn't look like I can > check in my man page with the c file and Makefile. The testing consolidation > looks like it has similar issues (actually, it looks like there's no support > for minor, localized unit tests at all but I could just be overlooking it). > > I'm kind of in limbo as far as requesting a sponsor until my contributor > number arrives, but I'm happy to work on documenting the process before then. > > Paul > > > This message posted from opensolaris.org > _______________________________________________ > docs-discuss mailing list > docs-discuss at opensolaris.org > Hi Paul,
Thanks for continuing to work on this new procedure and a new man page--you rock. Just as FYI, we have some man page templates here, so you'll know what sections to include (or not). http://opensolaris.org/os/community/documentation/doc_collab/manpageguide/ Can you give me more specific information about your first question above? You ask 'where do docs link in', but I need more information to understand what you're trying to do, what kind of docs, etc. I copy Jim Walker here for your unit test question, he is a leader of the Testing Community and can help us with your minor/localized/unit test questions. You are right, the man page consolidation is separate from ON, (you say docs consolidation above, but that does not include man pages, so I assume that you mean to say man page consolidation. Assuming my assumptions are correct :) then, a man page associated with new ON code would go into the man page consolidation. Man pages associated with code outside of ON have their own package in some cases, or might be put back into the code consolidation with the c and makefile. For example, Sun Cluster data services man pages in the OHAC consolidation, are co-located with the agent code because it makes sense to do so with a set of modular agents where you have a 1:1 mapping between a man page and an agent. For ON, there is no such 1:1 mapping and the scale is 1000X greater, so we centralize the man pages and manage/maintain them all together. Hope this helps, thanks again for your time to work on this and for helping us to learn how to teach. Regards, Michelle
