From 13f1fbbadf902052da26a1e35415b779a3c3835c Mon Sep 17 00:00:00 2001 From: jao Date: Sun, 19 Jul 2020 23:00:12 +0100 Subject: the long road to doc updates starts with one commit --- doc/install.texi | 158 ------------------------------------------------ elisp/geiser-load.el.in | 9 --- elisp/geiser-reload.el | 3 +- elisp/geiser.el | 8 --- readme.org | 51 +--------------- 5 files changed, 2 insertions(+), 227 deletions(-) delete mode 100644 elisp/geiser-load.el.in diff --git a/doc/install.texi b/doc/install.texi index 644b310..4d38578 100644 --- a/doc/install.texi +++ b/doc/install.texi @@ -4,8 +4,6 @@ @menu * Must needs:: * The easy and quick way:: -* Chicken installation:: -* Gambit installation:: * From the source's mouth:: * Friends:: @end menu @@ -97,92 +95,6 @@ And, by the way, if you prefer to keep reading this manual within Emacs, you just installed! @end ifnotinfo -@cindex Chicken -@cindex Chicken installation -@node Chicken installation, Gambit installation, The easy and quick way, Installation -@section Chicken installation - -If you plan to use Chicken, you'll need also to fire a terminal and -configure a couple of Chicken eggs. For Chicken 4 that would be: -@example -$ chicken-install -s apropos chicken-doc -$ cd `csi -p '(chicken-home)'` -$ curl http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx -@end example - -while Chicken 5 prefers: -@example -$ chicken-install -s apropos chicken-doc srfi-18 srfi-1 -$ cd `csi -R chicken.platform -p '(chicken-home)'` -$ curl https://3e8.org/pub/chicken-doc/chicken-doc-repo-5.tgz | sudo tar zx -@end example - -(see also @uref{https://wiki.call-cc.org/emacs#geiser, Chicken's wiki}). - -@cindex Gambit -@cindex Gambit installation -@node Gambit installation, From the source's mouth, Chicken installation, Installation -@section Gambit installation - -If you plan to use Gambit, you'll also need to open a terminal and -configure a couple of awesome Gambit's features: - -@enumerate -@item -Clone the last version of gambit and of this repo -@item -Configure Gambit using @code{--enable-rtlib-debug-source} to activate autodoc -@example - $ cd ~/ - $ git clone "the gambit repo current address" - $ cd gambit - $ ./configure --enable-single-host --enable-debug --enable-rtlib-debug-source - $ make bootstrap - $ make bootclean - $ make -j - $ make install -@end example -@item -Put a link to @code{geiser/elisp/geiser.el} in your init file in your - init file paste : -@example - (load-file "~/geiser/elisp/geiser.el") -@end example - (the path is your path to geiser.el.) -@end enumerate - -And, if you also want to use a remote Gambit REPL: - -@enumerate -@item -Enable the gambit/geiser module: -@example - $ mkdir ~/gambit/lib/gambit/geiser - $ cp ~/geiser/geiser-module/* ~/gambit/lib/geiser/ -@end example -@item -Now that you have the module you start gsi with it and using the -@code{-:d} option: -@example - $ gsi -:d@ gambit/geiser - -@end example -@item -You can now open emacs and call -@example - M-x geiser-connect gambit -@end example - Enjoy! -@end enumerate - -By the way, if you are unable to use gambit modules, open gsi with the -@file{gambit.scm} file located in -@file{geiser/scheme/gambit/geiser/gambit.scm}; something like: -@example - gsi -:d@ ~/geiser/scheme/gambit/geiser/gambit.scm - -@end example -(Keep in mind that these paths may be a little different for you.) - - @node From the source's mouth, Friends, Gambit installation, Installation @section Installing from source @@ -237,76 +149,6 @@ just to start using Geiser, would you?). That's it: you're ready to go (@pxref{The REPL}). @end ifnothtml -@ifnotinfo -If you obtained the Geiser source tree from a release tarball, you can -even continue to read this fine manual inside Emacs by opening -@file{doc/geiser.info} using @kbd{C-u C-h i}. -@end ifnotinfo - -@cindex byte-compilation -What? You still here? I promise the above is all that's needed to start -using Geiser. But, in case you are missing your @t{configure/make all -install} routine, by all means, you can go through those motions to byte -compile and install Geiser too. That is, you enter the source directory -and (since we grabbed the development tree) run the customary -@i{autogen} script: - -@example -$ cd ~/lisp/geiser -$ ./autogen.sh -@end example - -@noindent -I recommend that you compile Geiser in a separate directory: - -@example -$ mkdir build && cd build -$ ../configure - -$ make all - -@end example - -Now you have two options: loading the byte-compiled Geiser from the -@file{elisp} subdirectory, or installing it system-wide. To load the -byte-code from here, add this line to your initialisation file: - -@example -(load "~/lisp/geiser/build/elisp/geiser-load") -@end example - -@noindent -and eval that form and you're done (you could also restart Emacs, but -killing your friends is widely considered bad form). Yes, that's -@code{load} and @file{geiser-load} instead of @code{load-file} and -@file{geiser.el}. - -If you prefer a system-wide installation, just type: - -@example -$ sudo make install -@end example - -With the above spell, Geiser will be compiled and installed in a safe -place inside Emacs' load path. To load it into Emacs you'll need, -@i{instead} of the @code{load-file} form above, the following line in -your initialisation file: - -@example -(require 'geiser-install) -@end example - -@noindent -Please note that we're requiring @code{geiser-install}, and @i{not} -@code{geiser}, and that there's no @code{load-file} to be seen this -time. There are some ways of fine-tuning this process, mainly by -providing additional arguments in the call to @t{configure}: you'll find -those gory details in the file called @file{INSTALL}, right at the root -of the source tree. The installation will also take care of placing this -manual, in Info format, where Emacs can find it, so you can continue to -learn about Geiser inside its natural habitat. See you there and into -the next chapter! - @node Friends, , From the source's mouth, Installation @section Friends diff --git a/elisp/geiser-load.el.in b/elisp/geiser-load.el.in deleted file mode 100644 index d23c7b9..0000000 --- a/elisp/geiser-load.el.in +++ /dev/null @@ -1,9 +0,0 @@ -(defconst geiser-elisp-dir nil) -(setq geiser-elisp-dir (file-name-directory load-file-name)) -(add-to-list 'load-path geiser-elisp-dir) - -(require 'geiser) - -(setq geiser-scheme-dir "@abs_top_srcdir@/scheme") - -(provide 'geiser-load) diff --git a/elisp/geiser-reload.el b/elisp/geiser-reload.el index 287a768..4326613 100644 --- a/elisp/geiser-reload.el +++ b/elisp/geiser-reload.el @@ -1,6 +1,6 @@ ;;; geiser-reload.el -- unload/load geiser packages -;; Copyright (C) 2009, 2010, 2012 Jose Antonio Ortega Ruiz +;; Copyright (C) 2009, 2010, 2012, 2020 Jose Antonio Ortega Ruiz ;; This program is free software; you can redistribute it and/or ;; modify it under the terms of the Modified BSD License. You should @@ -17,7 +17,6 @@ (require 'geiser-custom) (require 'geiser-base) (require 'geiser) -(require 'geiser-load nil t) (require 'geiser-install nil t) diff --git a/elisp/geiser.el b/elisp/geiser.el index eb5e975..6a41b98 100644 --- a/elisp/geiser.el +++ b/elisp/geiser.el @@ -20,14 +20,6 @@ (defconst geiser-elisp-dir (file-name-directory load-file-name) "Directory containing Geiser's Elisp files.") -;;;###autoload -(defconst geiser-scheme-dir - (let ((d (expand-file-name "./scheme/" geiser-elisp-dir))) - (if (file-directory-p d) - d - (expand-file-name "../scheme/" geiser-elisp-dir))) - "Directory containing Geiser's Scheme files.") - ;;;###autoload (add-to-list 'load-path (directory-file-name geiser-elisp-dir)) diff --git a/readme.org b/readme.org index 368a9b7..8e71b00 100644 --- a/readme.org +++ b/readme.org @@ -43,56 +43,7 @@ The easiest way is to use MELPA, and just type =M-x package-install RET geiser= inside emacs. - Geiser can be used either directly from its uninstalled source tree - or byte-compiled and installed after performing the standard - configure/make/make install dance. See the INSTALL file for more details. - -** Chicken 5 Addendum - These steps are necessary to fully support Chicken Scheme, but are - not required for any other scheme. - - - Install the necessary support eggs: - #+BEGIN_EXAMPLE - $ chicken-install -s apropos chicken-doc srfi-18 srfi-1 - #+END_EXAMPLE - - Update the Chicken documentation database: - #+BEGIN_EXAMPLE - $ cd `csi -R chicken.platform -p '(chicken-home)'` - $ curl https://3e8.org/pub/chicken-doc/chicken-doc-repo-5.tgz | sudo tar zx - #+END_EXAMPLE - -** Chicken 4 Addendum - These steps are necessary to fully support Chicken Scheme, but are - not required for any other scheme. - - - Install the necessary support eggs: - -#+BEGIN_EXAMPLE - $ chicken-install -s apropos chicken-doc -#+END_EXAMPLE - - - Update the Chicken documentation database: - -#+BEGIN_EXAMPLE - $ cd `csi -p '(chicken-home)'` - $ curl http://3e8.org/pub/chicken-doc/chicken-doc-repo.tgz | sudo tar zx -#+END_EXAMPLE - -** Gambit Addendum - These steps are necessary to fully support Gambit Scheme. - - 1 - clone the last version of gambit - 2 - configure gambit using --enable-rtlib-debug-source to activate autodoc -#+BEGIN_EXAMPLE - $ cd ~/ - $ git clone "the gambit repo address" - $ cd gambit - $ ./configure --enable-single-host --enable-debug --enable-rtlib-debug-source - $ make bootstrap - $ make bootclean - $ make -j - $ make install -#+END_EXAMPLE + Geiser can be used either directly from its source tree. * Basic configuration -- cgit v1.2.3