summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOwen Taylor <otaylor@src.gnome.org>2001-06-28 21:45:02 +0000
committerOwen Taylor <otaylor@src.gnome.org>2001-06-28 21:45:02 +0000
commit4be0cfddf9b2dfb459700432f2ae00207b3e56d3 (patch)
tree33236b157ddf6c75326df9e70884192541b9d404 /docs
parentfd860cb987e0bc77b8a69363576c01069b40244e (diff)
Buffers Files Tools Edit Search Mule Help Thu Jun 28 17:43:29 2001 Owen Taylor <otaylor@redhat.com>
* glib/tmpl/memory.sgml glib/tmpl/macros_misc.sgml: Add notes about inclusion of string.h to docs on g_memmove, G_VA_COPY. (#54411)
Diffstat (limited to 'docs')
-rw-r--r--docs/reference/ChangeLog6
-rw-r--r--docs/reference/glib/tmpl/macros_misc.sgml5
-rw-r--r--docs/reference/glib/tmpl/memory.sgml7
3 files changed, 14 insertions, 4 deletions
diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 59e00074a..940129d3d 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,9 @@
+Thu Jun 28 17:43:29 2001 Owen Taylor <otaylor@redhat.com>
+
+ * glib/tmpl/memory.sgml glib/tmpl/macros_misc.sgml: Add
+ notes about inclusion of string.h to docs on g_memmove,
+ G_VA_COPY. (#54411)
+
Tue Jun 26 12:28:20 2001 Owen Taylor <otaylor@redhat.com>
* glib/Makefile.am: Fix problem with glibconfig.h
diff --git a/docs/reference/glib/tmpl/macros_misc.sgml b/docs/reference/glib/tmpl/macros_misc.sgml
index cd71ee73b..1fd647e5f 100644
--- a/docs/reference/glib/tmpl/macros_misc.sgml
+++ b/docs/reference/glib/tmpl/macros_misc.sgml
@@ -70,6 +70,11 @@ arrays or arrays on the stack.
<para>
Portable way to copy <type>va_list</type> variables.
</para>
+<para>
+In order to use this function, you must include string.h yourself,
+because this macro may use memmove() and GLib does not include
+string.h for you.
+</para>
<!-- # Unused Parameters # -->
@ap1: the <type>va_list</type> variable to place a copy of @ap2 in.
diff --git a/docs/reference/glib/tmpl/memory.sgml b/docs/reference/glib/tmpl/memory.sgml
index 79def9ff7..1df03a075 100644
--- a/docs/reference/glib/tmpl/memory.sgml
+++ b/docs/reference/glib/tmpl/memory.sgml
@@ -150,12 +150,11 @@ stack frame is cleaned up.
Copies a block of memory @n bytes long, from @s to @d.
The source and destination areas may overlap.
</para>
-<note>
<para>
-On architectures where memmove() is not available, this function is implemented
-using bcopy(), which may not be able to handle overlapping areas.
+In order to use this function, you must include string.h
+yourself, because this macro will typically simply resolve
+to memmove() and GLib does not include string.h for you.
</para>
-</note>
@d: the destination address to copy the bytes to.
@s: the source address to copy the bytes from.