summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* texinfo: Add '*line-width*' fluid to control line wrapping.Ludovic Courtès2020-02-121-1/+7
| | | | | | | | * module/texinfo/plain-text.scm (*line-width*): New variable. (wrap*): Honor it. * doc/ref/texinfo.texi (texinfo plain-text): Document it. * test-suite/tests/texinfo.plain-text.test: New file. * test-suite/Makefile.am (SCM_TESTS): Add it.
* doc: Document optional parameter of 'stat'.Ludovic Courtès2019-06-301-2/+8
| | | | | | | | Fixes <https://bugs.gnu.org/34860>. Reported by Tim Gesthuizen <tim.gesthuizen@yahoo.de>. * doc/ref/posix.texi (File System): Document 'exception_on_error' parameter of 'stat'.
* doc: Fix argument list in match-lambda docsPaul Morris2019-06-241-2/+2
| | | | | | * doc/ref/match.texi: Fix argument list for match-lambda. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Fix minor typo in the HTTP headers documentation.Arun Isaac2019-06-241-1/+1
| | | | | | * doc/ref/web.texi (HTTP Headers): Fix minor typo. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* Remove references to 'inet-ntoa' and 'inet-aton'.Ludovic Courtès2019-06-242-27/+3
| | | | | | | | | | | | These procedures were removed in Guile 2.2 by commit fc7bd367ab4b5027a7f80686b1e229c62e43c90b (May 2011). * libguile/socket.h (scm_inet_aton, scm_inet_ntoa): Remove. * module/system/repl/server.scm (make-tcp-server-socket): Use 'inet-pton' instead of 'inet-aton'. * doc/ref/web.texi (HTTP): Likewise in 'declare-header!' example. * doc/ref/posix.texi (Network Address Conversion): Remove documentation of 'inet-ntoa' and 'inet-aton'.
* Fix documentation of R6RS 'binary-port?' to reflect reality.Mark H Weaver2019-06-181-4/+17
| | | | | | | * doc/ref/r6rs.texi (rnrs io ports): Improve the descriptions of 'binary-port?' and 'textual-port?'. * module/rnrs/io/ports.scm (binary-port?, textual-port?): Update the docstrings.
* Add get-bytevector-some!.Mark H Weaver2019-06-181-1/+9
| | | | | | | | * libguile/r6rs-ports.c (scm_get_bytevector_some_x): New procedure. * libguile/r6rs-ports.h (scm_get_bytevector_some_x): Add prototype. (scm_unget_bytevector): Move prototype next to 'scm_get_bytevector_some_x'. * module/ice-9/binary-ports.scm: Export 'get-bytevector-some!'. * doc/ref/api-io.texi (Binary I/O): Document it.
* Update user-visible copyright years.Mark H Weaver2019-04-161-1/+1
| | | | | | * doc/ref/guile.texi: Update years in copyright notice. * module/ice-9/command-line.scm (version-etc): Update 'copyright-year'. * module/system/repl/common.scm (*version*): Update copyright years.
* Support ~N in SRFI-19 string->dateDaniel Llorens2018-12-111-0/+5
| | | | | | | | * module/srfi/srfi-19.scm (fractional-integer-reader, make-fractional-integer-reader): From reference implementation. (reader-directives): Handle #\N, from reference implementation. * test-suite/tests/srfi-19: Add tests for string->date ~N. * doc/ref/srfi-modules.texi (string->date): Add line for ~N.
* Documentation fixesMikael Djurfeldt2018-10-312-9/+9
| | | | | | * doc/ref/api-control: * doc/ref/compiler.texi: Language fixes * doc/ref/compiler ($kfun): Renamed argument clauses -> clause.
* SRFI-19: Fix TAI->UTC conversions, leap second handling, etc.Mark H Weaver2018-10-201-14/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes <https://bugs.gnu.org/21911>. Fixes <https://bugs.gnu.org/22034>. Fixes <https://bugs.gnu.org/21902>. Partially fixes <https://bugs.gnu.org/21904>. Reported by Zefram <zefram@fysh.org>. * doc/ref/srfi-modules.texi (SRFI-19 Introduction): Fix the definitions of Julian Day and Modified Julian Day. Give the correct full names of UTC and TAI. * module/srfi/srfi-19.scm: Import (srfi srfi-1). Use modern Guile keyword syntax in the 'define-module' form. (leap-second-neg-delta): New procedure, derived from a similar procedure in the latest upstream SRFI-19 reference implementation. (priv:time-tai->time-utc!, time-tai->julian-day) (time-monotonic->julian-day): Use 'leap-second-neg-delta'. (local-tz-offset): Fix comment. (leap-second?): Remove. (tai-before-leap-second?): New procedure, derived from upstream SRFI-19. (time-utc->date): Use 'define*' to handle the optional argument. Remove the leap second handling, following upstream SRFI-19. (time-tai->date): Rewrite in terms of 'time-utc->date'. Add special leap second handling, following upstream SRFI-19. (time-monotonic->date): Rewrite in terms of 'time-tai->date'. (date->time-tai, date->time-monotonic): Add special leap second handling, following upstream SRFI-19. (directives): In the entry for the "~Y" escape in 'date->string', pad the year field to 4 characters, following upstream SRFI-19. * test-suite/tests/srfi-19.test: Add tests.
* Clarify the manual's "Processes" section.Chris Marusich2018-10-141-3/+4
| | | | | | * doc/ref/posix.texi (Processes): Use the phrase "integer status value" consistently, and add a cross-reference to the section of the glibc manual that explains what it is.
* Improve the documentation for 'nil?'.Mark H Weaver2018-10-141-2/+20
| | | | | | | * libguile/boolean.c (scm_nil_p): Improve docstring. * doc/ref/api-languages.texi (Nil): Add documentation for 'nil?', along with a description of how Elisp interprets Scheme booleans and end-of-list.
* Define AT_SYMLINK_NOFOLLOW et al.Ludovic Courtès2018-09-231-0/+5
| | | | | | | | * libguile/posix.c (scm_init_posix): Define AT_SYMLINK_NOFOLLOW, AT_SYMLINK_FOLLOW, AT_NO_AUTOMOUNT, and AT_EMPTY_PATH when available. (scm_utime): Mention AT_SYMLINK_NOFOLLOW. * doc/ref/posix.texi (File System): Update accordingly. * test-suite/tests/posix.test ("utime")["AT_SYMLINK_NOFOLLOW"]: New test.
* Add -Wshadowed-toplevel.Ludovic Courtès2018-07-241-1/+3
| | | | | | | | | | | | * module/language/tree-il/analyze.scm (shadowed-toplevel-analysis): New variable. * module/language/tree-il/compile-cps.scm (%warning-passes): Add it. * module/system/base/message.scm (%warning-types): Add it. * test-suite/tests/tree-il.test ("warnings")["shadowed-toplevel"]: New test prefix. * module/ice-9/boot-9.scm (%auto-compilation-options): Add it. * doc/ref/api-evaluation.texi (Compilation): Add 'shadowed-toplevel' and 'macro-use-before-definition'.
* compile: Add '-x' flag.Ludovic Courtès2018-07-191-0/+6
| | | | | * module/scripts/compile.scm (%options, compile): Add '-x'. * doc/ref/api-evaluation.texi (Compilation): Document it.
* Update release docs.Ludovic Courtès2018-07-021-8/+6
| | | | * doc/release.org: Update web site instructions.
* Update copyright years in '--version' and the manual.Ludovic Courtès2018-07-011-1/+2
| | | | | | | * module/ice-9/command-line.scm (version-etc): Change #:copyright-year to 2018. * doc/ref/guile.texi: Add 2017 and 2018 to the copyright years. * configure.ac (GUILE_CONFIGURE_COPYRIGHT): Add 2018.
* web: Export http-request.Arun Isaac2018-06-231-14/+27
| | | | | | | | | | * module/web/client.scm (request): Rename to http-request, add a docstring, and export it. (http-get, http-head, http-post, http-put, http-delete, http-trace, http-options): Update docstring. * doc/ref/web.texi (Web Client): Document http-request. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Document (ice-9 match) macros.Arun Isaac2018-06-181-2/+90
| | | | | | | * doc/ref/match.texi: Document match-lambda, match-lambda*, match-let, match-let* and match-letrec. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* doc: Fix typo.Ludovic Courtès2018-06-181-2/+2
| | | | | | | | Fixes <https://bugs.gnu.org/30941>. Reported by Fis Trivial <ybbs.daans@hotmail.com>. * doc/ref/libguile-foreign-objects.texi (Defining Foreign Object Types): Remove extraneous 'image_type' in example.
* Add SRFI 71: Extended LET-syntax for multiple values.Christopher Allan Webber2018-06-181-1/+21
| | | | | | | | | * module/srfi/srfi-71.scm: New file. * module/srfi/Makefile.am: Add it. * doc/ref/srfi-modules.texi: Document it. * NEWS: Update. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* Fix minor typo in the PEG documentation.Arun Isaac2018-03-161-1/+1
| | | | | | * doc/ref/api-peg.texi (PEG Internals): Fix minor typo. Signed-off-by: Mark H Weaver <mhw@netris.org>
* Fix a few typos in the manual.Mark H Weaver2018-03-162-4/+4
| | | | | | | | Fixes <https://bugs.gnu.org/30276>. Reported by Matt Wette <matt.wette@gmail.com>. * doc/ref/api-macros.texi (Macro Expansion) doc/ref/vm.texi (Procedure Call and Return Instructions): Fix typos.
* doc: Fix typo about SRFI-4 syntax.Ludovic Courtès2018-02-161-1/+1
| | | | | | | Reported by Matt Wette <matt.wette@gmail.com>. Fixes <https://bugs.gnu.org/29910>. * doc/ref/api-data.texi (Array Syntax): Fix typo.
* doc: Update LALR URL.Ludovic Courtès2017-12-141-2/+2
| | | | | | Reported by Chris Vine <vine35792468@gmail.com>. * doc/ref/api-lalr.texi (LALR(1) Parsing): Update URL.
* foreign: Add 'uintptr_t' and 'intptr_t'.Matt Wette2017-11-221-0/+2
| | | | | | | | | * libguile/foreign.c (scm_uintptr_t, scm_intptr_t): New variables. (scm_init_foreign): Define them. * module/system/foreign.scm: Export 'intptr_t' and 'uintptr_t'. * doc/ref/api-foreign.texi (Foreign Types): Document them. Co-authored-by: Ludovic Courtès <ludo@gnu.org>
* Mention (ice-9 peg) module path.Arun Isaac2017-11-221-5/+6
| | | | | | * doc/ref/api-peg.texi (PEG Parsing): Mention (ice-9 peg) module path. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* Convert `close' ref to xref.Arun Isaac2017-11-221-3/+2
| | | | | | * doc/ref/api-io.texi (Ports): Convert `close' ref to xref. Signed-off-by: Ludovic Courtès <ludo@gnu.org>
* Fix sort, sort! for arrays with nonzero lower boundDaniel Llorens2017-10-311-10/+22
| | | | | | | | | | | | * module/ice-9/arrays.scm (array-copy): New function, export. * module/Makefile.am: Install (ice-9 arrays). * doc/ref/api-data.texi: Add documentation for (ice-9 arrays). * libguile/quicksort.i.c: Use signed bounds throughout. * libguile/sort.c (scm_restricted_vector_sort_x): Fix error calls. Fix calls to quicksort. * test-suite/tests/sort.test: Actually test that the sorted results match the original data. Test cases for non-zero base index arrays for sort, sort!, and stable-sort!.
* Remove documentation on uniform-vector-read!, uniform-vector-writeDaniel Llorens2017-10-311-33/+0
| | | | | | * NEWS: Add specific removal notice. * doc/ref/api-data.texi: Remove documentation on uniform-vector-read!, uniform-vector-write.
* Add struct-ref/unboxed, struct-set!/unboxedAndy Wingo2017-09-251-6/+19
| | | | | | | | | | | | | | | | | | | * NEWS: Add news entry. * doc/ref/api-data.texi (Vtables, Structure Basics): Update documentation. * libguile/struct.c (scm_i_struct_equalp): Avoid using struct-ref on unboxed fields. (scm_struct_ref, scm_struct_set_x_unboxed): Issue deprecation warning when accessing unboxed fields. (scm_struct_ref_unboxed, scm_struct_set_x_unboxed): New functions. * libguile/struct.h (scm_struct_ref_unboxed, scm_struct_set_x_unboxed): New functions. * module/oop/goops.scm (class-add-flags!, class-clear-flags!): (class-has-flags?, <class>, %allocate-instance, <slot>): (compute-get-n-set, unboxed-get, unboxed-set, unboxed-slot?): (allocate-slots, %prep-layout!, make-standard-class, initialize): Adapt to access unboxed nfields and flags fields via the new accessors.
* Deprecate opaque struct fieldsAndy Wingo2017-09-231-11/+2
| | | | | | | | | | * NEWS: Add entry. * doc/ref/api-data.texi (Vtables, Structure Basics): Remove mention of opaque field protection. * libguile/struct.c (scm_make_struct_layout, scm_make_struct_no_tail): Remove discussion of opaque fields. (set_vtable_layout_flags): Issue a deprecation warning when opaque fields are used.
* Deprecate struct "self" slotsAndy Wingo2017-09-221-12/+4
| | | | | | | | | | | | | | | | * libguile/print.h (SCM_PRINT_STATE_LAYOUT): Use a normal slot instead of a self slot. * libguile/print.c (make_print_state): Initialize "handle" slot manually. * libguile/struct.c (issue_deprecation_warning_for_self_slots): New helper, called when making vtables to issue deprecation warnings for "self" slots. Avoids warning for the "self" slot that's part of the fixed vtable slots. (scm_i_struct_inherit_vtable_magic): Call issue_deprecation_warning_for_self_slots. * doc/ref/api-data.texi (Vtables, Structure Basics): Remove references to self slots. * NEWS: Add entry.
* Remove references to tail arrays in the documentationAndy Wingo2017-09-201-69/+18
| | | | | * doc/ref/api-data.texi (Vtables, Structure Basics): Update to remove references to tail arrays, in preparation for deprecation.
* doc: Document 'short' and 'unsigned-short' foreign types.Mark H Weaver2017-06-111-0/+2
| | | | | | | | This is a followup to commit 42f7c01e0a1d1c139ec8b835429a80ab15ac4007. Reported by Adriano Peluso <catonano@gmail.com>. * doc/ref/api-foreign.texi (Foreign Types): Add missing entries for 'short' and 'unsigned-short'.
* web: add support for URI-referenceAndy Wingo2017-05-211-48/+86
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Based on a patch by Daniel Hartwig <mandyke@gmail.com>. * NEWS: Update. * doc/ref/web.texi (URIs): Fragments are properly part of a URI, so remove the incorrect note. Add documentation on URI subtypes. * module/web/uri.scm (uri-reference?): New base type predicate. (uri?, relative-ref?): Specific predicates. (validate-uri-reference): Strict validation. (validate-uri, validate-relative-ref): Specific validators. (build-uri-reference, build-relative-ref): New constructors. (string->uri-reference): Rename from string->uri. (string->uri, string->relative-ref): Specific constructors. (uri->string): Add #:include-fragment? keyword argument. * module/web/http.scm (parse-request-uri): Use `build-uri-reference', and result is a URI-reference, not URI, object. No longer infer an absent `uri-scheme' is `http'. (write-uri): Just use `uri->string'. (declare-uri-header!): Remove unused function. (declare-uri-reference-header!): Update. Rename from `declare-relative-uri-header!'. * test-suite/tests/web-uri.test ("build-uri-reference"): ("string->uri-reference"): Add. ("uri->string"): Also tests for relative-refs. * test-suite/tests/web-http.test ("read-request-line"): ("write-request-line"): Update for no scheme in some URIs. ("entity headers", "request headers"): Content-location, Referer, and Location should also parse relative-URIs. * test-suite/tests/web-request.test ("example-1"): Expect URI-reference with no scheme.
* readline: Avoid interpreting control characters in pastes.Andy Wingo2017-05-171-0/+2
| | | | | | | | | | * NEWS: Update. * doc/ref/repl-modules.texi (Readline Options): Update for bracketed-paste. * guile-readline/readline.h (SCM_READLINE_BRACKETED_PASTE): Add bracketed-paste option. * guile-readline/readline.c (scm_readline_opts): Add bracketed-paste. (scm_init_readline): Wire up the logic.
* Correct note about Gregorian reform in SRFI-19Zefram2017-04-251-11/+10
| | | | | | | | * doc/ref/srfi-modules.texi (SRFI-19): SRFI-19 specifies proleptic use of the Gregorian calendar, so it was incorrect of the documentation to describe the code as erroneous in doing so. Rewrite the caution more neutrally, and move it to the section about the "date" structure, where it seems most relevant.
* Update release docsAndy Wingo2017-04-191-17/+16
| | | | * doc/release.org: Update for 2.2.
* api-procedures.texi: typo: 'an' -> 'on'Sergei Trofimovich2017-04-191-1/+1
| | | | | | * doc/ref/api-procedures.texi: Fix typo. Signed-off-by: Sergei Trofimovich <slyfox@gentoo.org>
* Documentation typo tweakSergei Trofimovich2017-04-191-1/+1
| | | | | | | * doc/ref/api-data.texi: Tweak 'u+0007' to 'U+0007' (as in the rest of the table). Signed-off-by: Sergei Trofimovich <slyfox@gentoo.org>
* Document guile-2.2 cond-expand feature.Andy Wingo2017-04-191-1/+2
| | | | * doc/ref/srfi-modules.texi (SRFI-0): Mention guile-2.2 feature.
* Fix typo in fold-layout documentationAndy Wingo2017-04-191-2/+2
| | | | | * doc/ref/sxml.texi (SXML Tree Fold): Fix minor typo. Fixes https://bugs.gnu.org/26188.
* Add sandboxed evaluation facilityAndy Wingo2017-04-181-0/+265
| | | | | | | | | * module/ice-9/sandbox.scm: New file. * module/Makefile.am (SOURCES): Add new file. * doc/ref/api-evaluation.texi (Sandboxed Evaluation): New section. * NEWS: Update. * test-suite/tests/sandbox.test: New file. * test-suite/Makefile.am: Add new file.
* Add allow-legacy-syntax-objects? parameterAndy Wingo2017-03-281-0/+38
| | | | | | | | | | * module/ice-9/psyntax.scm (syntax?): Only recognize legacy syntax objects if the new allow-legacy-syntax-objects? parameter is true. * module/ice-9/boot-9.scm (allow-legacy-syntax-objects?): New parameter. * doc/ref/api-macros.texi (Syntax Transformer Helpers): Document the horrible situation with legacy syntax objects. * NEWS: Add entry.
* Revert "Fix "Scheme Syntax" info rendering"Andy Wingo2017-03-101-2/+2
| | | | | This reverts commit 62f08b8f38990c1849ea61cd622f84b3d2611cd9, which was causing failing texi2dvi runs.
* Fix a couple of typos in the docsVladislav Ivanishin2017-03-092-2/+2
| | | | | | * doc/ref/scheme-ideas.texi: the some way -> the same way * doc/ref/scheme-intro.texi: Use @math inside a texinfo command (turns out $math$ is not processed in this context and thus is not rendered correctly).
* VM support for string-set!; slimmer read-stringAndy Wingo2017-03-091-0/+6
| | | | | | | | | | | | | | * doc/ref/vm.texi (Inlined Scheme Instructions): Add string-set!. * libguile/vm-engine.c (string-set!): New opcode. * module/ice-9/rdelim.scm (read-string): Reimplement in terms of a geometrically growing list of strings, to reduce total heap usage when reading big files. * module/language/cps/compile-bytecode.scm (compile-function): Add string-set! support. * module/language/cps/types.scm (string-set!): Update for &u64 index. * module/language/tree-il/compile-cps.scm (convert): Unbox index to string-set!. * module/system/vm/assembler.scm (system): Export string-set!.
* Fix documentation buildAndy Wingo2017-03-071-1/+1
| | | | * doc/ref/api-control.texi (Fluids and Dynamic States): Fix link.
generated by cgit v1.2.3 (git 2.46.2) at 2024-11-23 08:22:49 +0000