1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-02 13:00:26 +02:00
Commit graph

1820 commits

Author SHA1 Message Date
Andy Wingo
21476d8472 update tour.texi examples
* doc/ref/tour.texi (Running Guile Interactively): Update examples for
  formatting.
2010-07-16 17:35:43 +02:00
Andy Wingo
04ca20430b tour.texi updates
* doc/ref/tour.texi: Update Guile prompts for
  scheme@(guile-user)>. Update output to assume value-history is on. Lop
  and crop the bug reporting section -- it was too long.
2010-07-16 17:35:43 +02:00
Andy Wingo
3c0b7725ef update debugger docs
* doc/ref/api-debug.texi (Debug on Error): Update xref.
* doc/ref/scheme-using.texi (REPL Commands): New subsection.
  (Interactive Debugging): Rename from Interactive Debugger, to indicate
  that debugging is just part of the REPL. Update docs.
2010-07-16 17:35:43 +02:00
Andy Wingo
dc3b266118 update manual for value history on by default
* doc/ref/compiler.texi: Update for new ,pp meta-command.
* doc/ref/scheme-using.texi (Using Guile Interactively): Show value
  history in examples.
  (Value Historyx): Update docs to mention the repl option and the
  programmatic interface.
2010-07-10 11:38:47 +02:00
Neil Jerram
2604f1ad85 Fix TeXing of doc/ref/r6rs.texi
* doc/ref/r6rs.texi (rnrs conditions): Add "{Condition Type}" to
  @deffn line for each condition type.  Add one missing "{Scheme
  Procedure}".
2010-07-04 21:09:02 +01:00
Julian Graham
5b379729bb Edits to R6RS standard libraries documentation proposed by Ludovic Courtès.
* doc/ref/r6rs.texi: Fix erroneous usage of @pxref; add pointers from
  `(rnrs conditions)' and `(rnrs arithmetic bitwise)' to SRFI-35 and
  SRFI-60 sections; remove reference to `fold'.
2010-06-23 23:44:43 -04:00
Andy Wingo
049ec20299 deprecate named-module-use!, load-emacs-interface, and remove --emacs
* module/ice-9/boot-9.scm:
* module/ice-9/deprecated.scm (named-module-use!)
  (load-emacs-interface): Deprecate these.

* module/ice-9/gds-client.scm (run-utility): Redefine to not use
  named-module-use!.

* libguile/script.c (scm_shell_usage): Remove --emacs option.
  (scm_compile_shell_switches): Remove support for --emacs.

* module/ice-9/boot-9.scm (top-repl): Don't muck with --emacs.

* doc/ref/scheme-scripts.texi (Invoking Guile): Remove note about
  --emacs.
2010-06-22 22:39:21 +02:00
Julian Graham
ea28e98134 Integrate complete R6RS standard libraries documentation.
* doc/ref/r6rs.texi: Reshuffle Andy Wingo's introductory notes; add more
  detailed @subsubsections for each library.
2010-06-21 23:16:36 -04:00
Andy Wingo
bfccdcd530 add support for variable transformers: settable identifier syntax
* module/ice-9/psyntax.scm (set!): Handle variable transformers; though,
  they cannot produce definitions.
  (make-variable-transformer): New procedure.
  (identifier-syntax): Allow the R6RS form that makes variable
  transformers.

* module/ice-9/psyntax-pp.scm: Regenerated.

* doc/ref/r6rs.texi (R6RS Incompatibilities): Remove letrec* item, and
  add set! restriction.
2010-06-19 12:43:40 +02:00
Thien-Thi Nguyen
a6025413eb [build] Use UTC, precise format for ‘buildstamp’ value.
* libguile/Makefile.am (libpath.h): For ‘buildstamp’,
  specify date(1) output format precisely, and in UTC.
* doc/ref/api-options.texi (Build Config): Update ‘buildstamp’ doc.
2010-06-18 19:49:02 +02:00
Thien-Thi Nguyen
cd53bd3668 Add tmpfile(3) to libguile.
* libguile/posix.c (scm_tmpfile): New primitive.
* libguile/posix.h (scm_tmpfile): New func decl.

* doc/ref/posix.texi (File System): Document `tmpfile'.
2010-06-15 23:06:00 +02:00
Andy Wingo
749c2532e4 some repl doc updates
* doc/ref/tour.texi (Reporting Bugs): Update instructions for generating
  a backtrace.

* doc/ref/scheme-using.texi: Update examples of Guile prompts, and add
  an explanation of the prompt format.
2010-06-02 22:19:40 +02:00
Ludovic Courtès
bdfcabfee7 Make `@' visible in the sxml-match documentation.
* doc/ref/sxml-match.texi (sxml-match): Quote `@' in the examples.
2010-06-01 22:58:59 +02:00
Andy Wingo
76b4a4aad4 remove docs for removed procedures
* doc/ref/api-procedures.texi (Compiled Procedures): Remove docs for
  removed procedures.
2010-06-01 14:18:22 +02:00
Andy Wingo
845cbcfeb9 r6rs docs in the manual
* doc/ref/r6rs.texi (R6RS Support): Skeleton of docs on our R6RS
  support.

* doc/ref/guile.texi:
* doc/ref/Makefile.am: Add r6rs.texi.

* doc/ref/intro.texi: Add a link to r6rs.texi.
2010-06-01 14:10:59 +02:00
Andy Wingo
07d22c0259 rename (rnrs bytevector) to (rnrs bytevectors)
* module/rnrs/bytevectors.scm: Rename to (rnrs bytevectors), from (rnrs
  bytevector), to match the name from the R6RS.

* benchmark-suite/benchmarks/bytevectors.bm:
* doc/ref/api-data.texi:
* doc/ref/api-foreign.texi:
* libguile/bytevectors.c:
* module/6/rnrs.scm:
* module/language/assembly.scm:
* module/language/assembly/compile-bytecode.scm:
* module/language/assembly/decompile-bytecode.scm:
* module/language/glil/compile-assembly.scm:
* module/language/tree-il/primitives.scm:
* module/srfi/srfi-4.scm:
* module/srfi/srfi-4/gnu.scm:
* module/system/foreign.scm:
* test-suite/standalone/test-ffi:
* test-suite/tests/asm-to-bytecode.test:
* test-suite/tests/bytevectors.test:
* test-suite/tests/foreign.test:
* test-suite/tests/r6rs-ports.test: Update all referrers.
2010-06-01 13:26:11 +02:00
Ludovic Courtès
31d328de60 Upgrade manual to GFDLv1.3+.
* doc/ref/fdl.texi: Upgrade to GFDLv1.3.

* doc/ref/guile.texi: Change copying notice to "Version 1.3 or any later
  version".
  (GNU Free Documentation License): New node, formerly in `fdl.texi'.
2010-06-01 00:02:35 +02:00
Ludovic Courtès
477e42195c Change occurrences of "filesystem" to "file system".
* doc/ref/posix.texi (File System): Change "filesystem" to "file
  system".

* libguile/posix.c (scm_utime): Ditto.
2010-05-28 17:02:13 +02:00
No Itisnt
853cb35661 Two spaces. 2010-05-27 14:09:56 -05:00
No Itisnt
45f3d9b6db Rename set-record-printer!
* doc/ref/srfi-modules.texi: set-record-printer! -> set-record-type-printer!
2010-05-27 14:09:56 -05:00
No Itisnt
167510bc10 Record printer fixes
* doc/ref/srfi-modules.texi: Fix style

* module/srfi/srfi-9/gnu.scm (set-record-type-printer!): renamed from set-record-printer!
2010-05-27 14:09:56 -05:00
No Itisnt
40b19fda5c Merge branch 'master' of git.sv.gnu.org:/srv/git/guile 2010-05-26 15:28:11 -05:00
Ludovic Courtès
400a5dcb8b Add (sxml match).
* module/Makefile.am (LIB_SOURCES): Add `sxml/match.scm'.
  (NOCOMP_SOURCES): Add `sxml/sxml-match.ss'.

* module/sxml/match.scm, module/sxml/sxml-match.ss: New files.

* test-suite/Makefile.am (SCM_TESTS): Add `tests/sxml.match.test'.
  (EXTRA_DIST): Add `tests/sxml-match-tests.ss'.

* test-suite/tests/sxml-match-tests.ss,
  test-suite/tests/sxml.match.test: New files.

* doc/ref/guile.texi (Guile Modules): Include `sxml-match.texi'.

* doc/ref/sxml-match.texi: New file.

* doc/ref/Makefile.am (guile_TEXINFOS): Add `sxml-match.texi'.
2010-05-25 23:31:36 +02:00
No Itisnt
6942d86409 * doc/ref/srfi-modules.texi:
* module/srfi/srfi-9/gnu.scm: rename `define-record-printer' to
  `set-record-printer!' to reflect the fact that the printer is set at runtime
2010-05-25 15:54:05 -05:00
No Itisnt
e525e4e499 add custom record printers
* doc/ref/srfi-modules.texi: update documentation
* module/srfi/srfi-9/gnu.scm: add `define-record-printer'
2010-05-25 15:47:35 -05:00
Julian Graham
43d6eb75f3 Edits for R6RS library implementation documentation, as suggested by
Ludovic Courtès.

