mirror/guile
mirror/guile
1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-06-06 20:20:20 +02:00
Code Activity

[doc] Clean up .texi for modern GNU Texinfo

Browse source 
These changes are the minimal needed to get "make" to
complete w/o error or warnings using GNU Texinfo 6.3.

* doc/goops/goops.texi <title page>: Condense @author lines.
  (Running GOOPS, Methods, User-defined types)
  (Asking for the type of an object):
  Promote these nodes from subsection to section.
* doc/r5rs/r5rs.texi <title page>: Remove spurious @author;
  change @unnumbered to @heading.
  (Entry format): Comment out spurious @center;
  remove spurious @item.
  (Characters): Likewise.
  (Lexical structure): Rework @format blocks w/ embedded
  @t and @cindex, as a series of abutting @example blocks
  that close and reopen around the @cindex; and sans @t.
  (Additional material): Comment out spurious @center lines.
* doc/tutorial/guile-tut.texi (Hello World):
  Promote from @subsection to @section.
  (A bunch of operations in Scheme): Likewise;
  change @print to take no args.
  (Using recursion to process lists, Processing matrices):
  Promote from @subsection to @section.
  (Using Guile to program in Scheme): Change @print to take no args.
This commit is contained in:
Thien-Thi Nguyen 2017-03-03 10:17:03 +01:00
parent de2d678982
commit 4c6f43a635
3 changed files with 49 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

19
doc/goops/goops.texi
View file

