summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJose Antonio Ortega Ruiz <jao@gnu.org>2014-05-31 05:37:09 +0200
committerJose Antonio Ortega Ruiz <jao@gnu.org>2014-05-31 05:37:09 +0200
commit586d552350c04f4025ce99d2600bf89496db6e31 (patch)
tree3fd56827bf2004dc84204a52e7454805aaa16a35 /doc
parent5020b91e90520a9e5c0c725123247535dfb60a4f (diff)
downloadgeiser-chez-586d552350c04f4025ce99d2600bf89496db6e31.tar.gz
geiser-chez-586d552350c04f4025ce99d2600bf89496db6e31.tar.bz2
Making makeinfo html-happy
Fixes for warnings issued by makeinfo 5.x (when using some of our macros: the guy is touchy regarding @ifhtml and new lines) that were preventing the install-html make target to work (for people that want local html by texinfo as opposed to the (supposedly fancier) texi2html-generated version we use for the web).
Diffstat (limited to 'doc')
-rw-r--r--doc/parens.texi18
-rw-r--r--doc/repl.texi13
2 files changed, 20 insertions, 11 deletions
diff --git a/doc/parens.texi b/doc/parens.texi
index a7085a6..2c486ce 100644
--- a/doc/parens.texi
+++ b/doc/parens.texi
@@ -33,7 +33,8 @@ process giving you the REPL, make those Scheme buffers come to life.
@section Activating Geiser
@cindex geiser-mode
-@img{geiser-mode, right} With Geiser installed following any of the
+@img{geiser-mode, right}
+With Geiser installed following any of the
procedures described in @ref{The easy and quick way} or @ref{From the
source's mouth}, Emacs will automatically activate @i{geiser-mode} when
opening a Scheme buffer. Geiser also instructs Emacs to consider files
@@ -216,7 +217,8 @@ If you use a numeric prefix, as in @kbd{C-u C-c C-z}, besides being
teleported to the REPL, the latter will switch to the namespace of the
Scheme source file, as if you had used @kbd{C-c C-m} in the REPL, with
the source file's module as argument;
-cf. discussion in @altr{Switching context,,Switching context,. This}
+cf. discussion in
+@altr{Switching context,,Switching context,. This}
command is also bound to @kbd{C-c C-a}.
Once you're in the REPL, the same @kbd{C-c C-z} shortcut will bring
@@ -284,7 +286,8 @@ bound by default to @kbd{C-c C-d s}, to show the autodoc string for the
symbol at point.
@cindex autodoc explained
-@img{autodoc-scm, right} The way autodoc displays information deserves
+@img{autodoc-scm, right}
+The way autodoc displays information deserves
some explanation. It will first show the name of the module where the
identifier at hand is defined, followed by a colon and the identifier
itself. If the latter corresponds to a procedure or macro, it will be
@@ -301,7 +304,8 @@ macros defined using @code{syntax-case}). Another way in which autodoc
displays its ignorance is by using an underscore to display parameters
whose name is beyond its powers.
-@img{autodoc-multi, right} It can also be the case that a function or
+@img{autodoc-multi, right}
+It can also be the case that a function or
macro has more than one signature (e.g., functions defined using
@code{case-lambda}, or some @code{syntax-rules} macros, for which Geiser
has often the black magic necessary to retrieve their actual arities).
@@ -312,7 +316,8 @@ As you have already noticed, the whole autodoc message is enclosed in
parentheses. After all, we're talking about Scheme here.
@cindex autodoc for variables
-@img{autodoc-var, right} Finally, life is much easier when your cursor
+@img{autodoc-var, right}
+Finally, life is much easier when your cursor
is on a symbol corresponding to a plain variable: you'll see in the echo
area its name, preceded by the module where it's defined, and followed
by its value, with an intervening arrow for greater effect. This time,
@@ -371,7 +376,8 @@ some other tidbits for re-exported identifiers.
You can also ask Geiser to display information about a module, in the
form of a list of its exported identifiers, using @kbd{C-c C-d C-m},
-exactly as you would do in @altr{repl-mod,the REPL,The REPL,.}
+exactly as you would do in
+@altr{repl-mod,the REPL,The REPL,.}
In both cases, the documentation browser will show a couple of buttons
giving you access to further documentation. First, you'll see a button
diff --git a/doc/repl.texi b/doc/repl.texi
index acab26e..ad10202 100644
--- a/doc/repl.texi
+++ b/doc/repl.texi
@@ -24,7 +24,8 @@ Read-Eval-Print Loop), Geiser provides the generic interactive command
@command{run-geiser}. If you invoke it (via, as is customary in Emacs,
@kbd{M-x run-geiser}), you'll be saluted by a prompt asking which one of
the supported implementations you want to launch---yes, you can stop the
-asking, see @altr{active-implementations,below,Customization and tips,.}
+asking, see
+@altr{active-implementations,below,Customization and tips,.}
Tabbing for completion will offer you, as of this writing, @code{guile}
and @code{racket}. Just choose your poison, and a new REPL buffer will
pop up (by default, the REPL will appear in a new window: if that annoys
@@ -37,7 +38,8 @@ If all went according to plan, you'll be facing an
implementation-dependent banner, followed by an interactive prompt.
Going according to plan includes having the executable of the Scheme you
chose in your path. If that's not the case, you can tell Emacs where it
-is, as described in @altr{impl-binary,a moment,Customization and tips,.}
+is, as described in
+@altr{impl-binary,a moment,Customization and tips,.}
Returning to our REPL, the first thing to notice is that the funny
prompt is telling you your current module: its name is the part just
after the @@ sign (in Guile, that means @code{guile-user}, while
@@ -134,7 +136,8 @@ both commands will just sever the connection and leave the remote
process alone. If worse comes to worst and the process is dead, @kbd{C-c
C-z} will restart it. However, the same shortcut, issued when the REPL is
alive, will bring you back to the buffer you came from, as explained
-in @altr{switching-repl-buff,this section,The source and the REPL,.}
+in
+@altr{switching-repl-buff,this section,The source and the REPL,.}
The remaining commands are meatier, and deserve sections of their own.
@@ -263,8 +266,8 @@ name.
The list of exported bindings is shown, again, in a buffer belonging to
Geiser's documentation browser, where you have at your disposal a bunch
-of navigation commands listed in @altr{Documentation browser,our
-cheat-sheet,Documentation browser,.}
+of navigation commands listed in
+@altr{Documentation browser,our cheat-sheet,Documentation browser,.}
We'll have a bit more to say about the documentation browser in
@altr{doc-browser,a later section,Documentation helpers,.}