* doc/ref/api-module.texi (R6RS Libraries): Wrap keywords variously in
  @code and @dfn forms; rewrite pointer to implicit phasing paper; add
  "Scheme Syntax" specification to @deffns.
2010-05-22 18:20:00 -04:00
Julian Graham
71194485d6 Documentation for the R6RS library' and import' forms.
* doc/ref/api-modules.texi (R6RS Libraries): New section, documents
  `library' and `import'.
2010-05-20 19:20:39 -04:00
Ludovic Courtès
36b5e39407 Add (system vm coverage).
* module/system/vm/coverage.scm: New file.

* module/Makefile.am (SYSTEM_SOURCES): Add `system/vm/coverage.scm'.

* test-suite/guile-test (main): Use (system vm coverage).  Handle
  `--coverage' and `-c'.

* test-suite/tests/coverage.test: New file.

* test-suite/Makefile.am (SCM_TESTS): Add `tests/coverage.test'.

* doc/ref/Makefile.am (guile_TEXINFOS): Add `api-coverage.texi'.

* doc/ref/api-coverage.texi: New file.

* doc/ref/guile.texi (API Reference): Include it.
2010-05-07 13:47:53 +02:00
Andy Wingo
ff6182edfc add tour.texi to guile_TEXINFOS
* doc/ref/Makefile.am (guile_TEXINFOS): Add tour.texi.
2010-05-02 14:27:46 +02:00
Andy Wingo
0a715b9adc Update example disassemblies
* doc/ref/compiler.texi:
* doc/ref/vm.texi: Update example disassemblies for current compiler,
  which uses assert-nargs-ee/locals.
2010-05-02 14:18:58 +02:00
Andy Wingo
de45d8eef9 add assert-nargs-ee/locals instruction
* libguile/vm-i-system.c (assert-nargs-ee/locals): New instruction, a
  combination of assert-nargs-ee and reserve-locals in the case in which
  nreq and nlocs can both be represented in 8 bits.

* module/language/glil/compile-assembly.scm (glil->assembly): Add
  compiler case.

* doc/ref/vm.texi (Function Prologue Instructions): Update docs.
2010-05-02 13:41:31 +02:00
Andy Wingo
41e64dd73c update compiler.texi
* doc/ref/compiler.texi (Compiler Tower): Update for removal of version
  from <language>, and add joiner and make-default-environment fields.
  Update examples.
  (The Scheme Compiler): Update for `macroexpand' instead of
  `sc-expand', and that the environment must be a module.
  (Tree-IL): Update for new Tree-IL, and change from "vars" to
  "gensyms".
  (GLIL): Update for new GLIL, including preludes and prompts.
  (Assembly): Update for current output (which seems quite verbose).
  (Bytecode and Objcode): Update for current output, and some procedure
  name changes.
2010-05-02 12:46:50 +02:00
Andy Wingo
acc51c3e65 update documentation for vm instructions
* doc/ref/vm.texi: Update with documentation for new-ish instructions,
  and reorganize the sections a bit.

* doc/ref/compiler.texi (GLIL): Fix up a couple xrefs.
2010-05-01 17:02:39 +02:00
Neil Jerram
44ecb50378 Fix inconsistent sectioning, causing make to fail
* doc/ref/guile.texi (Top): Remove @raisesections and @lowersections
  around scheme-ideas.texi.

* doc/ref/scheme-ideas.texi (About Data, ...): Instead remove one
  "sub" from every node here apart from the chapter node.

* doc/ref/scheme-ideas.texi (Evaluating, Eval Variable, Eval
  Procedure, Eval Special, Lexical Scope, Scoping Example): Turn
  subheadings back into subsubsections, and reinstate corresponding
  menus.  (These had to become headings, rather than (sub)*sections, when
  the top level item in scheme-ideas.texi was a section.  Now it's a
  chapter again, they can go back to being (sub)*sections.)
2010-04-26 22:18:45 +01:00
Neil Jerram
d93c0bc4c6 Bring the manual organisation section a little closer to reality
FWIW I'm not sure I like this bullety presentation - but for now this
just aligns the descriptions a bit closer to the actual chapters and
chapter contents.

* doc/ref/intro.texi (Organisation of this Manual): Cover `Hello
  Guile!' and `Hello Scheme!' chapters.  Thin out text for
  `Programming in Scheme'.  Renumber other chapters.
2010-04-26 05:24:24 +01:00
Neil Jerram
1d84577c6a Assorted minor manual changes
* doc/ref/guile.texi (Programming in Scheme): Remove "awful" and add
  "as opposed to having to dive into C code", to explain what we
  really mean here.  Remove incorrect para about the `Hello Scheme!'
  material.

* doc/ref/intro.texi (Interactive Programming): Change "allows" to "is
  designed for" - sounds less accidental!

