From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Noah Lavine Newsgroups: gmane.lisp.guile.devel Subject: [PATCH] Turn on more documentation Date: Wed, 2 May 2012 23:20:53 -0400 Message-ID: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary=bcaec5555114a7c25804bf194ac4 X-Trace: dough.gmane.org 1336015265 23379 80.91.229.3 (3 May 2012 03:21:05 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Thu, 3 May 2012 03:21:05 +0000 (UTC) To: guile-devel Original-X-From: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Thu May 03 05:21:04 2012 Return-path: Envelope-to: guile-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1SPmbF-0006AS-MH for guile-devel@m.gmane.org; Thu, 03 May 2012 05:21:01 +0200 Original-Received: from localhost ([::1]:43160 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SPmbE-0002hZ-Rb for guile-devel@m.gmane.org; Wed, 02 May 2012 23:21:00 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:39444) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SPmbC-0002hL-Jc for guile-devel@gnu.org; Wed, 02 May 2012 23:20:59 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SPmbA-0002Ga-Fc for guile-devel@gnu.org; Wed, 02 May 2012 23:20:58 -0400 Original-Received: from mail-yw0-f41.google.com ([209.85.213.41]:52935) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SPmbA-0002GS-7A for guile-devel@gnu.org; Wed, 02 May 2012 23:20:56 -0400 Original-Received: by yhr47 with SMTP id 47so1727327yhr.0 for ; Wed, 02 May 2012 20:20:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:sender:date:x-google-sender-auth:message-id:subject :from:to:content-type; bh=rDl4ZIXPb+bIpC7vakNH6yvw+njN+mtOSwkqREEPuJY=; b=JWXBB7+gIQ6jnmd9t+v5R944AdaytRAC495HBOL/onW9e3J+K0pttUzntGAXtDqU8F ba/uZOvziYkdJsvg6H5ssSzDt5wPjg1secHb5pcxUBVQwJ0tFkUDEbqgxAX9F9/6aQGD hRkhfDl2n4B/WNBPP8B2bLAQI/k8apE2i2DT0d8TRkBLMZCcFBbwd+yvlLPhTht/tWok XYb6mTtY3XQdZUyQVHqEo+IGfRme4yb3SbpQ+q9et5MVOzFQD0ZO3OzuBKKrIvXGLarE u1YGwVyyv/Wx96qUTFGZ5/YtFfXZXDYA3k3q2lJ8bHw7MkpsJ7P8rHHP2+cE1OJPIHnQ DVEA== Original-Received: by 10.50.220.138 with SMTP id pw10mr259721igc.71.1336015254438; Wed, 02 May 2012 20:20:54 -0700 (PDT) Original-Received: by 10.42.29.200 with HTTP; Wed, 2 May 2012 20:20:53 -0700 (PDT) X-Google-Sender-Auth: B-4Bh5TQNMx67qh-DqHMpTy0LJ4 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 209.85.213.41 X-BeenThere: guile-devel@gnu.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: "Developers list for Guile, the GNU extensibility library" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Original-Sender: guile-devel-bounces+guile-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.devel:14337 Archived-At: --bcaec5555114a7c25804bf194ac4 Content-Type: text/plain; charset=ISO-8859-1 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 --bcaec5555114a7c25804bf194ac4 Content-Type: application/octet-stream; name="0001-Turn-on-documentation-for-more-modules.patch" Content-Disposition: attachment; filename="0001-Turn-on-documentation-for-more-modules.patch" Content-Transfer-Encoding: base64 X-Attachment-Id: f_h1r8vl5a0 RnJvbSBiMTQ0N2QyNTVlNTVmZjE5M2NjNjc1MWZiM2QyMmI4OWM2MDA2MzIxIE1vbiBTZXAgMTcg MDA6MDA6MDAgMjAwMQpGcm9tOiBOb2FoIExhdmluZSA8bm9haC5iLmxhdmluZUBnbWFpbC5jb20+ CkRhdGU6IFdlZCwgMiBNYXkgMjAxMiAyMzowNzo1OCAtMDQwMApTdWJqZWN0OiBbUEFUQ0hdIFR1 cm4gb24gZG9jdW1lbnRhdGlvbiBmb3IgbW9yZSBtb2R1bGVzCgogKiBkb2MvcmVmL3N0YW5kYXJk LWxpYnJhcnkuc2NtICgqbW9kdWxlcyopOiBhZGQKICAoaWNlLTkgYmluYXJ5LXBvcnRzKSwgKGlj ZS05IGNvbW1vbi1saXN0KSwgKGljZS05IGRvY3VtZW50YXRpb24pLAogIChpY2UtOSBnYXAtYnVm ZmVyKSwgKGljZS05IHJ1bnEpLCAoaWNlLTkgc2VyaWFsaXplKSwgYW5kCiAgKGljZS05IHRpbWUp LgogKiBkb2MvcmVmL3N0YW5kYXJkLWxpYnJhcnkuYW06IGF1dG9tYXRpY2FsbHkgZ2VuZXJhdGVk IGZyb20KICBkb2MvcmVmL3N0YW5kYXJkLWxpYnJhcnkuc2NtLgotLS0KIGRvYy9yZWYvc3RhbmRh cmQtbGlicmFyeS5hbSAgfCAgICAyICstCiBkb2MvcmVmL3N0YW5kYXJkLWxpYnJhcnkuc2NtIHwg ICAxNiArKysrKysrKysrKysrKystCiAyIGZpbGVzIGNoYW5nZWQsIDE2IGluc2VydGlvbnMoKyks IDIgZGVsZXRpb25zKC0pCgpkaWZmIC0tZ2l0IGEvZG9jL3JlZi9zdGFuZGFyZC1saWJyYXJ5LmFt IGIvZG9jL3JlZi9zdGFuZGFyZC1saWJyYXJ5LmFtCmluZGV4IDI3MjQ2ZjQuLmY5MDI0NjMgMTAw NjQ0Ci0tLSBhL2RvYy9yZWYvc3RhbmRhcmQtbGlicmFyeS5hbQorKysgYi9kb2MvcmVmL3N0YW5k YXJkLWxpYnJhcnkuYW0KQEAgLTEsMiArMSwyIEBACiAjIEF1dG9tYXRpY2FsbHkgZ2VuZXJhdGVk LCBkbyBub3QgZWRpdC4KLXN0YW5kYXJkX2xpYnJhcnlfc2NtX2ZpbGVzID0gJCh0b3Bfc3JjZGly KS9tb2R1bGUvc3RhdHByb2Yuc2NtICQodG9wX3NyY2RpcikvbW9kdWxlL3N4bWwvYXBwbHktdGVt cGxhdGVzLnNjbSAkKHRvcF9zcmNkaXIpL21vZHVsZS9zeG1sL2ZvbGQuc2NtICQodG9wX3NyY2Rp cikvbW9kdWxlL3N4bWwvc2ltcGxlLnNjbSAkKHRvcF9zcmNkaXIpL21vZHVsZS9zeG1sL3NzYXgu c2NtICQodG9wX3NyY2RpcikvbW9kdWxlL3N4bWwvc3NheC9pbnB1dC1wYXJzZS5zY20gJCh0b3Bf c3JjZGlyKS9tb2R1bGUvc3htbC90cmFuc2Zvcm0uc2NtICQodG9wX3NyY2RpcikvbW9kdWxlL3N4 bWwveHBhdGguc2NtICQodG9wX3NyY2RpcikvbW9kdWxlL3RleGluZm8uc2NtICQodG9wX3NyY2Rp cikvbW9kdWxlL3RleGluZm8vZG9jYm9vay5zY20gJCh0b3Bfc3JjZGlyKS9tb2R1bGUvdGV4aW5m by9odG1sLnNjbSAkKHRvcF9zcmNkaXIpL21vZHVsZS90ZXhpbmZvL2luZGV4aW5nLnNjbSAkKHRv cF9zcmNkaXIpL21vZHVsZS90ZXhpbmZvL3N0cmluZy11dGlscy5zY20gJCh0b3Bfc3JjZGlyKS9t b2R1bGUvdGV4aW5mby9wbGFpbi10ZXh0LnNjbSAkKHRvcF9zcmNkaXIpL21vZHVsZS90ZXhpbmZv L3NlcmlhbGl6ZS5zY20gJCh0b3Bfc3JjZGlyKS9tb2R1bGUvdGV4aW5mby9yZWZsZWN0aW9uLnNj bSAKXCBObyBuZXdsaW5lIGF0IGVuZCBvZiBmaWxlCitzdGFuZGFyZF9saWJyYXJ5X3NjbV9maWxl cyA9ICQodG9wX3NyY2RpcikvbW9kdWxlL3N0YXRwcm9mLnNjbSAkKHRvcF9zcmNkaXIpL21vZHVs ZS9zeG1sL2FwcGx5LXRlbXBsYXRlcy5zY20gJCh0b3Bfc3JjZGlyKS9tb2R1bGUvc3htbC9mb2xk LnNjbSAkKHRvcF9zcmNkaXIpL21vZHVsZS9zeG1sL3NpbXBsZS5zY20gJCh0b3Bfc3JjZGlyKS9t b2R1bGUvc3htbC9zc2F4LnNjbSAkKHRvcF9zcmNkaXIpL21vZHVsZS9zeG1sL3NzYXgvaW5wdXQt cGFyc2Uuc2NtICQodG9wX3NyY2RpcikvbW9kdWxlL3N4bWwvdHJhbnNmb3JtLnNjbSAkKHRvcF9z cmNkaXIpL21vZHVsZS9zeG1sL3hwYXRoLnNjbSAkKHRvcF9zcmNkaXIpL21vZHVsZS90ZXhpbmZv LnNjbSAkKHRvcF9zcmNkaXIpL21vZHVsZS90ZXhpbmZvL2RvY2Jvb2suc2NtICQodG9wX3NyY2Rp cikvbW9kdWxlL3RleGluZm8vaHRtbC5zY20gJCh0b3Bfc3JjZGlyKS9tb2R1bGUvdGV4aW5mby9p bmRleGluZy5zY20gJCh0b3Bfc3JjZGlyKS9tb2R1bGUvdGV4aW5mby9zdHJpbmctdXRpbHMuc2Nt ICQodG9wX3NyY2RpcikvbW9kdWxlL3RleGluZm8vcGxhaW4tdGV4dC5zY20gJCh0b3Bfc3JjZGly KS9tb2R1bGUvdGV4aW5mby9zZXJpYWxpemUuc2NtICQodG9wX3NyY2RpcikvbW9kdWxlL3RleGlu Zm8vcmVmbGVjdGlvbi5zY20gJCh0b3Bfc3JjZGlyKS9tb2R1bGUvaWNlLTkvYmluYXJ5LXBvcnRz LnNjbSAkKHRvcF9zcmNkaXIpL21vZHVsZS9pY2UtOS9jb21tb24tbGlzdC5zY20gJCh0b3Bfc3Jj ZGlyKS9tb2R1bGUvaWNlLTkvZG9jdW1lbnRhdGlvbi5zY20gJCh0b3Bfc3JjZGlyKS9tb2R1bGUv aWNlLTkvZ2FwLWJ1ZmZlci5zY20gJCh0b3Bfc3JjZGlyKS9tb2R1bGUvaWNlLTkvcnVucS5zY20g JCh0b3Bfc3JjZGlyKS9tb2R1bGUvaWNlLTkvc2VyaWFsaXplLnNjbSAkKHRvcF9zcmNkaXIpL21v ZHVsZS9pY2UtOS90aW1lLnNjbSAKXCBObyBuZXdsaW5lIGF0IGVuZCBvZiBmaWxlCmRpZmYgLS1n aXQgYS9kb2MvcmVmL3N0YW5kYXJkLWxpYnJhcnkuc2NtIGIvZG9jL3JlZi9zdGFuZGFyZC1saWJy YXJ5LnNjbQppbmRleCA3ZmQxN2I1Li4yODY5YzJlIDEwMDY0NAotLS0gYS9kb2MvcmVmL3N0YW5k YXJkLWxpYnJhcnkuc2NtCisrKyBiL2RvYy9yZWYvc3RhbmRhcmQtbGlicmFyeS5zY20KQEAgLTMz LDcgKzMzLDIxIEBACiAgICAgKCh0ZXhpbmZvIHNlcmlhbGl6ZSkKICAgICAgIlJlbmRlciAiIChj b2RlICJzdGV4aSIpICIgYXMgdGV4aW5mbyIpCiAgICAgKCh0ZXhpbmZvIHJlZmxlY3Rpb24pCi0g ICAgICJFbmFibGUgdGV4aW5mbyBhY3Jvc3MgR3VpbGUncyBoZWxwIHN5c3RlbSIpKSkKKyAgICAg IkVuYWJsZSB0ZXhpbmZvIGFjcm9zcyBHdWlsZSdzIGhlbHAgc3lzdGVtIikKKyAgICAoKGljZS05 IGJpbmFyeS1wb3J0cykKKyAgICAgIkFjY2VzcyB0byBiaW5hcnkgcG9ydHMiKQorICAgICgoaWNl LTkgY29tbW9uLWxpc3QpCisgICAgICJMaXN0IG1hbmlwdWxhdGlvbiBmdW5jdGlvbnMgZnJvbSBD b21tb24gTGlzcCIpCisgICAgKChpY2UtOSBkb2N1bWVudGF0aW9uKQorICAgICAiR2VuZXJhdGUg ZG9jdW1lbnRhdGlvbiBmcm9tIHNvdXJjZSBmaWxlcyIpCisgICAgKChpY2UtOSBnYXAtYnVmZmVy KQorICAgICAiU3RyaW5ncyB3aXRoIGZhc3QgaW5zZXJ0aW9uIikKKyAgICAoKGljZS05IHJ1bnEp CisgICAgICJSdW4gdGFza3MgZnJvbSBhIHF1ZXVlIikKKyAgICAoKGljZS05IHNlcmlhbGl6ZSkK KyAgICAgIlN5bnRheCBmb3IgbXVsdGl0aHJlYWRpbmciKQorICAgICgoaWNlLTkgdGltZSkKKyAg ICAgIlNlZSBob3cgbG9uZyB0aGluZ3MgdGFrZSB0byBydW4iKSkpCiAKIChkZWZpbmUgKm1vZHVs ZS1zb3VyY2VzKgogICAnKCgoc3htbCBzc2F4KSAuICJodHRwOi8vc3NheC5zb3VyY2Vmb3JnZS5u ZXQvIikKLS0gCjEuNy42Cgo= --bcaec5555114a7c25804bf194ac4--