summaryrefslogtreecommitdiff
path: root/doc/ref/api-memory.texi
AgeCommit message (Collapse)AuthorFilesLines
2024-05-06Fix typos throughout codebase.Morgan Smith1-15/+15
* NEWS: * doc/ref/api-control.texi: * doc/ref/api-data.texi: * doc/ref/api-debug.texi: * doc/ref/api-deprecated.texi: * doc/ref/api-evaluation.texi: * doc/ref/api-foreign.texi: * doc/ref/api-i18n.texi: * doc/ref/api-io.texi: * doc/ref/api-languages.texi: * doc/ref/api-macros.texi: * doc/ref/api-memory.texi: * doc/ref/api-modules.texi: * doc/ref/api-options.texi: * doc/ref/api-peg.texi: * doc/ref/api-procedures.texi: * doc/ref/api-scheduling.texi: * doc/ref/api-undocumented.texi: * doc/ref/api-utility.texi: * doc/ref/expect.texi: * doc/ref/goops.texi: * doc/ref/misc-modules.texi: * doc/ref/posix.texi: * doc/ref/repl-modules.texi: * doc/ref/scheme-ideas.texi: * doc/ref/scheme-scripts.texi: * doc/ref/srfi-modules.texi: * gc-benchmarks/larceny/dynamic.sch: * gc-benchmarks/larceny/twobit-input-long.sch: * gc-benchmarks/larceny/twobit.sch: * libguile/gc.h: * libguile/ioext.c: * libguile/list.c: * libguile/options.c: * libguile/posix.c: * libguile/threads.c: * module/ice-9/boot-9.scm: * module/ice-9/optargs.scm: * module/ice-9/ports.scm: * module/ice-9/pretty-print.scm: * module/ice-9/psyntax.scm: * module/language/elisp/parser.scm: * module/language/tree-il/compile-bytecode.scm: * module/srfi/srfi-37.scm: * module/srfi/srfi-43.scm: * module/statprof.scm: * module/texinfo/reflection.scm: * test-suite/tests/eval.test: * test-suite/tests/fluids.test: Fix typos. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
2016-06-24Clarify use of the term "scanning" in the manualAndy Wingo1-18/+24
* doc/ref/api-memory.texi (Garbage Collection Functions): * doc/ref/libguile-concepts.texi (Garbage Collection): Attempt to be clear that scanning is a thing that happens in the mark phase. Fixes #20907 I think.
2016-06-23Add weak hash table documentationAndy Wingo1-2/+10
* doc/ref/api-memory.texi (Weak hash tables): Update documentation. Fixes #20551.
2016-05-22Fix uses of 'scm_gc_protect', which does not exist, in the manual.Mark H Weaver1-2/+2
* doc/ref/api-memory.texi (Garbage Collection Functions), doc/ref/libguile-concepts.texi (Garbage Collection): Change 'scm_gc_protect' --> 'scm_gc_protect_object'.
2014-04-28Merge remote-tracking branch 'origin/stable-2.0'Andy Wingo1-9/+12
Conflicts: .gitignore doc/example-smob/Makefile doc/ref/api-smobs.texi doc/ref/libguile-concepts.texi doc/ref/libguile-smobs.texi libguile.h libguile/finalizers.c libguile/finalizers.h libguile/goops.c module/language/tree-il/compile-glil.scm module/oop/goops.scm
2014-04-28Prefer foreign objects over smobs in manualAndy Wingo1-72/+12
* doc/ref/api-memory.texi (Memory Blocks): Recommend against scm_gc_free. Refer to foreign objects instead of smobs. Remove discussion of scm_must_malloc et al. * doc/ref/guile.texi (API Reference): Rename SMOB menu item. * doc/ref/libguile-snarf.texi (Function Snarfing): Update example to not refer to smobs. * doc/ref/tools.texi (How guile-snarf works): Likewise.
2014-02-08Merge commit 'b86069c1308a6ca36f3a3bc56134b3f8fd693592'Andy Wingo1-3/+3
Conflicts: libguile/hashtab.c
2014-02-08Merge commit '54cded99dc5db94b1df0dc417161ebef7c60d874'Andy Wingo1-5/+1
2014-02-07Make size argument optional to 'make-doubly-weak-hash-table'; fix docs.Mark H Weaver1-3/+3
* libguile/hashtab.c (scm_make_doubly_weak_hash_table): Make 'size' argument optional, like the weak hash table constructors. * doc/ref/api-memory.texi (Weak hash tables): Document that 'size' argument is optional for the weak hash table constructors.
2014-02-07Fix 'weak-vector?' doc: Weak hash tables are not weak vectors.Mark H Weaver1-5/+1
* doc/ref/api-memory.texi (Weak vectors): In 'weak-vector?' entry, don't claim that weak hash tables are weak vectors. Remove statement that weak vectors are mainly useful for implementing weak hash tables.
2014-02-07Merge commit '1e3fd6a0c81bb3e9900a93a9d1923cc788de0f99'Andy Wingo1-1/+12
Conflicts: doc/ref/api-memory.texi libguile/weaks.c libguile/weaks.h module/ice-9/weak-vector.scm
2014-02-07Add weak-vector-length, weak-vector-ref, weak-vector-set!Andy Wingo1-1/+12
* libguile/weaks.c (scm_is_weak_vector, scm_c_weak_vector_length): (scm_c_weak_vector_ref, scm_c_weak_vector_set_x): New interfaces for dealing with weak vectors from C. (scm_weak_vector_length, scm_weak_vector_ref, scm_weak_vector_set_x): New Scheme interfaces to weak vectors; to be used instead of vector-length, vector-ref, etc. * module/ice-9/weak-vector.scm: Export the new interfaces. * doc/ref/api-memory.texi (Weak vectors): Document them.
2013-11-29Remove outdated section of api-memory.texiAndy Wingo1-64/+1
* doc/ref/api-memory.texi (Memory Blocks): Remove section documenting scm_must_malloc and friends.
2012-02-04Make notation for Scheme repeated arguments more consistent in manual.Bake Timmons1-1/+1
* doc/ref/api-compound.texi * doc/ref/api-control.texi * doc/ref/api-data.texi * doc/ref/api-debug.texi * doc/ref/api-evaluation.texi * doc/ref/api-macros.texi * doc/ref/api-memory.texi * doc/ref/api-modules.texi * doc/ref/api-procedures.texi * doc/ref/api-regex.texi * doc/ref/api-scheduling.texi * doc/ref/api-utility.texi * doc/ref/goops.texi * doc/ref/match.texi * doc/ref/misc-modules.texi * doc/ref/posix.texi * doc/ref/r6rs.texi * doc/ref/scheme-using.texi * doc/ref/srfi-modules.texi * doc/ref/sxml-match.texi: Make notation for Scheme repeated arguments more consistent in manual.
2012-01-12add docs for scm_gc_register_allocationAndy Wingo1-30/+22
* doc/ref/api-memory.texi: Update for scm_gc_register_allocation. Remove docs for scm_gc_{un,}register_collectable_memory.
2010-08-16a number of doc fixesAndy Wingo1-33/+1
* doc/ref/api-control.texi (Handling Errors): Update docs for display-error. * libguile/backtrace.h (scm_i_display_error): Change prototype to s/stack/frame/. * libguile/throw.c (handler_message): Change invocation of scm_i_display_error to pass a frame. * doc/ref/api-deprecated.texi (Deprecation): Update wording. * doc/ref/api-evaluation.texi (Local Evaluation): Remove section on local-eval. * doc/ref/api-macros.texi: Fix a couple typos. * doc/ref/api-memory.texi (Objects): Remove terrible section. * doc/ref/api-procedures.texi (Procedure Properties): Remove docs for closure?. (Compiled Procedures): Update wording. * doc/ref/guile.texi (API Reference): Remove reference to "Objects".
2009-12-19Remove page breaks except before new chapters and indicesNeil Jerram1-2/+0
* doc/ref/api-binding.texi, doc/ref/api-compound.texi, doc/ref/api-control.texi, doc/ref/api-data.texi, doc/ref/api-debug.texi, doc/ref/api-evaluation.texi, doc/ref/api-i18n.texi, doc/ref/api-io.texi, doc/ref/api-memory.texi, doc/ref/api-modules.texi, doc/ref/api-options.texi, doc/ref/api-overview.texi, doc/ref/api-procedures.texi, doc/ref/api-scheduling.texi, doc/ref/api-smobs.texi, doc/ref/api-translation.texi, doc/ref/api-utility.texi, doc/ref/expect.texi, doc/ref/libguile-concepts.texi, doc/ref/libguile-program.texi, doc/ref/misc-modules.texi, doc/ref/repl-modules.texi, doc/ref/scheme-debugging.texi, doc/ref/scheme-reading.texi, doc/ref/scheme-scripts.texi, doc/ref/script-getopt.texi, doc/ref/scsh.texi, doc/ref/srfi-modules.texi: Remove @page before @section.
2009-09-18fix thinko in api-memory.texiAndy Wingo1-1/+1
2009-09-09Update doc of `scm_gc_protect_object ()' and SMOB mark/free.Ludovic Courtès1-0/+5
* doc/ref/api-memory.texi (Garbage Collection Functions)[scm_gc_protect_object]: Explain that it's equivalent to storing in a global variable. * doc/ref/api-smobs.texi (Smobs)[scm_set_smob_free]: Expand on the relationship with `scm_gc_malloc ()'. [scm_set_smob_mark]: Explain that it's usually not needed.
2009-09-09Update documentation of `scm_gc_malloc ()' & co.Ludovic Courtès1-37/+66
* doc/ref/api-memory.texi (Memory Blocks): Update description of `scm_gc_malloc ()' & co. Add `scm_gc_malloc_pointerless ()'.
2009-05-20Fix `explicitely' typos, should be `explicitly'Neil Jerram1-2/+2
2006-01-29Renamed the "frames" that are related to dynamic-wind to "dynamicMarius Vollmer1-2/+2
contexts. Renamed all functions from scm_frame_ to scm_dynwind_. Updated documentation.
2005-12-06fixed some typos.Marius Vollmer1-6/+6
2005-07-31*** empty log message ***Marius Vollmer1-40/+46
2005-04-01Fixed some typos.Marius Vollmer1-4/+4
2005-03-29Correct strange placement of @end deffn...Marius Vollmer1-3/+1
2005-03-04Synchronized docstrings.Marius Vollmer1-0/+5
2004-08-24Ran a (docstring-process-module "(guile)") and moved entries fromMarius Vollmer1-16/+3
new-docstrings.texi to their appropriate place.
2004-08-10Docs for scm_frame_free.Marius Vollmer1-1/+10
2004-08-02* scheme-binding.texi: Renamed to api-binding.texi.Marius Vollmer1-0/+478
* scheme-compound.texi: Renamed to api-compound.texi. * scheme-control.texi: Renamed to api-control.texi. * scheme-data.texi: Renamed to api-data.texi. * scheme-debug.texi: Renamed to api-debug.texi. * deprecated.texi: Renamed to api-deprecated.texi. * scheme-evaluation.texi: Renamed to api-evaluation.texi. * ref-init.texi: Renamed to api-init.texi. * scheme-io.texi: Renamed to api-io.texi. * scheme-memory.texi: Renamed to api-memory.texi. * scheme-modules.texi: Renamed to api-modules.texi. * scheme-options.texi: Renamed to api-options.texi. * scm.texi: Renamed to api-overview.texi. * scheme-procedures.texi: Renamed to api-procedures.texi. * scheme-scheduling.texi: Renamed to api-scheduling.texi. * scheme-scm.texi: Renamed to api-scm.texi. * scheme-smobs.texi: Renamed to api-smobs.texi. * scheme-snarf.texi: Renamed to api-snarf.texi. * scheme-translation.texi: Renamed to api-translation.texi. * scheme-utility.texi: Renamed to api-utility.texi. * debugging.texi: Renamed to scheme-debugging.texi. * scripts.texi: Renamed to scheme-scripts.texi. * program.texi: Renamed to libguile-program.texi.