Mark H Weaver
f567a43cf0
Clarify docs for SCM_UNSPECIFIED: used sometimes but not always
...
* doc/ref/data-rep.texi (Immediate objects): Clarify the description
of SCM_UNSPECIFIED. It is returned by some (but not all) expressions
whose value is unspecified by the Scheme standard.
2011-05-25 12:40:55 -04:00
Neil Jerram
679cceeda4
Misc textual editing
...
* doc/ref/api-scheduling.texi (Asyncs): "queueing" -> "queuing".
* benchmark-suite/lib.scm, doc/sources/unix.texi (Unix conventions),
test-suite/lib.scm: "postpend" -> "append".
* doc/ref/api-compound.texi (Array Syntax, Dictionary Types),
doc/ref/api-control.texi (Catch), doc/ref/api-data.texi (Complex
Numbers, Conversion, Random, Symbol Props, Symbol Uninterned),
doc/ref/api-options.texi (Build Config, Common Feature Symbols),
doc/ref/api-regex.texi (Match Structures),
doc/ref/api-undocumented.texi, doc/ref/compiler.texi (Tree-IL,
GLIL), doc/ref/data-rep.texi (Immediate objects), doc/ref/goops.texi
(Slot Description Example), doc/ref/history.texi (A Scheme of Many
Maintainers, Status), doc/ref/libguile-program.texi (Available
Functionality), doc/ref/misc-modules.texi (Formatted Output),
doc/ref/mod-getopt-long.texi (getopt-long Reference),
doc/ref/posix.texi (Network Socket Address, Network Sockets and
Communication), doc/ref/srfi-modules.texi (SRFI-1 Association Lists,
SRFI-10, SRFI-19 String to date, SRFI-27 Random Sources),
doc/ref/vm.texi (Instruction Set, Top-Level Environment
Instructions, Procedure Call and Return Instructions),
doc/sources/unix.texi (Unix conventions): Correct spacing after
"i.e." and "e.g.".
2011-02-13 22:13:33 +00:00
Andy Wingo
0f7e6c56cd
update "data representation" part of guile internals doc
...
* doc/ref/api-control.texi (Handling Errors): Move the "Signalling Type
Errors" section here.
* doc/ref/data-rep.texi (Data Representation): Refactor, lopping and
cropping and stitching.
* doc/ref/libguile-concepts.texi (Dynamic Types):
* doc/ref/libguile-smobs.texi (Describing a New Type, Double Smobs):
* doc/ref/guile.texi (Guile Implementation, Programming in C): Adapt to
refactorings.
* doc/ref/history.texi (A Scheme of Many Maintainers):
(A Timeline of Selected Guile Releases, Status): Update.
2010-03-14 14:39:47 +01:00
Andy Wingo
eff313ed21
fix doc typo
...
* doc/ref/data-rep.texi (Non-immediate objects): Fix a typo, thanks to
Dale Smith.
2008-12-26 16:33:33 +01:00
Andy Wingo
8680d53b8c
merge vm docs into guile reference (as yet unfinished)
...
* doc/ref/compiler.texi: A new empty section on the compiler.
* doc/ref/data-rep.texi: Made to be a section of a chapter instead of an
appendix. The beginnings of some revision, but not there yet.
* doc/ref/guile.texi: Put the "Data Representation" essay into the new
"History and Implementation Details" chapter.
* doc/ref/history.texi: New empty section on Guile history.
* doc/ref/libguile-concepts.texi:
* doc/ref/libguile-smobs.texi: Fix up some xrefs.
* doc/ref/vm.texi: New section documenting the VM. Not done yet.
2008-11-20 13:44:22 +01:00
Kevin Ryde
1b09b607dd
merge from 1.8 branch
2006-04-16 23:18:55 +00:00
Kevin Ryde
01adf598d9
(Subrs): Note that subr must not modify its rest list.
2005-04-22 23:16:43 +00:00
Marius Vollmer
3f7e8708b4
(How Guile does it): Mark as being in limbo. All
...
the real documentation will be in the nodes "Programming in C" and
"API Reference".
(Boolean Data): Just refer to node "Booleans".
2004-07-07 12:17:41 +00:00
Marius Vollmer
3229f68b5a
Big reorganization of the whole manual to give it a simpler structure.
2004-04-21 14:33:05 +00:00
Marius Vollmer
2da09c3fde
Added Copyright notice.
2004-01-21 22:40:39 +00:00
Marius Vollmer
3446b6ef07
* scheme-memory.texi: Added a short explanation of the GC and the
...
conservative stack scanning.
(scm_gc_protect_object, scm_gc_unprotect_object,
scm_permanent_object): New.
* data-rep.texi, scheme-memory.texi (scm_remember_upto_here_1,
scm_remember_upto_here_2): Moved from data-rep.texi to
scheme-memory.texi.
2003-10-06 19:24:15 +00:00
Kevin Ryde
d3d0c186e0
(Remembering During Operations): Note
...
scm_remember_upto_here_1 applies only to C automatic variables.
2003-08-29 23:32:21 +00:00
Kevin Ryde
7a52a21e96
(Remembering During Operations): Refer to all "Guile
...
library functions" as provoking gc.
2003-06-21 23:02:58 +00:00
Kevin Ryde
cf4e2dabf4
(Vector Data): For SCM_VECTOR_BASE, SCM_STRING_CHARS
...
and SCM_SYMBOL_CHARS, cross reference "Remembering During Operations".
2003-06-13 23:32:33 +00:00
Kevin Ryde
7e88be2ee8
(Remembering During Operations): New section.
2003-06-11 23:07:53 +00:00
Kevin Ryde
218b088e2a
Add spaces after some @defun names.
2003-05-03 22:22:51 +00:00
Neil Jerram
63bf8015ab
Doc clarification from tomas@fabula.de.
2003-04-26 15:09:18 +00:00
Neil Jerram
bcf009c3f8
Add examples from Ian Sheldon, and merge recent updates from stable branch.
2002-08-08 21:47:53 +00:00
Neil Jerram
e8f1ff7188
Minor changes for syncing with stable branch.
2002-03-29 20:25:24 +00:00
Neil Jerram
413d32b658
Various minor enhancements ported from the stable CVS branch.
2002-03-12 21:08:57 +00:00
Dirk Herrmann
228a24ef30
Changes in doc/ref:
...
* api.txt, data-rep.texi: Renamed the struct scm_cell to
scm_t_cell.
* data-rep.texi: Renamed scm_alloc_cell to scm_cell and
scm_alloc_double_cell to scm_double_cell.
Changes in libguile:
* gc.c (SCM_HEAP_SEG_SIZE, CELL_UP, CELL_DN, NEXT_DATA_CELL,
init_heap_seg, alloc_some_heap), gc.h (struct scm_cell, struct
scm_t_cell, SCM_CELLPTR, SCM_GC_CARD_SIZE,
SCM_GC_IN_CARD_HEADERP), tags.h (SCM_CELLP): Renamed the struct
scm_cell and all its uses to scm_t_cell in accordance to Guile's
naming scheme for types.
* alist.c (scm_acons), convert.i.c (CTYPES2UVECT,
CTYPES2UVECT_OPTIONAL), coop-threads.c (scm_call_with_new_thread,
scm_spawn_thread), debug.c (scm_make_debugobj), environments.c
(scm_make_environment), eval.c (scm_closure), fports.c
(scm_fdes_to_port), gc.c (scm_deprecated_newcell,
scm_deprecated_newcell2), inline.h (scm_alloc_cell, scm_cell),
list.c (SCM_I_CONS), numbers.c (scm_i_mkbig), pairs.c (scm_cons),
ports.c (scm_void_port), procs.c (scm_c_make_subr, scm_makcclo),
smob.c (scm_make_smob), smob.h (SCM_NEWSMOB), strings.c
(scm_take_str, scm_allocate_string), strports.c (scm_mkstrport),
unif.c (scm_make_uve), variable.c (make_variable), vectors.c
(scm_c_make_vector), vports.c (scm_make_soft_port): Renamed
scm_alloc_cell to scm_cell.
* environments.c (core_environments_observe), gc.c
(scm_deprecated_newcell2), goops.c (wrap_init, scm_wrap_object),
inline.h (scm_alloc_double_cell, scm_double_cell), num2float.i.c
(FLOAT2NUM), numbers.c (scm_make_real), procs.c
(scm_make_procedure_with_setter), smob.h (SCM_NEWSMOB2,
SCM_NEWSMOB3), struct.c (scm_make_struct, scm_make_vtable_vtable),
symbols.c (scm_mem2symbol, scm_mem2uninterned_symbol), weaks.c
(allocate_weak_vector): Renamed scm_alloc_double_cell to
scm_double_cell.
2002-03-01 00:19:20 +00:00
Marius Vollmer
eabd8acf87
Use scm_gc_malloc and scm_gc_free instead of scm_must_malloc and free
...
in example code. Updated text for the new memory management
functions.
2002-02-28 20:58:50 +00:00
Thien-Thi Nguyen
85a9b4ed19
Spell check.
2002-01-08 08:29:00 +00:00
Marius Vollmer
9d5315b649
Removed docs about SCM_NEWCELL and added scm_alloc_cell and
...
scm_alloc_double_cell.
Replaced scm_bits_t with scm_t_bits.
2001-11-25 14:51:03 +00:00
Neil Jerram
a0e07ba4ec
* Organize documentation into per-manual directories (halfway point commit).
2001-08-24 09:40:29 +00:00