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

Re: Debian documentation

On Thu, Jun 20, 2002 at 04:59:14PM +0200, Josip Rodin wrote:
> On Thu, Jun 20, 2002 at 06:46:30AM -0700, Osamu Aoki wrote:
> > > > I think "Debian specific documents" needs to be better organized for
> > > > woody+1 in /usr/share/doc/DEBIAN/, just like HOWTO and RFC.
> > > 
> > > As long as you don't write Debian in all uppercase! :)
> > 
> > Use of /usr/share/doc/Debian/ is was alternative I wondered too. :)
> > 
> > Current /usr/share/doc/debian/ is so hard to find.
> It's only hard to find because we don't advertize it, other than in dpkg -L
> output.

Also some indexing tools are available too.

Especially with translation in each small package, there will be so many
scattered in systems for all similar documents.  Use of these packages in
Debian web page is much easier this way.

> Besides, it's no harder to find than "HOWTO" and "RFC" are. Nobody in their
> sane mind does a 'ls' in the doc directory, on most of today's systems, it's
> just too huge :)

Actually, if you are dummy Linux user like me, I use "mc" to browse
/usr/share/doc/ and capitalized subdirectories come as the first listings if 
under default sorting order. :)

I think many newbie will learn system by reading these directory like me :)

> > Also each package
> > which install document into /usr/share/doc/Debian/ should contain some
> > README file in their /usr/share/doc/<packagename>/ to point user to the
> > document.
> > 
> > Come to think of it, I wonder why there is no "filelist" in each
> > /usr/share/doc/<packagename>/ which lists not only obvious but ones
> > created by the install scripts.
> Not sure what you mean by that last paragraph, but now that I think about
> it, I should make a symlink /usr/share/doc-debian/debian -> ../debian

dpkg -L only list obvious files created by the package.  Some postinst
scripts create/move files in the system.  If these effects are
documented outside of postinst script, it will be nice.

Your suggestion is good one too.  These may be separate issue.

I would do something like:
/usr/share/doc-debian/Debian -> ../Debian
/usr/share/debian-reference/Debian -> ../Debian/debian-reference

~\^o^/~~~ ~\^.^/~~~ ~\^*^/~~~ ~\^_^/~~~ ~\^+^/~~~ ~\^:^/~~~ ~\^v^/~~~ +++++
 Osamu Aoki @ Cupertino CA USA
 See "User's Guide":     http://www.debian.org/doc/manuals/users-guide/
 See "Debian reference": http://www.debian.org/doc/manuals/debian-reference/
 "Debian reference" Project at: http://qref.sf.net

 I welcome your constructive criticisms and corrections.

To UNSUBSCRIBE, email to debian-doc-request@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org

Reply to: