Re: read-face-name doc string incorrect

[Kim F. Storm]

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?

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


>
>> Developers are more likely to look in a file called CONTRIBUTE than
>> INSTALL.CVS for guidelines and splitting the information makes it a bit like 
>> a
>> treasure hunt.
>
> 100% agreement.

100% disagreement.

- 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.


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

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.

I don't see how this is a treasure hunt -- if people don't read
INSTALL.CVS, they'll most likely not figure out how to build
Emacs from CVS in the first place.


-- 
Kim F. Storm <address@hidden> http://www.cua.dk