bug#18840: 24.4; nt/README.W32: obsolete snippet

bug#18840: 24.4; nt/README.W32: obsolete snippet

[Dani Moncayo]

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.


In GNU Emacs 24.4.1 (i686-pc-mingw32)
 of 2014-10-20 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.3.9600
Important settings:
  value of $LANG: ENU
  locale-coding-system: cp1252


-- 
Dani Moncayo

bug#18840: 24.4; nt/README.W32: obsolete snippet

[Eli Zaretskii]

> Date: Sun, 26 Oct 2014 10:47:36 +0100
> From: Dani Moncayo <dmoncayo@gmail.com>
> 
> 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.

Thanks.

bug#18840: 24.4; nt/README.W32: obsolete snippet

[Dani Moncayo]

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

bug#18840: 24.4; nt/README.W32: obsolete snippet

[Eli Zaretskii]

> Date: Sun, 26 Oct 2014 17:49:39 +0100
> From: Dani Moncayo <dmoncayo@gmail.com>
> Cc: 18840@debbugs.gnu.org
> 
> -  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>

This is OK (and I don't think we must describe the contents of each
subdirectory, but I will certainly not object to it).

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

None of this is accurate.  Instead, we should say

  To install Emacs, simply unpack the binary zip into a directory of
  your choice.

Thanks.

bug#18840: 24.4; nt/README.W32: obsolete snippet

[Dani Moncayo]

>> -  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>
>
> This is OK (and I don't think we must describe the contents of each
> subdirectory, but I will certainly not object to it).

Ok.  (I didn't describe them because I wouldn't know how, especially
with "share" and "var").

>>  * 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.
>
> None of this is accurate.  Instead, we should say
>
>   To install Emacs, simply unpack the binary zip into a directory of
>   your choice.

Ok.  (I changed "zip" with "package" to make it more neutral wrt the
compression format)

Committed & closing this bug.

Thank you.

-- 
Dani Moncayo

bug#18840: 24.4; nt/README.W32: obsolete snippet

[Dani Moncayo]

> Committed & closing this bug.

I've just realized that this should have gone to emacs-24, not the
trunk.  Sorry.

(I could back port this to emacs-24 is someone tell me how, or what
doc to read).

-- 
Dani Moncayo

bug#18840: 24.4; nt/README.W32: obsolete snippet

[Eli Zaretskii]

> Date: Sun, 26 Oct 2014 19:05:32 +0100
> From: Dani Moncayo <dmoncayo@gmail.com>
> 
> > Committed & closing this bug.
> 
> I've just realized that this should have gone to emacs-24, not the
> trunk.  Sorry.
> 
> (I could back port this to emacs-24 is someone tell me how, or what
> doc to read).

You could simply apply the diffs, it's no big deal in this case.

If you want bzr to do the job for you, then the following will do it:

  cd emacs-24 && bzr merge -r 118218..118219 ../trunk

Then "bzr ci" as usual, but please be sure to say in the commit
message that this was "backported from trunk", so that the next merge
from emacs-24 to the trunk will skip this commit.

Thanks.

bug#18840: 24.4; nt/README.W32: obsolete snippet

[Dani Moncayo]

>> (I could back port this to emacs-24 is someone tell me how, or what
>> doc to read).
>
> You could simply apply the diffs, it's no big deal in this case.
>
> If you want bzr to do the job for you, then the following will do it:
>
>   cd emacs-24 && bzr merge -r 118218..118219 ../trunk
>
> Then "bzr ci" as usual, but please be sure to say in the commit
> message that this was "backported from trunk", so that the next merge
> from emacs-24 to the trunk will skip this commit.

Done & thank you.

-- 
Dani Moncayo