1
Fork 0
mirror of https://git.savannah.gnu.org/git/guile.git synced 2025-05-06 15:40:29 +02:00
Commit graph

2582 commits

Author SHA1 Message Date
Neil Jerram
006064cefe * Extended documentation on exceptions.
* Minor changes to Martin's doc on continuations.
2001-04-22 13:15:42 +00:00
Neil Jerram
0447f5c918 * Improve doc for exceptions. 2001-04-20 15:59:30 +00:00
Martin Grabmüller
ee75653426 * scheme-evaluation.texi (Comments): Document normal comments and
comment conventions.
	(Block Comments): Documented multiline comments.
	(Case Sensitivity): Documented R5RS and Guile behaviour and how to
	switch it off.

	* scheme-control.texi (Continuations): Added some documentation
	for call/cc.
	(Exceptions): Added xref to `Continuations'.

	* scheme-binding.texi (Binding Reflection): Typo fix.
2001-04-20 14:43:30 +00:00
Neil Jerram
ffda60939e Doc fixes 2001-04-20 13:26:55 +00:00
Neil Jerram
a26fb67d83 * Added recipe-guidelines.txt. 2001-04-20 11:20:06 +00:00
Martin Grabmüller
2da0d971eb * intro.texi (Using Guile Modules): Wrote intro to using modules.
(Writing New Modules): New intro for writing modules.
	(Reporting Bugs): Added info about what is a bug and what to
	include in a bug report (taken and adapted from the Emacs
	Reference Manual).
2001-04-20 07:31:25 +00:00
Martin Grabmüller
65f7a6501c * scheme-control.texi (while do): Added documentation for named
let.

	* scheme-binding.texi (Internal Definitions): New explanation of
	`Internal Definitions'.
	(Top Level): Documented behaviour of top level definitions.
	(Binding Constructs): New introductory text.
	(Local Bindings): Explain concept of local bindings.  Document
	let, let* and letrec.

	* scheme-modules.texi (Modules): Added menu descriptions.
	(Scheme and modules, The Guile module system): Some whitespace
	cleanup
	(The Guile module system): Layout fixes, docstring fix for
	`define-module'.
2001-04-19 21:35:44 +00:00
Martin Grabmüller
da54ce854a * scheme-control.texi (Multiple Values): Documented concept of
multiple values, added docs for `receive'.
	(begin): Documented `begin'.
	(if cond case): Documented `if', `cond' and `case'.
	(and or): Documented `and' and `or'.
	(while do): Documented `do' and `while'.

	* scheme-procedures.texi (Optional Arguments): Split the node,
	added introductory text, added menu for subsections.
	(let-optional Reference, let-keywords Reference),
	(lambda* Reference, define* Reference): Added syntax documentation
	for all exported procedures from (ice-9 optargs).
2001-04-17 19:29:52 +00:00
Martin Grabmüller
239d2912a2 * scheme-utility.texi (General Conversion): New node, added
`object->string'.
	(Equality): Added definition and explanation of `sameness'.

	* posix.texi (System Identification): Added `gethostname' and
	`sethostname'.
	(Processes): Added `setpriority' and `getpriority'.
	(User Information): Added `cuserid' and `getlogin'.
	(Ports and File Descriptors): Added `flock'.
	(Processes): Added `chroot'.
	(File System): Added `mkstemp!'.
	(Encryption): New node, added `crypt' and `getpass'.

	* new-docstrings.texi: Moved several docstrings over to the
	reference manual (see above which).

	* scheme-data.texi (Data Types), (Numerical Tower): Add explicit
	@bullet to @itemize to satisfy older `makeinfo'.
2001-04-17 15:34:33 +00:00
Neil Jerram
813c57db52 * Updated doc for SCM_ASSERT. 2001-04-16 09:38:32 +00:00
Neil Jerram
c4d0cddd4c * Texinfo markup fixes. 2001-04-13 11:12:01 +00:00
Neil Jerram
505392ae32 * Incorporate Dirk's description of SCM and scm_bits_t.
* Remove obsolete notes about needing to use SCM_NIMP.
2001-04-13 09:56:37 +00:00
Neil Jerram
a58c0d5f51 * Fix dvi build problem. 2001-04-11 22:04:30 +00:00
Martin Grabmüller
ac0b7ebd29 * scheme-scheduling.texi (Arbiters): New explanatory text.
(Asyncs): New explanations and documentation.
	(Scheduling): Added menu entry descriptions.
	(Fluids): New documentation.
2001-04-11 16:41:46 +00:00
Martin Grabmüller
f4f2b29a5f * scheme-procedures.texi (Lambda): Documented the lambda form.
(Procedure Properties): Concept and usage explanation added.
	(Procedures with Setters): Explain by example, introduce
	definitions.

	* scheme-data.texi (Symbols and Variables): Split and reorganized
	this section.
	(Symbols): New introductory text.
	(Characters): Added char-ci* procedures to rn index.
2001-04-11 14:56:30 +00:00
Neil Jerram
19aad96c76 * Apply improved Texinfo markup patch from Dale P. Smith. 2001-04-10 19:49:29 +00:00
Neil Jerram
2b6aab94e1 * Fix typo. 2001-04-10 18:41:09 +00:00
Neil Jerram
89d04205b4 * Clean up doc and docstring for shared substrings and read only strings. 2001-04-09 21:44:06 +00:00
Neil Jerram
5411d88250 * Remove obsolete `@c docstring' comments. 2001-04-09 18:36:40 +00:00
Martin Grabmüller
5c4b24e10f 2001-04-09 Martin Grabmueller <mgrabmue@cs.tu-berlin.de>
* scheme-data.texi (Pairs): New data type and procedure
	description.
	(Lists): Added new subsections for grouping the list procedures.
	(Hooks): Added new nodes for hook subsections.
	(String Syntax): New node, factoring out read syntax.
	(Strings): Some blurb about allowed characters, zero-termination
	etc.
	(Keywords): Added menu descriptions.

2001-04-08  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>

	* scheme-indices.texi (R5RS Index): Print index `rn', not `r5'.

	* guile.texi: The index formerly known as `r5' is now called `rn'.

	* scheme-utility.texi, scheme-procedures.texi, scheme-io.texi,
	scheme-evaluation.texi, scheme-control.texi, scheme-data.texi:
	Changed all @r5index entries to @rnindex.

2001-04-06  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>

	* scheme-data.texi (Hooks): Added hook description and
	constraints.

2001-04-04  Martin Grabmueller  <mgrabmue@cs.tu-berlin.de>

	* scheme-data.texi (Alphabetic Case Mapping),
	(String Comparison): Rearranged function order.
	(Vectors): Reorganized, new introductory text, docs about read
	syntax.
2001-04-09 16:16:09 +00:00
Thien-Thi Nguyen
a8944ae1c7 *** empty log message *** 2001-04-06 19:07:51 +00:00
Thien-Thi Nguyen
83b646f27f (Higher level thread procedures): Replace some
instances of `@var' with `@code'.
2001-04-06 10:00:35 +00:00
Thien-Thi Nguyen
f302fb90bf (Higher level thread procedures): Rewrite. 2001-04-06 09:52:45 +00:00
Martin Grabmüller
2954ad93a0 * scheme-data.texi (Alphabetic Case Mapping),
(String Comparison): Rearranged function order.
	(Vectors): Reorganized, new introductory text, docs about read
	syntax.
2001-04-04 15:20:03 +00:00
Martin Grabmüller
ae9f3a1582 * scheme-options.texi, scheme-procedures.texi,
scheme-modules.texi, scheme-memory.texi, scheme-control.texi,
	scheme-utility.texi, scheme-io.texi, scheme-evaluation.texi,
	scheme-data.texi: Removed a lot of ARGFIXME's after tweaking
	docstrings and C source.

	* new-docstrings.texi, scheme-io.texi, scheme-data.texi,
	posix.texi, scheme-control.texi, scheme-evaluation.texi,
	scheme-memory.texi, scheme-procedures.texi, scheme-modules.texi,
	scheme-scheduling.texi: Automated docstring merging.
