summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNeil Jerram <neil@ossau.uklinux.net>2001-11-18 22:10:41 +0000
committerNeil Jerram <neil@ossau.uklinux.net>2001-11-18 22:10:41 +0000
commit694a9bb34e8c07fa265373876323e5aa30465334 (patch)
tree6ae43435737a1910cc37eac3b36aea22b84253e3
parent3096b33f0d2984fa602c9943078f078668d3d542 (diff)
downloadguile-694a9bb34e8c07fa265373876323e5aa30465334.tar.gz
* Updates for string- and vector-move-right/left! docstrings.
* Update Tcl war URLs.
-rw-r--r--doc/maint/guile.texi18
-rw-r--r--doc/ref/ChangeLog5
-rwxr-xr-xdoc/ref/scheme-data.texi18
-rw-r--r--doc/tutorial/ChangeLog5
-rw-r--r--doc/tutorial/guile-tut.texi4
-rw-r--r--libguile/ChangeLog6
-rw-r--r--libguile/vectors.c16
7 files changed, 64 insertions, 8 deletions
diff --git a/doc/maint/guile.texi b/doc/maint/guile.texi
index a099e3dd7..1b7eb67c9 100644
--- a/doc/maint/guile.texi
+++ b/doc/maint/guile.texi
@@ -4986,13 +4986,27 @@ returned by @code{vector-fill!} is unspecified.
vector-move-left!
@deffn {Scheme Procedure} vector-move-left! vec1 start1 end1 vec2 start2
@deffnx {C Function} scm_vector_move_left_x (vec1, start1, end1, vec2, start2)
-Vector version of @code{substring-move-left!}.
+Copy elements from @var{vec1}, positions @var{start1} to @var{end1},
+to @var{vec2} starting at position @var{start2}. @var{start1} and
+@var{start2} are inclusive indices; @var{end1} is exclusive.
+
+@code{vector-move-left!} copies elements in leftmost order.
+Therefore, in the case where @var{vec1} and @var{vec2} refer to the
+same vector, @code{vector-move-left!} is usually appropriate when
+@var{start1} is greater than @var{start2}.
@end deffn
vector-move-right!
@deffn {Scheme Procedure} vector-move-right! vec1 start1 end1 vec2 start2
@deffnx {C Function} scm_vector_move_right_x (vec1, start1, end1, vec2, start2)
-Vector version of @code{substring-move-right!}.
+Copy elements from @var{vec1}, positions @var{start1} to @var{end1},
+to @var{vec2} starting at position @var{start2}. @var{start1} and
+@var{start2} are inclusive indices; @var{end1} is exclusive.
+
+@code{vector-move-right!} copies elements in rightmost order.
+Therefore, in the case where @var{vec1} and @var{vec2} refer to the
+same vector, @code{vector-move-right!} is usually appropriate when
+@var{start1} is less than @var{start2}.
@end deffn
major-version
diff --git a/doc/ref/ChangeLog b/doc/ref/ChangeLog
index 8236d1649..ed8f871c2 100644
--- a/doc/ref/ChangeLog
+++ b/doc/ref/ChangeLog
@@ -1,3 +1,8 @@
+2001-11-18 Neil Jerram <neil@ossau.uklinux.net>
+
+ * scheme-data.texi (Vectors): Autoupdate docs for
+ vector-move-left! and vector-move-right!.
+
2001-11-16 Neil Jerram <neil@ossau.uklinux.net>
* debugging.texi, deprecated.texi, intro.texi, misc-modules.texi,
diff --git a/doc/ref/scheme-data.texi b/doc/ref/scheme-data.texi
index e8ffd3a81..77e9a654c 100755
--- a/doc/ref/scheme-data.texi
+++ b/doc/ref/scheme-data.texi
@@ -3515,12 +3515,26 @@ returned by @code{vector-fill!} is unspecified.
@deffn {Scheme Procedure} vector-move-left! vec1 start1 end1 vec2 start2
@deffnx {C Function} scm_vector_move_left_x (vec1, start1, end1, vec2, start2)
-Vector version of @code{substring-move-left!}.
+Copy elements from @var{vec1}, positions @var{start1} to @var{end1},
+to @var{vec2} starting at position @var{start2}. @var{start1} and
+@var{start2} are inclusive indices; @var{end1} is exclusive.
+
+@code{vector-move-left!} copies elements in leftmost order.
+Therefore, in the case where @var{vec1} and @var{vec2} refer to the
+same vector, @code{vector-move-left!} is usually appropriate when
+@var{start1} is greater than @var{start2}.
@end deffn
@deffn {Scheme Procedure} vector-move-right! vec1 start1 end1 vec2 start2
@deffnx {C Function} scm_vector_move_right_x (vec1, start1, end1, vec2, start2)
-Vector version of @code{substring-move-right!}.
+Copy elements from @var{vec1}, positions @var{start1} to @var{end1},
+to @var{vec2} starting at position @var{start2}. @var{start1} and
+@var{start2} are inclusive indices; @var{end1} is exclusive.
+
+@code{vector-move-right!} copies elements in rightmost order.
+Therefore, in the case where @var{vec1} and @var{vec2} refer to the
+same vector, @code{vector-move-right!} is usually appropriate when
+@var{start1} is less than @var{start2}.
@end deffn
@subsection Vector Selection
diff --git a/doc/tutorial/ChangeLog b/doc/tutorial/ChangeLog
index b784f824c..eea1de221 100644
--- a/doc/tutorial/ChangeLog
+++ b/doc/tutorial/ChangeLog
@@ -1,3 +1,8 @@
+2001-11-18 Neil Jerram <neil@ossau.uklinux.net>
+
+ * guile-tut.texi (History of Guile and its motivations): Update
+ Tcl war URLs.
+
2001-09-19 Thien-Thi Nguyen <ttn@glug.org>
* guile-tut.texi: Fix improper `@result' usage.
diff --git a/doc/tutorial/guile-tut.texi b/doc/tutorial/guile-tut.texi
index 477cdac3e..eb6345d86 100644
--- a/doc/tutorial/guile-tut.texi
+++ b/doc/tutorial/guile-tut.texi
@@ -285,7 +285,7 @@ In the fall of 1994, Richard Stallman, director of the GNU project,
posted an article with the subject "Why you should not use Tcl", in
which he argued that Tcl is inadequate as an extension language. This
generated a flurry of flames (available in the hypermail archive
-(@url{http://www.utdallas.edu/acc/glv/Tcl/war/}) @strong{The Tcl War}).
+(@url{http://www.vanderburg.org/Tcl/war/}) @strong{The Tcl War}).
@cindex Stallman, Richard
@cindex GNU project
@cindex Tcl
@@ -293,7 +293,7 @@ generated a flurry of flames (available in the hypermail archive
The result was that Stallman then proposed his design for the GNU
Extension Language, first called GEL and then renamed Guile. The
discussion triggered by that article is also available in a hypermail
-archive, @url{http://www.utdallas.edu/acc/glv/Tcl/war2/}.
+archive, @url{http://www.vanderburg.org/Tcl/war2/}.
One interesting feature of this GNU Extension Language plan was that
users should have a @emph{choice} of languages to use in extending their
diff --git a/libguile/ChangeLog b/libguile/ChangeLog
index 53b6a1b19..b88a6ee4d 100644
--- a/libguile/ChangeLog
+++ b/libguile/ChangeLog
@@ -1,3 +1,9 @@
+2001-11-18 Neil Jerram <neil@ossau.uklinux.net>
+
+ * vectors.c (scm_vector_move_left_x, scm_vector_move_right_x):
+ Rewrite docstrings without reference to substring-move-left/right,
+ since the latter no longer exist.
+
2001-11-17 Dirk Herrmann <D.Herrmann@tu-bs.de>
* eval.c: Removed bogus comment about acros.
diff --git a/libguile/vectors.c b/libguile/vectors.c
index 36ffda380..425eee58a 100644
--- a/libguile/vectors.c
+++ b/libguile/vectors.c
@@ -275,7 +275,13 @@ scm_vector_equal_p(SCM x, SCM y)
SCM_DEFINE (scm_vector_move_left_x, "vector-move-left!", 5, 0, 0,
(SCM vec1, SCM start1, SCM end1, SCM vec2, SCM start2),
- "Vector version of @code{substring-move-left!}.")
+ "Copy elements from @var{vec1}, positions @var{start1} to @var{end1},\n"
+ "to @var{vec2} starting at position @var{start2}. @var{start1} and\n"
+ "@var{start2} are inclusive indices; @var{end1} is exclusive.\n\n"
+ "@code{vector-move-left!} copies elements in leftmost order.\n"
+ "Therefore, in the case where @var{vec1} and @var{vec2} refer to the\n"
+ "same vector, @code{vector-move-left!} is usually appropriate when\n"
+ "@var{start1} is greater than @var{start2}.")
#define FUNC_NAME s_scm_vector_move_left_x
{
long i;
@@ -298,7 +304,13 @@ SCM_DEFINE (scm_vector_move_left_x, "vector-move-left!", 5, 0, 0,
SCM_DEFINE (scm_vector_move_right_x, "vector-move-right!", 5, 0, 0,
(SCM vec1, SCM start1, SCM end1, SCM vec2, SCM start2),
- "Vector version of @code{substring-move-right!}.")
+ "Copy elements from @var{vec1}, positions @var{start1} to @var{end1},\n"
+ "to @var{vec2} starting at position @var{start2}. @var{start1} and\n"
+ "@var{start2} are inclusive indices; @var{end1} is exclusive.\n\n"
+ "@code{vector-move-right!} copies elements in rightmost order.\n"
+ "Therefore, in the case where @var{vec1} and @var{vec2} refer to the\n"
+ "same vector, @code{vector-move-right!} is usually appropriate when\n"
+ "@var{start1} is less than @var{start2}.")
#define FUNC_NAME s_scm_vector_move_right_x
{
long i;