-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On 07/10/2005 08:27 PM, Daniel Drake wrote:
> As you know, I've been meaning to write one of these for a while. I've been > keeping a list of topics I think should be mentioned. Stripping out the ones > you have covered, here's what I have left: > > maintainer-needed description > maintainer-wanted description These two are there, but kinda obscure. They need to be more prominent. As for the rest of the points you've brought up, did you have time to pen down answers as well? If so, could we have a look at them please? Some answers are obvious, but some others aren't and these points are quite valid and do need to be in the doc. > Since the doc is already covering a lot of content, and adding some of these > points to it will broaden it further, I think it makes sense to have 2 docs. > One for "how to report a bug", and another for "how to give us lots of yummy > info" in a bug report. > > Something like: > > How to report a bug: > - Search, check that nobody has filed it already > - Fill in the form under the right product > - How to get "emerge info" output > - General policy stuff: > - If attaching, use plain text and never tarballs > - Don't reassign bugs, leave that to devs > - Don't close just because you have workarounds > - What to do if your bug isnt getting attention > - maintainer-needed/wanted description > etc.... > > How to give us lots of yummy info: > - How to apply patches > - How to use strace > - How to identify a configure failure > - and how to upload config.log > - How to use gdb, for C apps > - Using valgrind? > etc.... Yeah, I guess that's the way the doc will go now. I'll have a word with Chris before we start splitting the doc. Other docs-team people had a similar opinion as well, so I guess it's only a matter of time before we end up having the above format. > It could also be used as a reference thing, e.g. on a kernel bug, I'll say > "please try this patch", user says "how?", it would be nice if i could point > them to a specific page on the tech doc. Very valid point. Thanks for the inputs Daniel! :) Regards, - -- Shyam Mani | <[EMAIL PROTECTED]> docs-team | http://gdp.gentoo.org GPG Key | 0xFDD0E345 -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.1 (GNU/Linux) iD8DBQFC0YGFYZNYgP3Q40URAsACAJ9q3nWpqaJlTvAXUHIQq0iuSKuqRQCeN3cn Apy9mAtQymYDYRXGy/kkMQY= =SBEp -----END PGP SIGNATURE----- -- gentoo-dev@gentoo.org mailing list
