unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
* [PATCH] Turn on more documentation
@ 2012-05-03  3:20 Noah Lavine
  2012-05-03 22:07 ` Noah Lavine
  2012-05-06 10:14 ` Ludovic Courtès
  0 siblings, 2 replies; 15+ messages in thread
From: Noah Lavine @ 2012-05-03  3:20 UTC (permalink / raw)
  To: guile-devel

[-- Attachment #1: Type: text/plain, Size: 1249 bytes --]

Hello all,

As part of my investigation into modules that don't have
documentation, I discovered that several modules in ice-9/ actually
have usable documentation that we are just not using in our build
process. (For reference, everything in the "Standard Library" section
of the manual is snarfed from .scm source files.) This patch makes
Guile build documentation for (ice-9 binary-ports), (ice-9
common-list), (ice-9 documentation), (ice-9 gap-buffer), (ice-9 runq),
(ice-9 serialize), and (ice-9 time). It gets incorporated into the
manual as part of the "Standard Library" section.

This seems like an easy way to get documentation for a few more
modules. What do you think?

(You may have to do "rm doc/ref/standard-library.texi && rm
doc/ref/guile.info*" in order to build with the change. The makefile
doesn't know about all of the dependencies that it should.)

I also discovered while working on this that several modules have
in-line commentary and also hand-written texinfo pages. The list is
expect.scm, ftw.scm, futures.scm, getopt-long.scm, i18n.scm,
optargs.scm, q.scm, regex.scm, threads.scm, and vlist.scm. Was there a
reason for this? Perhaps the inline documentation format isn't as
flexible as writing it by hand?

Thanks,
Noah

[-- Attachment #2: 0001-Turn-on-documentation-for-more-modules.patch --]
[-- Type: application/octet-stream, Size: 3494 bytes --]

From b1447d255e55ff193cc6751fb3d22b89c6006321 Mon Sep 17 00:00:00 2001
From: Noah Lavine <noah.b.lavine@gmail.com>
Date: Wed, 2 May 2012 23:07:58 -0400
Subject: [PATCH] Turn on documentation for more modules

 * doc/ref/standard-library.scm (*modules*): add
  (ice-9 binary-ports), (ice-9 common-list), (ice-9 documentation),
  (ice-9 gap-buffer), (ice-9 runq), (ice-9 serialize), and
  (ice-9 time).
 * doc/ref/standard-library.am: automatically generated from
  doc/ref/standard-library.scm.
---
 doc/ref/standard-library.am  |    2 +-
 doc/ref/standard-library.scm |   16 +++++++++++++++-
 2 files changed, 16 insertions(+), 2 deletions(-)

diff --git a/doc/ref/standard-library.am b/doc/ref/standard-library.am
index 27246f4..f902463 100644
--- a/doc/ref/standard-library.am
+++ b/doc/ref/standard-library.am
@@ -1,2 +1,2 @@
 # Automatically generated, do not edit.
-standard_library_scm_files = $(top_srcdir)/module/statprof.scm $(top_srcdir)/module/sxml/apply-templates.scm $(top_srcdir)/module/sxml/fold.scm $(top_srcdir)/module/sxml/simple.scm $(top_srcdir)/module/sxml/ssax.scm $(top_srcdir)/module/sxml/ssax/input-parse.scm $(top_srcdir)/module/sxml/transform.scm $(top_srcdir)/module/sxml/xpath.scm $(top_srcdir)/module/texinfo.scm $(top_srcdir)/module/texinfo/docbook.scm $(top_srcdir)/module/texinfo/html.scm $(top_srcdir)/module/texinfo/indexing.scm $(top_srcdir)/module/texinfo/string-utils.scm $(top_srcdir)/module/texinfo/plain-text.scm $(top_srcdir)/module/texinfo/serialize.scm $(top_srcdir)/module/texinfo/reflection.scm 
\ No newline at end of file
+standard_library_scm_files = $(top_srcdir)/module/statprof.scm $(top_srcdir)/module/sxml/apply-templates.scm $(top_srcdir)/module/sxml/fold.scm $(top_srcdir)/module/sxml/simple.scm $(top_srcdir)/module/sxml/ssax.scm $(top_srcdir)/module/sxml/ssax/input-parse.scm $(top_srcdir)/module/sxml/transform.scm $(top_srcdir)/module/sxml/xpath.scm $(top_srcdir)/module/texinfo.scm $(top_srcdir)/module/texinfo/docbook.scm $(top_srcdir)/module/texinfo/html.scm $(top_srcdir)/module/texinfo/indexing.scm $(top_srcdir)/module/texinfo/string-utils.scm $(top_srcdir)/module/texinfo/plain-text.scm $(top_srcdir)/module/texinfo/serialize.scm $(top_srcdir)/module/texinfo/reflection.scm $(top_srcdir)/module/ice-9/binary-ports.scm $(top_srcdir)/module/ice-9/common-list.scm $(top_srcdir)/module/ice-9/documentation.scm $(top_srcdir)/module/ice-9/gap-buffer.scm $(top_srcdir)/module/ice-9/runq.scm $(top_srcdir)/module/ice-9/serialize.scm $(top_srcdir)/module/ice-9/time.scm 
\ No newline at end of file
diff --git a/doc/ref/standard-library.scm b/doc/ref/standard-library.scm
index 7fd17b5..2869c2e 100644
--- a/doc/ref/standard-library.scm
+++ b/doc/ref/standard-library.scm
@@ -33,7 +33,21 @@
     ((texinfo serialize)
      "Render " (code "stexi") " as texinfo")
     ((texinfo reflection)
-     "Enable texinfo across Guile's help system")))
+     "Enable texinfo across Guile's help system")
+    ((ice-9 binary-ports)
+     "Access to binary ports")
+    ((ice-9 common-list)
+     "List manipulation functions from Common Lisp")
+    ((ice-9 documentation)
+     "Generate documentation from source files")
+    ((ice-9 gap-buffer)
+     "Strings with fast insertion")
+    ((ice-9 runq)
+     "Run tasks from a queue")
+    ((ice-9 serialize)
+     "Syntax for multithreading")
+    ((ice-9 time)
+     "See how long things take to run")))
 
 (define *module-sources*
   '(((sxml ssax) . "http://ssax.sourceforge.net/")
-- 
1.7.6


^ permalink raw reply related	[flat|nested] 15+ messages in thread

end of thread, other threads:[~2012-05-16  0:19 UTC | newest]

Thread overview: 15+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2012-05-03  3:20 [PATCH] Turn on more documentation Noah Lavine
2012-05-03 22:07 ` Noah Lavine
2012-05-06 10:14 ` Ludovic Courtès
2012-05-07 12:30   ` Noah Lavine
2012-05-07 14:31     ` Ludovic Courtès
2012-05-12 20:56       ` Noah Lavine
2012-05-14 12:47         ` Ludovic Courtès
2012-05-14 14:05           ` Noah Lavine
2012-05-14 15:00             ` Ludovic Courtès
2012-05-14 15:14               ` Noah Lavine
2012-05-15 20:24                 ` Andy Wingo
2012-05-15 21:25                   ` Ludovic Courtès
2012-05-16  0:19                     ` Noah Lavine
2012-05-14 21:26             ` dsmich
2012-05-15 20:19   ` Andy Wingo

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).