Re: read-face-name doc string incorrect

[Eli Zaretskii]

> Cc: Nick Roberts <address@hidden>,  address@hidden
> From: address@hidden (Kim F. Storm)
> Date: Thu, 06 Jul 2006 11:07:25 +0200
> 
> Eli Zaretskii <address@hidden> writes:
> 
> >> From: Nick Roberts <address@hidden>
> >> Date: Wed, 5 Jul 2006 20:49:55 +1200
> >> Cc: Eli Zaretskii <address@hidden>, address@hidden
> >> 
> >> The admin directory has files which go way beyond the needs of the average
> >> contributor.
> >
> > Those files aren't documented anywhere, and aren't included in the
> > distribution.  So, if we don't mention them, there's no chance an
> > average contributor will learn about them.  What's the harm of
> > mentioning them?  Some of those files are quite useful for
> > maintenance.
> 
> Why would you mention them in CONTRIBUTE of all places?

Because that's where new contributors would look (or so we hope) for
information about Emacs development standards and guidelines.

> There is admin/README ...  If that is not complete or too terse,
> we should improve on that file, not pollute CONTRIBUTE.

admin/README is not part of the tarball, so users will not see it
unless they already use CVS codebase.

> - INSTALL.CVS is NOT included in the emacs tarball / binary distro
> - admin/* is NOT included
> 
> So to me it makes no sense for CONTRIBUTE to _describe_ those files.

Yes, it does: users will see those files described, and will then know
to look for them when/if they start using the CVS code.

> But it do make sense to _mention_ that after downloading the source
> package from CVS, the first file to read should be INSTALL.CVS.

Yes, that's a good idea.

> And if people, contributor or not contributor, follow that advice 
> they will read INSTALL.CVS which will then contain descriptions of
> the files which are only available from CVS.

But INSTALL.CVS, as its name suggest is about _installing_ Emacs, not
about other things.  People are unlikely to look there for anything
besides build and installation instructions We could have README.CVS
or something similar, though, similarly to README.