[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: PROPOSAL: complete list of documentation files, "man <packagename>", all man pages refer to said doc list in "See Also" section



I'll start with the main problem I'm having, then post on others when I
think of them :)

Joey, you state that referring to /usr/doc is *enough*. I would only agree
if the files in there were enough to document the package! Lots of packages
only put little more than a copyright notice; Kirrily's troubles hinted at
the problems I see which are more than what she experienced.

The reason I made this proposal is because there exist packages which
don't put enough documentation in. If you want, I can find them all
and file documentation bugs against them. (what severity would that
end up being? Important?) I expect enough documentation to use the
package. As a maintainer and potential non-maintainer uploader, I
expect references to any docs the maintainer used in the building of
the package. If a maintainer would rather refer to outside sources,
fine, as long as he/she does so. Specifically, if a maintainer used a
source to learn about a package and how to install and/or use it, then
that maintainer is aware of a source of info. I want a reference to
that.

I understand the logistics might be problematic in my original proposal
so I'm open to other ways of accomplishing the above.

-Jim

---
Jim Lynch       Finger for pgp key
as Laney College CIS admin:  jim@laney.edu   http://www.laney.edu/~jim/
as Debian developer:         jwl@debian.org  http://www.debian.org/~jwl/



Reply to: