bug#53627: 29.0.50; Incorrect installation instructions

bug#53627: 29.0.50; Incorrect installation instructions

[worik]

* Downloaded: git clone https://github.com/Stazed/rakarrack-plus.git

* Read INSTALL

* Tells me to run `./configure`

* That does not exist. README references it too

* Must run `./autogen.sh` first


In GNU Emacs 29.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version 
3.24.20, cairo version 1.16.0)
of 2022-01-30 built on munroe
Repository revision: 96533c18b7f9d75dce9e6bb534a16ed4ccf44ad1
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12013000
System Description: Linux Mint 20.3

Configured features:
ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GSETTINGS HARFBUZZ JPEG
LIBSELINUX MODULES NOTIFY INOTIFY PDUMPER PNG SECCOMP SOUND SQLITE3
THREADS TIFF TOOLKIT_SCROLL_BARS X11 XDBE XIM XPM GTK3 ZLIB

Important settings:
value of $LC_MONETARY: en_NZ.UTF-8
value of $LC_NUMERIC: en_NZ.UTF-8
value of $LC_TIME: en_NZ.UTF-8
value of $LANG: en_NZ.UTF-8
locale-coding-system: utf-8-unix

Major mode: Fundamental

Minor modes in effect:
tooltip-mode: t
global-eldoc-mode: t
show-paren-mode: t
electric-indent-mode: t
mouse-wheel-mode: t
tool-bar-mode: t
menu-bar-mode: t
file-name-shadow-mode: t
global-font-lock-mode: t
blink-cursor-mode: t
auto-composition-mode: t
auto-encryption-mode: t
auto-compression-mode: t
buffer-read-only: t
line-number-mode: t
indent-tabs-mode: t
transient-mark-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message yank-media rmc puny dired
dired-loaddefs rfc822 mml mml-sec epa derived epg rfc6068 epg-config
gnus-util text-property-search time-date mm-decode mm-bodies mm-encode
mail-parse rfc2231 mailabbrev gmm-utils mailheader sendmail rfc2047
rfc2045 ietf-drums mm-util mail-prsvr mail-utils finder-inf info package
browse-url url url-proxy url-privacy url-expand url-methods url-history
url-cookie url-domsuf url-util mailcap url-handlers url-parse
auth-source cl-seq eieio eieio-core cl-macs eieio-loaddefs
password-cache json map url-vars seq gv subr-x byte-opt bytecomp
byte-compile cconv cl-loaddefs cl-lib iso-transl tooltip eldoc paren
electric uniquify ediff-hook vc-hooks lisp-float-type elisp-mode mwheel
term/x-win x-win term/common-win x-dnd tool-bar dnd fontset image
regexp-opt fringe tabulated-list replace newcomment text-mode lisp-mode
prog-mode register page tab-bar menu-bar rfn-eshadow isearch easymenu
timer select scroll-bar mouse jit-lock font-lock syntax font-core
term/tty-colors frame minibuffer cl-generic cham georgian utf-8-lang
misc-lang vietnamese tibetan thai tai-viet lao korean japanese eucjp-ms
cp51932 hebrew greek romanian slovak czech european ethiopic indian
cyrillic chinese composite emoji-zwj charscript charprop case-table
epa-hook jka-cmpr-hook help simple abbrev obarray cl-preloaded nadvice
button loaddefs faces cus-face macroexp files window text-properties
overlay sha1 md5 base64 format env code-pages mule custom widget keymap
hashtable-print-readable backquote threads dbusbind inotify
dynamic-setting system-font-setting font-render-setting cairo
move-toolbar gtk x-toolkit x multi-tty make-network-process emacs)

Memory information:
((conses 16 211429 7373)
(symbols 48 13292 1)
(strings 32 73188 2359)
(string-bytes 1 1834327)
(vectors 16 20705)
(vector-slots 8 293778 40351)
(floats 8 26 23)
(intervals 56 338 5)
(buffers 992 11))

-- 
     If not me then who?  If not now then when?  If not here then where?
               So, here I stand, I can do no other
     root@worik.org 021-1680650, (03) 4821804 Aotearoa (New Zealand)

bug#53627: 29.0.50; Incorrect installation instructions

[H. Dieter Wilhelm]

worik <root@worik.org> writes:

> * Downloaded: git clone https://github.com/Stazed/rakarrack-plus.git

Please read INSTALL.REPO in the same directory, it says

	     Building and Installing Emacs from the Repository

  ...
  To use the autotools, run the following shell command to generate the
  'configure' script and some related files, and to set up your git
  configuration:

    $ ./autogen.sh

  You can then configure your build as follows:

    $ ./configure


> * Read INSTALL
>
> * Tells me to run `./configure`
>
> * That does not exist. README references it too
>
> * Must run `./autogen.sh` first

bug#53627: 29.0.50; Incorrect installation instructions

[worik]

On 30/01/22 10:48, H. Dieter Wilhelm wrote:
> worik <root@worik.org> writes:
>
>> * Downloaded: git clone https://github.com/Stazed/rakarrack-plus.git
> Please read INSTALL.REPO in the same directory, it says

I can cope.  I did not need that file.   I was not asking for help.  I 
was reporting a bug.

Having incorrect installation instructions in a file labeld INSTALL and 
repeating them in a file named README  is a bug.

It is not much help to have the correct instructions in some other file.

cheers

Worik

>
> 	     Building and Installing Emacs from the Repository
>
>    ...
>    To use the autotools, run the following shell command to generate the
>    'configure' script and some related files, and to set up your git
>    configuration:
>
>      $ ./autogen.sh
>
>    You can then configure your build as follows:
>
>      $ ./configure
>
>
>> * Read INSTALL
>>
>> * Tells me to run `./configure`
>>
>> * That does not exist. README references it too
>>
>> * Must run `./autogen.sh` first


-- 
     If not me then who?  If not now then when?  If not here then where?
               So, here I stand, I can do no other
     root@worik.org 021-1680650, (03) 4821804 Aotearoa (New Zealand)

bug#53627: 29.0.50; Incorrect installation instructions

[H. Dieter Wilhelm]

worik <root@worik.org> writes:

> On 30/01/22 10:48, H. Dieter Wilhelm wrote:
>> worik <root@worik.org> writes:
>>
>>> * Downloaded: git clone https://github.com/Stazed/rakarrack-plus.git

What is this, an Emacs repo?

>> Please read INSTALL.REPO in the same directory, it says
>
> I can cope.  I did not need that file.   I was not asking for help.  I
> was reporting a bug.

I'm not sure that this is a bug because in INSTALL it says:

  This file contains general information on building GNU Emacs.
  For more information specific to the MS-Windows, GNUstep/macOS, and
  MS-DOS ports, also read the files nt/INSTALL, nextstep/INSTALL, and
  msdos/INSTALL.  For information about building from a repository checkout
  (rather than a release), also read the file INSTALL.REPO.


Thus INSTALL is for installing from a release source archive and
INSTALL.REPO is for installing Emacs from a source repository.

> Having incorrect installation instructions in a file labeld INSTALL
> and repeating them in a file named README  is a bug.
>
> It is not much help to have the correct instructions in some other file.
>
> cheers
>
> Worik
>
>>
>> 	     Building and Installing Emacs from the Repository
>>
>>    ...
>>    To use the autotools, run the following shell command to generate the
>>    'configure' script and some related files, and to set up your git
>>    configuration:
>>
>>      $ ./autogen.sh
>>
>>    You can then configure your build as follows:
>>
>>      $ ./configure
>>
>>
>>> * Read INSTALL
>>>
>>> * Tells me to run `./configure`
>>>
>>> * That does not exist. README references it too
>>>
>>> * Must run `./autogen.sh` first

bug#53627: 29.0.50; Incorrect installation instructions

[Po Lu via Bug reports for GNU Emacs, the Swiss army knife of text editors]

worik <root@worik.org> writes:

> Having incorrect installation instructions in a file labeld INSTALL
> and repeating them in a file named README  is a bug.

INSTALL and README are intended for the vast majority of people who
download the release off ftp.gnu.org (or alpha.gnu.org for pretests.)

The instructions for installing from the repository are in INSTALL.REPO.
This is not a bug.

bug#53627: 29.0.50; Incorrect installation instructions

[Eli Zaretskii]

> From: "H. Dieter Wilhelm" <dieter@duenenhof-wilhelm.de>
> Date: Sat, 29 Jan 2022 23:05:38 +0100
> Cc: 53627@debbugs.gnu.org
> 
> >> Please read INSTALL.REPO in the same directory, it says
> >
> > I can cope.  I did not need that file.   I was not asking for help.  I
> > was reporting a bug.
> 
> I'm not sure that this is a bug because in INSTALL it says:
> 
>   This file contains general information on building GNU Emacs.
>   For more information specific to the MS-Windows, GNUstep/macOS, and
>   MS-DOS ports, also read the files nt/INSTALL, nextstep/INSTALL, and
>   msdos/INSTALL.  For information about building from a repository checkout
>   (rather than a release), also read the file INSTALL.REPO.
> 
> 
> Thus INSTALL is for installing from a release source archive and
> INSTALL.REPO is for installing Emacs from a source repository.

Indeed, and so I don't think there's a bug here, and I'm closing this
bug report.

bug#53627: 29.0.50; Incorrect installation instructions

[Benjamin Riefenstahl]

Po Lu writes:
> INSTALL and README are intended for the vast majority of people who
> download the release off ftp.gnu.org (or alpha.gnu.org for pretests.)

I'm not sure this is true anymore.  I'm guessing these days most people
use pre-built binaries, and those who do get the source get it straight
from the Git instead of the tarballs.  Maybe that note that if you clone
the repo you should look at INSTALL.REPO could be more prominent in
INSTALL?  When Dieter quoted the paragraph from INSTALL above, I could
not even find that note at first glance, even though I knew what must be
in there.

Just my 2 cents,
benny

bug#53627: 29.0.50; Incorrect installation instructions

[Lars Ingebrigtsen]

Benjamin Riefenstahl <b.riefenstahl@turtle-trading.net> writes:

>> INSTALL and README are intended for the vast majority of people who
>> download the release off ftp.gnu.org (or alpha.gnu.org for pretests.)
>
> I'm not sure this is true anymore.  I'm guessing these days most people
> use pre-built binaries, and those who do get the source get it straight
> from the Git instead of the tarballs.  Maybe that note that if you clone
> the repo you should look at INSTALL.REPO could be more prominent in
> INSTALL?  When Dieter quoted the paragraph from INSTALL above, I could
> not even find that note at first glance, even though I knew what must be
> in there.

I didn't see it either.  I've now made it into a separate paragraph, and
made it slightly less obscure.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no