* doc/ref/scheme-ideas.texi (Hello Scheme!): Remove unnecessary
  "reference", and inappropriate "randomness".
2010-04-26 04:27:01 +01:00
Neil Jerram
5bcaf46b75 More `Guile and the GNU Project' text
* doc/ref/intro.texi (Guile and the GNU Project): More text about
  extensibility and software freedom.
2010-04-26 02:43:54 +01:00
Neil Jerram
79bd99b3e4 Move description of manual organisation from Preface to Introduction
This material isn't "meta-" enough to be in the Preface, and it
supports (by its structure) some of the points that the Introduction
makes about Guile, so I think it belongs here.

* doc/ref/intro.texi (Introduction): Add `Organisation of this Manual'
  menu item and material to here...

* doc/ref/preface.texi (Preface): ...from here.
2010-04-25 18:58:14 +01:00
Neil Jerram
de3ba527c4 Remove weird instruction
* doc/ref/intro.texi: Remove `Do not confuse the two.'  (Or else
  what?)
2010-04-25 18:28:19 +01:00
Neil Jerram
42a438e893 Fix typo
* doc/ref/compiler.texi (Bytecode and Objcode): Remove extraneous
  comma.
2010-04-25 18:12:01 +01:00
Neil Jerram
46733b4284 Move `Reporting Bugs' section out of Introduction
I think it's too detailed, when compared with the other Introduction
sections.  It probably also refers to concepts that haven't been
mentioned yet, but are mentioned in the following quick tour chapter;
so let's move it there.

* doc/ref/guile.texi: Move @raisesections and @lowersections for
  tour.texi material from here to inside tour.texi.

* doc/ref/intro.texi (Introduction): Don't mention reporting problems
  in first para.  Move menu item and material for `Reporting Bugs'
  from here...

* doc/ref/tour.texi (Hello Guile!): ...to here.  Also mention
  reporting problems in the introductory para.
2010-04-25 17:56:56 +01:00
Neil Jerram
45a272c5be Move whirlwind tour material to its own chapter
* doc/ref/guile.texi (Top): New top level `Hello Guile!' menu item;
  include new file tour.texi.

* doc/ref/intro.texi (Introduction): Remove whirlwind tour menu item
  and material from here...

* doc/ref/tour.texi: ...to new file here.
2010-04-25 17:01:01 +01:00
Neil Jerram
d665f75f5b Move Scheme introduction (Guile-independent) to its own chapter
This magically fixes all the internal wordings that say "chapter"
rather than "section", and separates Guile-independent and skippable
material from material that is Guile-specific and
probably-not-skippable - which I think is helpful.

* doc/ref/guile.texi (Top): New `Hello Scheme!' menu item, and removed
  `Basic Ideas' item.  Move include of scheme-ideas.texi before
  `Programming in Scheme' chapter, using @raisesections and
  @lowersections.  Also move scheme-reading.texi to same place.

* doc/ref/scheme-ideas.texi: Change name from `Basic Ideas' (which is
  a bit boring) to `Hello Scheme!'.  Move `Further Reading' menu item
  here.
2010-04-25 13:20:17 +01:00
Neil Jerram
892cf97107 Merge branch 'wip-manual-2'
Conflicts:

	doc/ref/api-translation.texi
2010-04-16 22:26:32 +01:00
Andy Wingo
4bd4b6e67f fold in feedback to api-languages
* doc/ref/api-languages.texi: Fold in feedback.
2010-04-16 17:43:42 +02:00
Andy Wingo
bcbfc9400d more nil docs
* doc/ref/api-languages.texi (Nil): Be a bit more thorough, and
  positive.
2010-04-16 10:36:04 +02:00
Andy Wingo
3279b6b1f5 add docs on `nil'
* doc/ref/api-languages.texi (Nil): Write about `nil'.
2010-04-16 10:36:04 +02:00
Andy Wingo
698307a08a fix bugs in ice-9 i18n demo (invalid input)
* doc/ref/api-i18n.texi (Accessing Locale Information): Crucial
  bugfixes.
2010-04-16 10:36:04 +02:00
Andy Wingo
4d0fd3467c fixes to api-i18n.texi
* doc/ref/api-i18n.texi (Character Case Mapping): Remove note about lack
  of support for multibute characters.
2010-04-16 10:36:04 +02:00
Andy Wingo
e6709db63f flesh out docs on multiple languages a bit more
* doc/ref/api-languages.texi: Move here from api-translation. Still
  stubbed in parts, but it's getting better.
* doc/ref/Makefile.am: Adapt to api-languages.texi name change.
* doc/ref/guile.texi: Likewise.
2010-04-16 10:36:04 +02:00