@ -48,14 +48,9 @@ are preserved on all copies.
@c and MOP documentation were written by Neil Jerram and reviewed by @c and MOP documentation were written by Neil Jerram and reviewed by
@c Mikael Djurfeldt. @c Mikael Djurfeldt.
@author Christian Lynbech @author Christian Lynbech @email{chl@@tbit.dk}
@author @email{chl@@tbit.dk} @author Mikael Djurfeldt @email{djurfeldt@@nada.kth.se}
@author @author Neil Jerram @email{neil@@ossau.uklinux.net}
@author Mikael Djurfeldt
@author @email{djurfeldt@@nada.kth.se}
@author
@author Neil Jerram
@author @email{neil@@ossau.uklinux.net}
@c The following two commands @c The following two commands
@c start the copyright page. @c start the copyright page.
@ -131,7 +126,7 @@ info (goops.info) and texinfo format.
@end menu @end menu
@node Running GOOPS, Methods, Getting Started, Getting Started @node Running GOOPS, Methods, Getting Started, Getting Started
@subsection Running GOOPS @section Running GOOPS
@enumerate @enumerate
@item @item
@ -158,7 +153,7 @@ arbitrary Guile interpreter.)
We're now ready to try some basic GOOPS functionality. We're now ready to try some basic GOOPS functionality.
@node Methods, User-defined types, Running GOOPS, Getting Started @node Methods, User-defined types, Running GOOPS, Getting Started
@subsection Methods @section Methods
@smalllisp @smalllisp
@group @group
@ -171,7 +166,7 @@ We're now ready to try some basic GOOPS functionality.
@end smalllisp @end smalllisp
@node User-defined types, Asking for the type of an object, Methods, Getting Started @node User-defined types, Asking for the type of an object, Methods, Getting Started
@subsection User-defined types @section User-defined types
@smalllisp @smalllisp
(define-class <2D-vector> () (define-class <2D-vector> ()
@ -201,7 +196,7 @@ v --> <3, 4>
@end smalllisp @end smalllisp
@node Asking for the type of an object, , User-defined types, Getting Started @node Asking for the type of an object, , User-defined types, Getting Started
@subsection Types @section Types
@example @example
(class-of v) --> #<<class> <2D-vector> 40241ac0> (class-of v) --> #<<class> <2D-vector> 40241ac0>

53
doc/r5rs/r5rs.texi
View file

@ -106,7 +106,6 @@
@author C. H@sc{ANSON} @author C. H@sc{ANSON}
@author K. M. P@sc{ITMAN} @author K. M. P@sc{ITMAN}
@author M. W@sc{AND} @author M. W@sc{AND}
@author
@c {\it Dedicated to the Memory of ALGOL 60} @c {\it Dedicated to the Memory of ALGOL 60}
@ -116,7 +115,7 @@
@unnumbered Summary @heading Summary
The report gives a defining description of the programming language The report gives a defining description of the programming language
@ -760,7 +759,7 @@ conventions also imply type restrictions:
@c \newcommand{\foo}[1]{\vr{#1}, \vri{#1}, $\ldots$ \vrj{#1}, $\ldots$} @c \newcommand{\foo}[1]{\vr{#1}, \vri{#1}, $\ldots$ \vrj{#1}, $\ldots$}
@center @c begin-tabular @c @center @c begin-tabular
@quotation @quotation
@table @asis @table @asis
@item @var{obj} @item @var{obj}
@ -779,7 +778,6 @@ rational number
integer integer
@item @var{k}, @var{k1}, @dots{} @var{kj}, @dots{} @item @var{k}, @var{k1}, @dots{} @var{kj}, @dots{}
exact non-negative integer exact non-negative integer
@item
@end table @end table
@end quotation @end quotation
@ -5566,7 +5564,7 @@ For example:
@center @c begin-tabular @c @center @c begin-tabular
@quotation @quotation
@table @asis @table @asis
@item @t{#\a} @item @t{#\a}
@ -5581,7 +5579,6 @@ For example:
; the preferred way to write a space ; the preferred way to write a space
@item @t{#\newline} @item @t{#\newline}
; the newline character ; the newline character
@item
@end table @end table
@end quotation @end quotation
@ -7272,20 +7269,24 @@ The following five characters are reserved for future extensions to the
language: @t{[ ] @{ @} |} language: @t{[ ] @{ @} |}
@format @example
@t{<token> --> <identifier> | <boolean> | <number> <token> --> <identifier> | <boolean> | <number>
@end example
@cindex @w{identifier} @cindex @w{identifier}
@example
| <character> | <string> | <character> | <string>
| ( | ) | #( | @t{'} | @t{`} | , | ,@@ | @b{.} | ( | ) | #( | @t{'} | @t{`} | , | ,@@ | @b{.}
<delimiter> --> <whitespace> | ( | ) | " | ; <delimiter> --> <whitespace> | ( | ) | " | ;
<whitespace> --> <space or newline> <whitespace> --> <space or newline>
<comment> --> ; <@r{all subsequent characters up to a} <comment> --> ; <@r{all subsequent characters up to a}
@r{line break>} @r{line break>}
@end example
@cindex @w{comment} @cindex @w{comment}
@example
<atmosphere> --> <whitespace> | <comment> <atmosphere> --> <whitespace> | <comment>
<intertoken space> --> <atmosphere>*} <intertoken space> --> <atmosphere>*
@end format @end example
@ -7296,8 +7297,8 @@ language: @t{[ ] @{ @} |}
@format @example
@t{<identifier> --> <initial> <subsequent>* <identifier> --> <initial> <subsequent>*
| <peculiar identifier> | <peculiar identifier>
<initial> --> <letter> | <special initial> <initial> --> <letter> | <special initial>
<letter> --> a | b | c | ... | z <letter> --> a | b | c | ... | z
@ -7310,8 +7311,10 @@ language: @t{[ ] @{ @} |}
<special subsequent> --> + | - | .@: | @@ <special subsequent> --> + | - | .@: | @@
<peculiar identifier> --> + | - | ... <peculiar identifier> --> + | - | ...
<syntactic keyword> --> <expression keyword> <syntactic keyword> --> <expression keyword>
@end example
@cindex @w{syntactic keyword} @cindex @w{syntactic keyword}
@cindex @w{keyword} @cindex @w{keyword}
@example
| else | => | define | else | => | define
| unquote | unquote-splicing | unquote | unquote-splicing
<expression keyword> --> quote | lambda | if <expression keyword> --> quote | lambda | if
@ -7320,7 +7323,9 @@ language: @t{[ ] @{ @} |}
| quasiquote | quasiquote
@w{@samp{<variable> @result{} <}}@r{any <identifier> that isn't} @w{@samp{<variable> @result{} <}}@r{any <identifier> that isn't}
@end example
@cindex @w{variable} @cindex @w{variable}
@example
@w{ @r{also a <syntactic keyword>>}} @w{ @r{also a <syntactic keyword>>}}
<boolean> --> #t | #f <boolean> --> #t | #f
@ -7330,9 +7335,9 @@ language: @t{[ ] @{ @} |}
<string> --> " <string element>* " <string> --> " <string element>* "
<string element> --> <any character other than " or \> <string element> --> <any character other than " or \>
| \" | \\ } | \" | \\
@end format @end example
@ -7385,27 +7390,35 @@ Mark Meyer and David Bartley want to fix this. (What? -- Will)
@format @example
@t{<suffix> --> <empty> <suffix> --> <empty>
| <exponent marker> <sign> <digit 10>+ | <exponent marker> <sign> <digit 10>+
<exponent marker> --> e | s | f | d | l <exponent marker> --> e | s | f | d | l
<sign> --> <empty> | + | - <sign> --> <empty> | + | -
<exactness> --> <empty> | #i | #e <exactness> --> <empty> | #i | #e
@end example
@vindex #e @vindex #e
@vindex #i @vindex #i
@example
<radix 2> --> #b <radix 2> --> #b
@end example
@vindex #b @vindex #b
@example
<radix 8> --> #o <radix 8> --> #o
@end example
@vindex #o @vindex #o
@example
<radix 10> --> <empty> | #d <radix 10> --> <empty> | #d
<radix 16> --> #x <radix 16> --> #x
@end example
@vindex #x @vindex #x
@example
<digit 2> --> 0 | 1 <digit 2> --> 0 | 1
<digit 8> --> 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 <digit 8> --> 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7
<digit 10> --> <digit> <digit 10> --> <digit>
<digit 16> --> <digit 10> | a | b | c | d | e | f } <digit 16> --> <digit 10> | a | b | c | d | e | f
@end format @end example
@ -8057,9 +8070,9 @@ Cromarty:
The Internet Scheme Repository at The Internet Scheme Repository at
@center @c @center
@center @url{http://www.cs.indiana.edu/scheme-repository/} @center @url{http://www.cs.indiana.edu/scheme-repository/}
@center @c @center
contains an extensive Scheme bibliography, as well as papers, contains an extensive Scheme bibliography, as well as papers,
programs, implementations, and other material related to Scheme. programs, implementations, and other material related to Scheme.

18
doc/tutorial/guile-tut.texi
View file

@ -446,7 +446,7 @@ get started, look at the books @cite{Simply Scheme} and @cite{The Little
Schemer} from that list.} Schemer} from that list.}
@subsection Hello World @section Hello World
@cindex hello world @cindex hello world
Our first program is the typical Scheme "hello world" program. Put the Our first program is the typical Scheme "hello world" program. Put the
@ -483,7 +483,7 @@ is then terminated with @code{!#} on the second line so as to not
interfere with the execution mechanism. interfere with the execution mechanism.
@subsection A bunch of operations in Scheme @section A bunch of operations in Scheme
Here is some code you can type at the @code{guile>} prompt to see some Here is some code you can type at the @code{guile>} prompt to see some
of the Scheme data types at work (mostly lists and vectors). I have of the Scheme data types at work (mostly lists and vectors). I have
@ -535,12 +535,12 @@ guile> @kbd{(memq 4 ls)}
guile> @kbd{(if (memq 4 ls) guile> @kbd{(if (memq 4 ls)
(display "hey, it's true!\n") (display "hey, it's true!\n")
(display "dude, it's false\n"))} (display "dude, it's false\n"))}
@print{hey, it's true!} @print{} hey, it's true!
@result{} @result{}
guile> @kbd{(if (memq 12 ls) guile> @kbd{(if (memq 12 ls)
(display "hey, it's true!\n") (display "hey, it's true!\n")
(display "dude, it's false\n"))} (display "dude, it's false\n"))}
@print{dude, it's false} @print{} dude, it's false
@result{} @result{}
guile> @kbd{(memq 4 (reverse ls))} guile> @kbd{(memq 4 (reverse ls))}
@result{} (4 3 2 1) @result{} (4 3 2 1)
@ -583,7 +583,7 @@ guile> @kbd{v}
@end smalllisp @end smalllisp
@subsection Using recursion to process lists @section Using recursion to process lists
@cindex recursion @cindex recursion
@cindex list processing @cindex list processing
@ -600,7 +600,7 @@ Here are some typical examples of using recursion to process a list.
@end smalllisp @end smalllisp
@subsection Processing matrices @section Processing matrices
Suppose you have a matrix represented as a list of lists: Suppose you have a matrix represented as a list of lists:
@ -656,9 +656,9 @@ And then invoke it with
(represent-matrix m (represent-matrix m
(lambda (x) (begin (display x) (display " "))) (lambda (x) (begin (display x) (display " ")))
(lambda (l) (begin (display "\n")))) (lambda (l) (begin (display "\n"))))
@print{7 2 1 3 2 8 5 3 6} @print{} 7 2 1 3 2 8 5 3 6
@print{4 1 1 1 3 8 9 8 1} @print{} 4 1 1 1 3 8 9 8 1
@print{5 5 4 8 1 8 2 2 4} @print{} 5 5 4 8 1 8 2 2 4
@end smalllisp @end smalllisp
@cindex objects @cindex objects