diff options
author | Neil Jerram <neil@ossau.uklinux.net> | 2001-05-04 21:54:00 +0000 |
---|---|---|
committer | Neil Jerram <neil@ossau.uklinux.net> | 2001-05-04 21:54:00 +0000 |
commit | 7a095584a9bc80eafb9563d1b83b40d9e1f372bf (patch) | |
tree | 7b2e71bb559fef242e62616b3beb0a2ed67294c0 /libguile | |
parent | f92a9df0ff2a0a93153745e27677d59841ac650b (diff) | |
download | guile-7a095584a9bc80eafb9563d1b83b40d9e1f372bf.tar.gz |
* eval.c (scm_promise_p), list.c (scm_append_x, scm_reverse_x),
symbols.c (scm_symbol_to_string), vports.c (scm_make_soft_port):
Change R4RS references to R5RS.
* guile-snarf.awk.in: Fixes so that (i) blank lines in the
docstring source are correctly reproduced in the output (ii)
we don't anymore get occasional trailing quotes. Also reorganized
and commented the code a little.
* scmsigs.c (scm_raise), throw.c (scm_throw): Docstring format
fixes.
* new-docstrings.texi, posix.texi, scheme-control.texi,
scheme-data.texi, scheme-debug.texi, scheme-evaluation.texi,
scheme-io.texi, scheme-memory.texi, scheme-procedures.texi:
Automatic docstring updates (mostly argument name updates and
blank lines).
* scheme-modules.texi: Change double hyphens to single.
* scheme-control.texi (Lazy Catch): Completed.
* posix.texi (Network Databases and Address Conversion): New
subsubsection `IPv6 Address Conversion'.
Diffstat (limited to 'libguile')
-rw-r--r-- | libguile/ChangeLog | 14 | ||||
-rw-r--r-- | libguile/eval.c | 2 | ||||
-rw-r--r-- | libguile/guile-snarf.awk.in | 40 | ||||
-rw-r--r-- | libguile/list.c | 6 | ||||
-rw-r--r-- | libguile/scmsigs.c | 1 | ||||
-rw-r--r-- | libguile/symbols.c | 2 | ||||
-rw-r--r-- | libguile/throw.c | 2 | ||||
-rw-r--r-- | libguile/vports.c | 2 |
8 files changed, 50 insertions, 19 deletions
diff --git a/libguile/ChangeLog b/libguile/ChangeLog index cc9b7ad64..49e8bae09 100644 --- a/libguile/ChangeLog +++ b/libguile/ChangeLog @@ -1,3 +1,17 @@ +2001-05-04 Neil Jerram <neil@ossau.uklinux.net> + + * eval.c (scm_promise_p), list.c (scm_append_x, scm_reverse_x), + symbols.c (scm_symbol_to_string), vports.c (scm_make_soft_port): + Change R4RS references to R5RS. + + * guile-snarf.awk.in: Fixes so that (i) blank lines in the + docstring source are correctly reproduced in the output (ii) + we don't anymore get occasional trailing quotes. Also reorganized + and commented the code a little. + + * scmsigs.c (scm_raise), throw.c (scm_throw): Docstring format + fixes. + 2001-05-04 Martin Grabmueller <mgrabmue@cs.tu-berlin.de> * strop.c (scm_string_split): New procedure. diff --git a/libguile/eval.c b/libguile/eval.c index 4dad2a678..67a45a9dd 100644 --- a/libguile/eval.c +++ b/libguile/eval.c @@ -3809,7 +3809,7 @@ SCM_DEFINE (scm_force, "force", 1, 0, 0, SCM_DEFINE (scm_promise_p, "promise?", 1, 0, 0, (SCM obj), "Return true if @var{obj} is a promise, i.e. a delayed computation\n" - "(@pxref{Delayed evaluation,,,r4rs.info,The Revised^4 Report on Scheme}).") + "(@pxref{Delayed evaluation,,,r5rs.info,The Revised^5 Report on Scheme}).") #define FUNC_NAME s_scm_promise_p { return SCM_BOOL (SCM_TYP16_PREDICATE (scm_tc16_promise, obj)); diff --git a/libguile/guile-snarf.awk.in b/libguile/guile-snarf.awk.in index 64641efad..8d2e73bb3 100644 --- a/libguile/guile-snarf.awk.in +++ b/libguile/guile-snarf.awk.in @@ -96,17 +96,35 @@ BEGIN { FS="|"; print "@deffn primitive " nicer_function_proto > dot_doc_file; } -/SCM_SNARF_DOCSTRING_START/,/SCM_SNARF_DOCSTRING_END.*$/ { copy = $0; - gsub(/.*SCM_SNARF_DOCSTRING_START/,"",copy); - sub(/^\#.*/,"", copy); - sub(/^[ \t]*\"?/,"", copy); - sub(/\"?[ \t]*SCM_SNARF_DOCSTRING_END.*$/,"", copy); - gsub(/\\n\\n\"?/,"\n",copy); - gsub(/\\n\"?[ \t]*$/,"",copy); - gsub(/\\\"/,"\"",copy); - gsub(/\\\\/,"\\",copy); - gsub(/[ \t]*$/,"", copy); - if (copy != "") { print copy > dot_doc_file } +/SCM_SNARF_DOCSTRING_START/,/SCM_SNARF_DOCSTRING_END.*$/ { copy = $0; + + # Trim everything up to and including + # SCM_SNARF_DOCSTRING_START marker. + gsub(/.*SCM_SNARF_DOCSTRING_START/,"",copy); + + # Trim leading whitespace and opening quote. + sub(/^[ \t]*\"?/,"", copy); + + # Trim closing quote and trailing whitespace, or + # closing quote and whitespace followed by the + # SCM_SNARF_DOCSTRING_END marker. + sub(/[ \t]*\"?[ \t]*$/,"", copy); + sub(/[ \t]*\"?[ \t]*SCM_SNARF_DOCSTRING_END.*$/,"", copy); + + # Replace escaped characters. + gsub(/\\n/,"\n",copy); + gsub(/\\\"/,"\"",copy); + gsub(/\\\\/,"\\",copy); + + # Some docstrings end each line with "\n", while + # others don't. Therefore we always strip off one "\n" + # if present at the end of the line. Docstrings must + # therefore always use "\n\n" to indicate a blank line. + if (copy != "") + { + sub(/[ \t]*\n$/, "", copy); + print copy > dot_doc_file; + } } /SCM_SNARF_DOCSTRING_END[ \t]*/ { print "@end deffn" >> dot_doc_file; } diff --git a/libguile/list.c b/libguile/list.c index bf1a1725c..956a4aa85 100644 --- a/libguile/list.c +++ b/libguile/list.c @@ -237,7 +237,7 @@ SCM_DEFINE (scm_append, "append", 0, 0, 1, SCM_DEFINE (scm_append_x, "append!", 0, 0, 1, (SCM lists), "A destructive version of @code{append} (@pxref{Pairs and\n" - "Lists,,,r4rs, The Revised^4 Report on Scheme}). The cdr field\n" + "Lists,,,r5rs, The Revised^5 Report on Scheme}). The cdr field\n" "of each list's final pair is changed to point to the head of\n" "the next list, so no consing is performed. Return a pointer to\n" "the mutated list.") @@ -321,8 +321,8 @@ SCM_DEFINE (scm_reverse, "reverse", 1, 0, 0, SCM_DEFINE (scm_reverse_x, "reverse!", 1, 1, 0, (SCM lst, SCM new_tail), - "A destructive version of @code{reverse} (@pxref{Pairs and Lists,,,r4rs,\n" - "The Revised^4 Report on Scheme}). The cdr of each cell in @var{lst} is\n" + "A destructive version of @code{reverse} (@pxref{Pairs and Lists,,,r5rs,\n" + "The Revised^5 Report on Scheme}). The cdr of each cell in @var{lst} is\n" "modified to point to the previous list element. Return a pointer to the\n" "head of the reversed list.\n\n" "Caveat: because the list is modified in place, the tail of the original\n" diff --git a/libguile/scmsigs.c b/libguile/scmsigs.c index 1625c3a87..bc57429ae 100644 --- a/libguile/scmsigs.c +++ b/libguile/scmsigs.c @@ -470,7 +470,6 @@ SCM_DEFINE (scm_usleep, "usleep", 1, 0, 0, SCM_DEFINE (scm_raise, "raise", 1, 0, 0, (SCM sig), - "\n" "Sends a specified signal @var{sig} to the current process, where\n" "@var{sig} is as described for the kill procedure.") #define FUNC_NAME s_scm_raise diff --git a/libguile/symbols.c b/libguile/symbols.c index 0f47fa3be..1bb2778a8 100644 --- a/libguile/symbols.c +++ b/libguile/symbols.c @@ -430,7 +430,7 @@ SCM_DEFINE (scm_symbol_to_string, "symbol->string", 1, 0, 0, (SCM s), "Return the name of @var{symbol} as a string. If the symbol was\n" "part of an object returned as the value of a literal expression\n" - "(section @pxref{Literal expressions,,,r4rs, The Revised^4\n" + "(section @pxref{Literal expressions,,,r5rs, The Revised^5\n" "Report on Scheme}) or by a call to the @code{read} procedure,\n" "and its name contains alphabetic characters, then the string\n" "returned will contain characters in the implementation's\n" diff --git a/libguile/throw.c b/libguile/throw.c index a4e610b7b..8be37a006 100644 --- a/libguile/throw.c +++ b/libguile/throw.c @@ -591,7 +591,7 @@ SCM_DEFINE (scm_throw, "throw", 1, 0, 1, "Invoke the catch form matching @var{key}, passing @var{args} to the\n" "@var{handler}. \n\n" "@var{key} is a symbol. It will match catches of the same symbol or of\n" - "#t.\n\n" + "@code{#t}.\n\n" "If there is no handler at all, Guile prints an error and then exits.") #define FUNC_NAME s_scm_throw { diff --git a/libguile/vports.c b/libguile/vports.c index 9a4975aff..ba4230e50 100644 --- a/libguile/vports.c +++ b/libguile/vports.c @@ -171,7 +171,7 @@ SCM_DEFINE (scm_make_soft_port, "make-soft-port", 2, 0, 0, "there is no useful operation for them to perform.\n" "\n" "If thunk 3 returns @code{#f} or an @code{eof-object}\n" - "(@pxref{Input, eof-object?, ,r4rs, The Revised^4 Report on\n" + "(@pxref{Input, eof-object?, ,r5rs, The Revised^5 Report on\n" "Scheme}) it indicates that the port has reached end-of-file.\n" "For example:\n" "\n" |