GNU bug report logs - #72208
[PATCH] doc: tour: note the top-level modules ice-9, scheme, and srfi

Previous Next

To reply to this bug, email your comments to 72208 AT debbugs.gnu.org.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Dr. Arne Babenhauserheide" <arne_bab <at> web.de>
To: guile-devel <at> gnu.org, bug-guile <at> gnu.org
Subject: [PATCH] doc: tour: note the top-level modules ice-9, scheme, and srfi
Date: Sat, 20 Jul 2024 15:11:41 +0200

[Message part 1 (text/plain, inline)]

Hi,

the attached patch is a companion to the thread "The Guile junk drawer
and a C plea" in guile-devel.

Its goal is to ensure that newcomers learn early about the main module
prefixes provided by Guile: (scheme ...), (srfi ...), and (ice-9 ...).

[0001-doc-reference-ice-9-scheme-and-srfi.patch (text/x-patch, inline)]

From 929f5075be5d21c552e91931aca4a68fde348e21 Mon Sep 17 00:00:00 2001
From: Arne Babenhauserheide <arne_bab <at> web.de>
Date: Sat, 20 Jul 2024 15:03:15 +0200
Subject: [PATCH] doc: reference ice-9, scheme, and srfi

* doc/ref/tour.texi (Using Modules): reference ice-9, scheme, and srfi.
---
 doc/ref/tour.texi | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/ref/tour.texi b/doc/ref/tour.texi
index c0ecb1699..7142394a5 100644
--- a/doc/ref/tour.texi
+++ b/doc/ref/tour.texi
@@ -210,6 +210,15 @@ processing or command line parsing.  Additionally, there exist many
 Guile modules written by other Guile hackers, but which have to be
 installed manually.
 
+Most provided modules use one of three different prefixes:
+
+@itemize @bullet
+@item @code{ice-9} includes guile-specific modules: the standard library of Guile. @xref{Status, History of ice-9, History of ice-9}
+@item @code{scheme} includes modules from the RnRS standard: @url{https://standards.scheme.org/}.
+@item @code{srfi} includes Scheme Requests For Implementation; SRFI’s: @url{https://srfi.schemers.org/}.
+@end itemize
+
+
 Here is a sample interactive session that shows how to use the
 @code{(ice-9 popen)} module which provides the means for communicating
 with other processes over pipes together with the @code{(ice-9
-- 
2.45.1

[Message part 3 (text/plain, inline)]

There may be more places where it could be useful to add references, so
newcomers are guided to easily know their way around what Guile
provides. This is the most obvious place I found, so I started there.

Best wishes,
Arne
-- 
Unpolitisch sein
heißt politisch sein,
ohne es zu merken.
draketo.de

[signature.asc (application/pgp-signature, inline)]

Message #8 received at 72208 <at> debbugs.gnu.org (full text, mbox):

From: "Dr. Arne Babenhauserheide" <arne_bab <at> web.de>
To: 72208 <at> debbugs.gnu.org
Cc: guile-devel <at> gnu.org
Subject: bug#72208 [PATCH] doc: tour: note the top-level modules ice-9,
 scheme, and srfi
Date: Sat, 20 Jul 2024 17:03:01 +0200

[Message part 1 (text/plain, inline)]

Hi,

Following my answer in the discussion (after checking the non-ice-9
prefixes), this may be a better representation of the modules Guile
provides:

[0001-doc-reference-ice-9-scheme-and-srfi.patch (text/x-patch, inline)]

From 6838e4da9712425e7e45805a73731bb399d90a86 Mon Sep 17 00:00:00 2001
From: Arne Babenhauserheide <arne_bab <at> web.de>
Date: Sat, 20 Jul 2024 15:03:15 +0200
Subject: [PATCH] doc: reference ice-9, scheme, and srfi

* doc/ref/tour.texi (Using Modules): reference ice-9, scheme, and srfi.
---
 doc/ref/tour.texi | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/ref/tour.texi b/doc/ref/tour.texi
index c0ecb1699..91eb10bb9 100644
--- a/doc/ref/tour.texi
+++ b/doc/ref/tour.texi
@@ -210,6 +210,16 @@ processing or command line parsing.  Additionally, there exist many
 Guile modules written by other Guile hackers, but which have to be
 installed manually.
 
+Most provided modules use prefixes based on their origin:
+
+@itemize @bullet
+@item @code{ice-9} includes guile-specific modules: the standard library of Guile. @xref{Status, History of ice-9, History of ice-9}
+@item @code{rnrs} and @code{scheme} include modules from the RnRS standard (@url{https://standards.scheme.org/}). @xref{R7RS Support} and @xref{R6RS Support}
+@item @code{srfi} includes Scheme Requests For Implementation; SRFI’s (@url{https://srfi.schemers.org/}). @xref{SRFI Support}
+@item Some larger features have their own prefix. These include @code{web} (@pxref{Web}), @code{oop} (@xref{GOOPS}), @code{sxml} (@pxref{SXML}), and @code{language} (@pxref{Other Languages}).
+@end itemize
+
+
 Here is a sample interactive session that shows how to use the
 @code{(ice-9 popen)} module which provides the means for communicating
 with other processes over pipes together with the @code{(ice-9
-- 
2.45.1

[Message part 3 (text/plain, inline)]

Best wishes,
Arne
-- 
Unpolitisch sein
heißt politisch sein,
ohne es zu merken.
draketo.de

[signature.asc (application/pgp-signature, inline)]

Message #11 received at 72208 <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: "Dr. Arne Babenhauserheide" <arne_bab <at> web.de>
Cc: 72208 <at> debbugs.gnu.org, guile-devel <at> gnu.org
Subject: Re: bug#72208: [PATCH] doc: tour: note the top-level modules ice-9,
 scheme, and srfi
Date: Sat, 26 Oct 2024 19:27:04 +0200

Hello,

"Dr. Arne Babenhauserheide" <arne_bab <at> web.de> skribis:

> From 6838e4da9712425e7e45805a73731bb399d90a86 Mon Sep 17 00:00:00 2001
> From: Arne Babenhauserheide <arne_bab <at> web.de>
> Date: Sat, 20 Jul 2024 15:03:15 +0200
> Subject: [PATCH] doc: reference ice-9, scheme, and srfi
>
> * doc/ref/tour.texi (Using Modules): reference ice-9, scheme, and srfi.

Good idea!

> +Most provided modules use prefixes based on their origin:
> +
> +@itemize @bullet
> +@item @code{ice-9} includes guile-specific modules: the standard library of Guile. @xref{Status, History of ice-9, History of ice-9}

s/guile/Guile/

Also: please leave two spaces after an end-of-sentence period and add a
semicolon at the end of the line.

> +@item @code{rnrs} and @code{scheme} include modules from the RnRS standard (@url{https://standards.scheme.org/}). @xref{R7RS Support} and @xref{R6RS Support}

s/RnRS standard/Scheme standards/

Likewise, semicolon at the end of the line

> +@item @code{srfi} includes Scheme Requests For Implementation; SRFI’s (@url{https://srfi.schemers.org/}). @xref{SRFI Support}

Rather:

  … includes @uref{https://srfi.schemers.org/, Scheme Requests for
  Implementation or ``SRFIs''} (@pxref{SRFI Support});

> +@item Some larger features have their own prefix. These include @code{web} (@pxref{Web}), @code{oop} (@xref{GOOPS}), @code{sxml} (@pxref{SXML}), and @code{language} (@pxref{Other Languages}).

s/@xref{GOOPS}/@pxref{GOOPS}/ (since it’s in parentheses)

Fine with me with these changes!

Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.