gdb: update store_integer's comment

The comment of store_integer seems slightly outdated and does not refer to
the variants that take an array view.  Update the comment and add comments
to the various instantiations.

Approved-By: Simon Marchi <simon.marchi@efficios.com>

diff --git a/gdb/extract-store-integer.c b/gdb/extract-store-integer.c
index a7bce99362df136c4f166ebcfa3b7c8974e79d00..67e4534a27d61b9fff7796c60281ba2e51c736e9 100644 (file)
--- a/gdb/extract-store-integer.c
+++ b/gdb/extract-store-integer.c
@@ -129,8 +129,8 @@ extract_typed_address (const gdb_byte *buf, struct type *type)
   return gdbarch_pointer_to_address (type->arch (), type, buf);
 }
 
-/* All 'store' functions accept a host-format integer and store a
-   target-format integer at ADDR which is LEN bytes long.  */
+/* See extract-store-integer.h.  */
+
 template<typename T, typename>
 void
 store_integer (gdb::array_view<gdb_byte> dst, enum bfd_endian byte_order,

diff --git a/gdb/extract-store-integer.h b/gdb/extract-store-integer.h
index 76dfd49d62a84d0700ed3b138bbec640762f63d6..b6f734d23a7eb37ec8e40c26659c72a30a2295c4 100644 (file)
--- a/gdb/extract-store-integer.h
+++ b/gdb/extract-store-integer.h
@@ -56,13 +56,16 @@ extract_unsigned_integer (const gdb_byte *addr, int len,
 extern CORE_ADDR extract_typed_address (const gdb_byte *buf,
                                        struct type *type);
 
-/* All 'store' functions accept a host-format integer and store a
-   target-format integer at ADDR which is LEN bytes long.  */
+/* Take host-format integer VAL and store it as target-format integer at
+   DST.  */
 
 template<typename T, typename = RequireLongest<T>>
 extern void store_integer (gdb::array_view<gdb_byte> dst,
                           bfd_endian byte_order, T val);
 
+/* Take host-format integer VAL and store it as target-format integer at
+   ADDR which is LEN bytes long.  */
+
 template<typename T>
 static inline void
 store_integer (gdb_byte *addr, int len, bfd_endian byte_order, T val)
@@ -70,6 +73,9 @@ store_integer (gdb_byte *addr, int len, bfd_endian byte_order, T val)
   return store_integer (gdb::make_array_view (addr, len), byte_order, val);
 }
 
+/* Take host-format signed integer VAL and store it as target-format
+   signed integer at DST.  */
+
 static inline void
 store_signed_integer (gdb::array_view<gdb_byte> dst, bfd_endian byte_order,
                      LONGEST val)
@@ -77,6 +83,9 @@ store_signed_integer (gdb::array_view<gdb_byte> dst, bfd_endian byte_order,
   return store_integer (dst, byte_order, val);
 }
 
+/* Take host-format signed integer VAL and store it as target-format
+   signed integer at ADDR which is LEN bytes long.  */
+
 static inline void
 store_signed_integer (gdb_byte *addr, int len, bfd_endian byte_order,
                      LONGEST val)
@@ -85,6 +94,9 @@ store_signed_integer (gdb_byte *addr, int len, bfd_endian byte_order,
                               val);
 }
 
+/* Take host-format unsigned integer VAL and store it as target-format
+   unsigned integer at DST.  */
+
 static inline void
 store_unsigned_integer (gdb::array_view<gdb_byte> dst, bfd_endian byte_order,
                        ULONGEST val)
@@ -92,6 +104,9 @@ store_unsigned_integer (gdb::array_view<gdb_byte> dst, bfd_endian byte_order,
   return store_integer (dst, byte_order, val);
 }
 
+/* Take host-format unsigned integer VAL and store it as target-format
+   unsigned integer at ADDR which is LEN bytes long.  */
+
 static inline void
 store_unsigned_integer (gdb_byte *addr, int len, bfd_endian byte_order,
                        ULONGEST val)