GNU bug report logs - #18840
24.4; nt/README.W32: obsolete snippet

Previous Next

Full log

Message #11 received at 18840 <at> debbugs.gnu.org (full text, mbox):

From: Dani Moncayo <dmoncayo <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 18840 <at> debbugs.gnu.org
Subject: Re: bug#18840: 24.4; nt/README.W32: obsolete snippet
Date: Sun, 26 Oct 2014 17:49:39 +0100

>> This snipped from the file nt/README.W32:
>> -------------------------
>> * Preliminaries
>>
>>   Along with this file should be four subdirectories (bin, libexec,
>>   share, and var).
>> -------------------------
>> is obsolete, since now this file is placed under
>> 'share/emacs/VERSION/' on the binary distribution.
>>
>> So, it should be either reworded or removed.
>
> Actually, I think that file should be manually copied to the top-level
> directory, after "make install" finishes.  Otherwise, the probability
> of it being discovered by users is probably close to zero.

That's a possibility, but I think we also should:

* Reword that section to make it independent of the location of the
  README.W32 file (the current wording is not valid for the copy in
  'share/emacs/VERSION').

* Tell the user _not_ to copy the top-level README.W32 when setting up
  his/her Emacs setup (individual packages should not pollute the top
  level directory).

For example, something along these lines:

=== modified file 'nt/README.W32'
--- nt/README.W32       2014-10-09 00:47:30 +0000
+++ nt/README.W32       2014-10-26 16:33:39 +0000
@@ -21,12 +21,19 @@

 * Preliminaries

-  Along with this file should be four subdirectories (bin, libexec,
-  share, and var).
+  The binary distribution has these top-level directories:
+
+  + bin: <explain briefly its contents>
+
+  + libexec: <explain briefly its contents>
+
+  + share: <explain briefly its contents>
+
+  + var: <explain briefly its contents>

 * Setting up Emacs

-  To install Emacs, simply unpack all the files into a directory of
+  To install Emacs, simply unpack the top-level directories into a directory of
   your choice.  To complete the installation process, you can
   optionally run the program addpm.exe in the bin subdirectory.  This
   will put an icon for Emacs in the Start Menu under

-- 
Dani Moncayo

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.