2001-04-03 13:11:14 +00:00
Neil Jerram
abaec75d1d * data-rep.texi (Immediates vs. Non-immediates): Update
out-of-date documentation.  (Thanks to Dirk Herrmann for the
report!)
(Immediates vs Non-immediates): Renamed without the dot, since the
dot causes `info' not to be able to display this node!

* Makefile.am (guile_TEXINFOS): Add in a few more source files
that had got left out.
2001-04-02 21:53:20 +00:00
Neil Jerram
b0839672af * scheme-reading.texi (Further Reading): Add bullets to further
reading list.
* gh.texi: Insert page break before chapter.  Remove page breaks
within the chapter.
* Makefile.am: Add script-getopt.texi.
* guile.texi (Top): Include and link to new script-getopt.texi
chapter.
* script-getopt.texi: New chapter on command line handling.
(Written and contributed by Martin Grabmueller, revised by me.)
2001-03-30 22:16:20 +00:00
Neil Jerram
a4318577ec * Typo fix. 2001-03-30 16:37:51 +00:00
Martin Grabmüller
b576faf1c0 * scheme-data.texi (Strings): Reorganized the whole `Strings'
section and wrote introductory material for each new subsection.
2001-03-27 15:42:12 +00:00
Marius Vollmer
62532db38d *** empty log message *** 2001-03-25 00:34:33 +00:00
Marius Vollmer
95a62aedd8 * intro.texi (Modules and Extensions): Some short text about
dynamic libraries and modules.
2001-03-25 00:31:10 +00:00
Neil Jerram
a6be01a45e * Minor docstring updates. 2001-03-23 17:24:28 +00:00
Neil Jerram
8d009ee4a2 * Fix typos. 2001-03-23 16:16:15 +00:00
Neil Jerram
028321d473 * Add two files that I seem to have omitted in the move from guile-doc to guile-core.
(guile-tut.texi and ChangeLog-guile-doc-tutorial)
2001-03-23 15:24:38 +00:00
Neil Jerram
780ee65e3b * Automatic docstring updates.
* Commit utilities and tracking files for automatic docstring updates.
2001-03-23 15:05:40 +00:00
Martin Grabmüller
13c2013d00 * scheme-options.texi (Evaluator options): Added evaluator
options, corrected docs for evaluator trap options.

	* scheme-evaluation.texi (Scheme Read): New docs for read-options,
	read-enable, read-disable and read-set! and cross references to
	option nodes.
	(Evaluator Options): New docs for eval-options, eval-enable,
	eval-disable and eval-set!, traps, trap-enable, trap-disable and
	trap-set! and cross references to option nodes.
	(Evaluator Behaviour): Renamed node from `Evaluator options' to
	avoid name clash.

	* scheme-io.texi (String Ports): Added docs for SRFI-6 procedures.
	(Void Ports): Corrected introductory comment.
2001-03-20 11:51:26 +00:00
Martin Grabmüller
fcaedf9936 * scheme-data.texi (Arithmetic): Documented the arithmetic
procedures.
	(Integer Operations): Added documentation.
	(Comparison): Added documentation.
	(Complex): Added documentation.
	(Symbols and Variables): Comment out `builtin-bindings', which is
	removed according to NEWS.
	(Pairs): Added documentation.
	* scheme-io.texi: Added R5RS index entries for all R5RS
	procedures.
	(File Ports): New docs for `call-with-input-file',
	`call-with-output-file', `with-input-from-file',
	`with-output-to-file', `with-error-to-file'.
	* scheme-control.texi, scheme-utility.texi,
	* scheme-procedures.texi: Added R5RS index entries for all R5RS
	procedures.
	* scheme-evaluation.texi (Fly Evaluation): Added documentation for
	`apply'.  Added R5RS index entries for all R5RS procedures.
	* scheme-data.texi: Added R5RS index entries for all R5RS
	procedures.  Removed R5RS index entries for `ass{q,v,occ}-set!'.
	Removed explicit entries into the function entries.  They are
	automagic.
	(Vectors): Added documentation for `make-vector', `vector-ref' and
	`vector-set!'.
2001-03-16 17:00:21 +00:00
Marius Vollmer
c4f810a466 *** empty log message *** 2001-03-12 00:52:43 +00:00
Marius Vollmer
ac3e3f5b7b * intro.texi: Changed to reflect current practice better. Added
stuff about writing Guile Extensions (aka dynamically loaded
shared libraries).
2001-03-12 00:50:08 +00:00
Mikael Djurfeldt
7d4351201f *** empty log message *** 2001-03-10 03:13:12 +00:00
Mikael Djurfeldt
0442652715 * goops.texi (VERSION): Bumped to version 0.3.
* goops-tutorial.texi, goops.texi: Updated to reflext new
define-method syntax.
2001-03-10 03:08:28 +00:00
Neil Jerram
fff043abc0 Move doc files into guile-core distribution (7) 2001-03-09 09:35:13 +00:00
Neil Jerram
c2dc2842b6 Move doc files into guile-core distribution (6) 2001-03-09 09:20:46 +00:00
Neil Jerram
9cca936fb8 Move doc files into guile-core distribution (4) 2001-03-09 08:53:15 +00:00
Neil Jerram
009e2b3044 Move doc files into guile-core distribution (3) 2001-03-09 08:42:37 +00:00
Neil Jerram
4aa8647c0a Move doc files into guile-core distribution (2) 2001-03-09 08:28:57 +00:00
Neil Jerram
38a93523eb Move doc files into guile-core distribution (1) 2001-03-09 08:22:00 +00:00
Neil Jerram
da00aada47 Removed texinfo.tex 2001-03-09 08:16:16 +00:00
Neil Jerram
4bc59ee759 * Removed old copy of data-rep.texi. 2001-03-09 08:09:48 +00:00
Neil Jerram
14dd0e27c3 * Remove data-rep.texi from Makefile.am.
* Explain data-rep.texi retirement in README.
2001-02-15 22:54:40 +00:00