[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Patch: New section "Invoking Guile" for chapter "Programming in Sche
From: |
Andy Wingo |
Subject: |
Re: Patch: New section "Invoking Guile" for chapter "Programming in Scheme" |
Date: |
Sun, 24 Apr 2011 16:33:44 +0200 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/23.2 (gnu/linux) |
On Sat 23 Apr 2011 21:46, Mark Harig <address@hidden> writes:
> Here is a set of patches to add the new section "Invoking Guile" to
> the chapter "Programming in Scheme."
They look good in general, though I have some comments. I would like
Neil to look over them as well, or at least say he's OK with them.
First, your patches should be "atomic"; see
http://www.kernel.org/pub/software/scm/git/docs/user-manual.html#patch-series
for some commentary. In particular see point 3. The manual should be
working after each patch.
The commit logs are good.
> address@hidden -s @var{script} @var{arg...}
> address@hidden script mode
> +Read and evaluate Scheme source code from the file @var{script}, as the
> address@hidden function would. After loading @var{script}, exit. Any
> +command-line arguments @var{arg...} following @var{script} become the
> +script's arguments; the @code{command-line} function returns a list of
> +strings of the form @code{(@var{script} @var{arg...})}.
The "-s" is actually optional, and only *needed* if your script starts
with a dash. So please document "guile foo.scm" as the default, and
just mention "-s" in case of the script starting with a dash, or if you
are writing some other shell script. Use @itemx in this case, I think.
> +strings, even those that are written as numerals. (Note that here we
> +are referring to names and values that are defined in the operating
> +system shell from which Guile is invoked. This is not the same as a
> +Scheme environment that is defined within a running instance of guile.
"Guile", I think.
> +How to set environment variables before starting Guile depends on the
> +operating system, and especially the shell that you are using. For
> +example, here's how to set the environment variable @env{ORGANIZATION}
> +to @samp{not very much} using Bash:
> +
> address@hidden
> +export ORGANIZATION="not very much"
> address@hidden example
> +
> address@hidden
> +and here's how to do it in csh or tcsh:
> +
> address@hidden
> +setenv ORGANIZATION "not very much"
> address@hidden example
Perhaps the tcsh example is superfluous. Perhaps we should also mention
the way to set env vars for one invocation: "GUILE_AUTO_COMPILE=0
guile".
> +If you wish to retrieve or change the value of the shell environment
> +variables that effect the run-time behavior of Guile from within a
> +running instance of guile, see @xref{Runtime Environment}.
"affect"
> address@hidden GUILE_HUSH
> address@hidden GUILE_HUSH
> +The @code{#/} notation for lists provokes a warning message from Guile.
> +This syntax will be removed from Guile in the near future.
> +
> +To disable the warning message, set the @env{GUILE_HUSH} environment
> +variable to any non-empty value.
This variable does not exist.
> address@hidden GUILE_INIT_MALLOC_LIMIT
> address@hidden GUILE_INIT_MALLOC_LIMIT
> address@hidden GUILE_MIN_YIELD_MALLOC
> address@hidden GUILE_MIN_YIELD_MALLOC
> address@hidden garbage collecting
> address@hidden GUILE_MAX_SEGMENT_SIZE
> address@hidden GUILE_MAX_SEGMENT_SIZE
> address@hidden GUILE_INIT_SEGMENT_SIZE_2
> address@hidden GUILE_INIT_SEGMENT_SIZE_2
> address@hidden GUILE_INIT_SEGMENT_SIZE_1
> address@hidden GUILE_INIT_SEGMENT_SIZE_1
> address@hidden GUILE_MIN_YIELD_2
> address@hidden GUILE_MIN_YIELD_2
Since switching to the BDW GC, these variables are not used any more.
GC_FREE_SPACE_DIVISOR is parsed by Guile though. The GC itself does
appear to do a number of getenv calls, but we can't really document
those in Guile I don't think.
> address@hidden GUILE_SYSTEM_LOAD_COMPILED_PATH
> address@hidden GUILE_SYSTEM_PATH
> address@hidden GUILE_SYSTEM_LTDL_PATH
These are paths that Guile itself uses to look up .go, .scm, and .so
files, respectively. They have default values, relative to $prefix, but
can be overridden if you really know what you're doing. This is only
really useful when building Guile itself.
> address@hidden GUILE_INIT_SEGMENT_SIZE_1
> address@hidden GUILE_MIN_YIELD_1
> address@hidden GUILE_INIT_SEGMENT_SIZE_2
> address@hidden GUILE_MIN_YIELD_2
> address@hidden GUILE_MAX_SEGMENT_SIZE
> address@hidden GUILE_INIT_HEAP_SIZE_1
> address@hidden GUILE_INIT_HEAP_SIZE_2
Not used any more.
> address@hidden GUILE_WARN_DEPRECATED
> address@hidden GUILE_WARN_DEPRECATED
> +Please provide a description of me.
@ref to Deprecation.
address@hidden:~/src/guile$ meta/guile
GNU Guile 2.0.0.202-514ff6
Copyright (C) 1995-2011 Free Software Foundation, Inc.
Guile comes with ABSOLUTELY NO WARRANTY; for details type `,show w'.
This program is free software, and you are welcome to redistribute it
under certain conditions; type `,show c' for details.
Enter `,help' for help.
scheme@(guile-user)> (feature? 'foo)
$1 = #f
scheme@(guile-user)>
Some deprecated features have been used. Set the environment
variable GUILE_WARN_DEPRECATED to "detailed" and rerun the
program to get more information. Set it to "no" to suppress
this message.
address@hidden:~/src/guile$ GUILE_WARN_DEPRECATED=detailed meta/guile
GNU Guile 2.0.0.202-514ff6
Copyright (C) 1995-2011 Free Software Foundation, Inc.
Guile comes with ABSOLUTELY NO WARRANTY; for details type `,show w'.
This program is free software, and you are welcome to redistribute it
under certain conditions; type `,show c' for details.
Enter `,help' for help.
scheme@(guile-user)> (feature? 'foo)
`feature?' is deprecated. Use `provided?' instead.
$1 = #f
scheme@(guile-user)>
address@hidden:~/src/guile$
Otherwise, looking very good. Thank you for this work, and looking
forward to the revised patchset :-)
Cheers,
Andy
--
http://wingolog.org/
- Patch: New section "Invoking Guile" for chapter "Programming in Scheme", Mark Harig, 2011/04/23
- Re: Patch: New section "Invoking Guile" for chapter "Programming in Scheme",
Andy Wingo <=
- Re: Patch: New section "Invoking Guile" for chapter "Programming in Scheme", Mark Harig, 2011/04/24
- Re: Patch: New section "Invoking Guile" for chapter "Programming in Scheme", David Pirotte, 2011/04/24
- Re: Indexing Scheme and C identifiers separately, Mark Harig, 2011/04/24
- Re: Indexing Scheme and C identifiers separately, Noah Lavine, 2011/04/24
- Re: Indexing Scheme and C identifiers separately, David Pirotte, 2011/04/25
- Re: Patch: New section "Invoking Guile" for chapter "Programming in Scheme", Mark Harig, 2011/04/25
- Re: Patch: New section "Invoking Guile" for chapter "Programming in Scheme", Neil Jerram, 2011/04/26