From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Alan Grover Newsgroups: gmane.lisp.guile.bugs Subject: Unclear documentation: "Options and Config", set! and enable/disable Date: Tue, 21 Jun 2005 11:55:40 -0400 Message-ID: <42B8387C.4040903@mail.msen.com> NNTP-Posting-Host: main.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="===============0672101066==" X-Trace: sea.gmane.org 1119443823 14074 80.91.229.2 (22 Jun 2005 12:37:03 GMT) X-Complaints-To: usenet@sea.gmane.org NNTP-Posting-Date: Wed, 22 Jun 2005 12:37:03 +0000 (UTC) Original-X-From: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Wed Jun 22 14:36:55 2005 Return-path: Original-Received: from lists.gnu.org ([199.232.76.165]) by ciao.gmane.org with esmtp (Exim 4.43) id 1Dl4Sh-0001fd-Si for guile-bugs@m.gmane.org; Wed, 22 Jun 2005 14:36:12 +0200 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Dl4YF-0000Rg-9J for guile-bugs@m.gmane.org; Wed, 22 Jun 2005 08:41:55 -0400 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1Dklqh-0008QF-BR for bug-guile@gnu.org; Tue, 21 Jun 2005 12:43:43 -0400 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1DkloT-0007OE-Eo for bug-guile@gnu.org; Tue, 21 Jun 2005 12:41:27 -0400 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1Dkln7-0006Z0-C7 for bug-guile@gnu.org; Tue, 21 Jun 2005 12:40:01 -0400 Original-Received: from [148.59.80.48] (helo=ww8.msen.com) by monty-python.gnu.org with esmtp (TLS-1.0:DHE_RSA_3DES_EDE_CBC_SHA:24) (Exim 4.34) id 1DklcS-00066P-5t for bug-guile@gnu.org; Tue, 21 Jun 2005 12:29:00 -0400 X-Sent-To: Original-Received: from [192.168.1.220] (pool-151-196-47-245.balt.east.verizon.net [151.196.47.245]) (authenticated bits=0) by ww8.msen.com (8.13.3/8.13.3) with ESMTP id j5LGPrYA007056 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT) for ; Tue, 21 Jun 2005 12:25:55 -0400 (EDT) (envelope-from awgrover@mail.msen.com) User-Agent: Mozilla Thunderbird 1.0.2 (X11/20050317) X-Accept-Language: en-us, en Original-To: bug-guile@gnu.org X-Enigmail-Version: 0.91.0.0 OpenPGP: id=5074AF60; url= X-Milter: Spamilter (Reciever: ww8.msen.com; Sender-ip: 151.196.47.245; Sender-helo: [192.168.1.220]; ) X-Mailman-Approved-At: Wed, 22 Jun 2005 08:41:25 -0400 X-BeenThere: bug-guile@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GUILE, GNU's Ubiquitous Extension Language" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Errors-To: bug-guile-bounces+guile-bugs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.lisp.guile.bugs:3026 X-Report-Spam: http://spam.gmane.org/gmane.lisp.guile.bugs:3026 This is an OpenPGP/MIME signed message (RFC 2440 and 3156) --===============0672101066== Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="------------enig7BF1FCF2B9F3C3C1FEEEC8C2" This is an OpenPGP/MIME signed message (RFC 2440 and 3156) --------------enig7BF1FCF2B9F3C3C1FEEEC8C2 Content-Type: text/plain; charset=ISO-8859-1 Content-Transfer-Encoding: 7bit Guile 1.6.4 Documentation guile-1.6.4/doc/ref/guile_36.html Summary: It isn't clear from the documentation how to use the "User Level Options Interfaces" (chapter "Configuration, Features and Runtime Options"). In particular, it isn't clear when the "option-symbol" should not be quoted. I lost quite a bit of time before I realized that -set! are macros. Example/notes: (debug-set! 'width 80) => Unknown mode flag: (quote width) (debug-set! width 80) => ok (debug-enable 'breakpoints) -> ok (debug-enable breakpoints) -> Unbound variable: breakpoints Apparently, all of the -set! are macros, and interpret the first argument as a symbol. Perhaps this was an attempt to make this interface appear analogous to set!, despite the option-symbols not being defined/bound. In contrast, the -enable/-disable are procedures, and thus you have to pass a symbol as the first argument. Suggested changes: I would suggest the following: In "User Level Options Interfaces" (section 33.3.2 of my manual), in the subsection on -set!, add some verbiage like: These are macros, the first argument is the name of the option: do not quote it. E.g. (print-set! closure-hook some-fn). And, in the two subsections on -disable/:w -enable: These are procedures, the first argument is a symbol. E.g. (read-enable 'case-insensitive). If possible, -set! should give a more helpful error message when it is expecting a (unquoted) symbol but sees a list. While you're at it, the "Low Level Options Interfaces" (section 33.3.1) is unclear. At least give a working example of each argument-list variation. -- Alan Grover awgrover@mail.msen.com +1.734.476.0969 --------------enig7BF1FCF2B9F3C3C1FEEEC8C2 Content-Type: application/pgp-signature; name="signature.asc" Content-Description: OpenPGP digital signature Content-Disposition: attachment; filename="signature.asc" -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.5 (GNU/Linux) Comment: Using GnuPG with Thunderbird - http://enigmail.mozdev.org iD8DBQFCuDiAbLLh2VB0r2ARAvdvAJ9eELI5/V32ea+MIap3ZEhTGRvk5gCfZNAf vC3+dxNHAYgvWVDsT9zmC2c= =FZuG -----END PGP SIGNATURE----- --------------enig7BF1FCF2B9F3C3C1FEEEC8C2-- --===============0672101066== Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Content-Disposition: inline _______________________________________________ Bug-guile mailing list Bug-guile@gnu.org http://lists.gnu.org/mailman/listinfo/bug-guile --===============0672101066==--