diff mbox

[v2,2/7] Cleanup some docs about memory write

Message ID 557F0D2E.7040200@ericsson.com
State New
Headers show

Commit Message

Simon Marchi June 15, 2015, 5:36 p.m. UTC
On 15-06-15 05:57 AM, Pedro Alves wrote:
> On 06/12/2015 08:17 PM, Simon Marchi wrote:
> 
>> Actually it seems obvious now. I'll drop this part from the patch. If we want
>> to clarify the comments we should do it for all the functions of the interface
>> (in a separate patch).
>>
>> Well then, all that remains would be to fix that stale comment. Is it ok?
> 
> OK.
> 
> Thanks,
> Pedro Alves


Thanks, pushed as this:

From cb6f16cf4f7a12f9aadddc0451d47f0511729c8d Mon Sep 17 00:00:00 2001
From: Simon Marchi <simon.marchi@ericsson.com>
Date: Mon, 15 Jun 2015 13:34:47 -0400
Subject: [PATCH] Cleanup write_memory doc

This doc about write_memory seems outdated.

gdb/ChangeLog:

	* corefile.c (write_memory): Update doc.
	* gdbcore.h (write_memory): Same.
---
 gdb/ChangeLog  | 5 +++++
 gdb/corefile.c | 4 ++--
 gdb/gdbcore.h  | 6 ++----
 3 files changed, 9 insertions(+), 6 deletions(-)
diff mbox

Patch

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index db7fb63..a63d894 100644
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,8 @@ 
+2015-06-15  Simon Marchi  <simon.marchi@ericsson.com>
+
+	* corefile.c (write_memory): Update doc.
+	* gdbcore.h (write_memory): Same.
+
 2015-06-15  Jan Kratochvil  <jan.kratochvil@redhat.com>

 	* linux-tdep.c (enum filterflags): Make it from anonymous enum.
diff --git a/gdb/corefile.c b/gdb/corefile.c
index a042e6d..5246f71 100644
--- a/gdb/corefile.c
+++ b/gdb/corefile.c
@@ -383,8 +383,8 @@  read_memory_typed_address (CORE_ADDR addr, struct type *type)
   return extract_typed_address (buf, type);
 }

-/* Same as target_write_memory, but report an error if can't
-   write.  */
+/* See gdbcore.h.  */
+
 void
 write_memory (CORE_ADDR memaddr,
 	      const bfd_byte *myaddr, ssize_t len)
diff --git a/gdb/gdbcore.h b/gdb/gdbcore.h
index a437c8a..0c08b37 100644
--- a/gdb/gdbcore.h
+++ b/gdb/gdbcore.h
@@ -101,10 +101,8 @@  extern void read_memory_string (CORE_ADDR, char *, int);

 CORE_ADDR read_memory_typed_address (CORE_ADDR addr, struct type *type);

-/* This takes a char *, not void *.  This is probably right, because
-   passing in an int * or whatever is wrong with respect to
-   byteswapping, alignment, different sizes for host vs. target types,
-   etc.  */
+/* Same as target_write_memory, but report an error if can't
+   write.  */

 extern void write_memory (CORE_ADDR memaddr, const gdb_byte *myaddr,
 			  ssize_t len);