Re: [patch] Remove BITS_BIG_ENDIAN from defs.h

[Markus Deuling <deuling@de.ibm.com>]

[-- Attachment #1: Type: text/plain, Size: 1620 bytes --]

Eli Zaretskii schrieb:
>> Date: Wed, 16 Jan 2008 06:57:05 +0100
>> From: Markus Deuling <deuling@de.ibm.com>
>> CC: GDB Patches <gdb-patches@sourceware.org>, Eli Zaretskii <eliz@gnu.org>,
>>         Daniel Jacobowitz <drow@false.org>
>>
>> Eli, is the documentation ok like this ?
> 
> I have a few comments:
> 
>> ChangeLog Doc:
>>
>> 	* gdbint.texinfo (BITS_BIG_ENDIAN): Rewrite to match
>> 	gdbarch_bits_big_endian.
> 
> Actually, this should say something like:
> 
> 	* gdbint.texinfo (Target Conditionals): Replace the
> 	description of BITS_BIG_ENDIAN with a description of
> 	gdbarch_bits_big_endian.
> 
> Note that the text in parens is the name of the node in which you make
> the change.
> 
>> +@item gdbarch_bits_big_endian (@var{gdbarch})
>> +@findex gdbarch_bits_big_endian
>> +Set this if the numbering of bits in the targets does @strong{not} match the
> 
> "Set this" isn't right, because you don't "set" a function.  I think
> it's better to say "Define this to return non-zero it bits are
> numbered in the big-endian order (i.e., the rightmost bit has the
> largest number), zero otherwise."
> 
> Btw, should we also document set_gdbarch_bits_big_endian?
> 

Hi Eli,

thank you very much for your review. I reworked the patch and added an entry for set_gdbarch_bits_big_endian.
I also added it to the Target Conditionals node. Is that right?

Is this ok ?

ChangeLog:

	* gdbint.texinfo (Target Conditionals): Replace the description of
	BITS_BIG_ENDIAN with a description of gdbarch_bits_big_endian.



Regards,
Markus

-- 
  Markus Deuling
  GNU Toolchain for Linux on Cell BE
  deuling@de.ibm.com


[-- Attachment #2: diff-doc-ENDIAN --]
[-- Type: text/plain, Size: 1270 bytes --]

diff -urpN src/gdb/doc/gdbint.texinfo dev/gdb/doc/gdbint.texinfo
--- src/gdb/doc/gdbint.texinfo	2008-01-05 17:49:53.000000000 +0100
+++ dev/gdb/doc/gdbint.texinfo	2008-01-17 07:57:10.000000000 +0100
@@ -3344,12 +3344,19 @@ Used to notify if the compiler promotes 
 parameter to an @code{int}, but still reports the parameter as its
 original type, rather than the promoted type.
 
-@item BITS_BIG_ENDIAN
-@findex BITS_BIG_ENDIAN
-Define this if the numbering of bits in the targets does @strong{not} match the
-endianness of the target byte order.  A value of 1 means that the bits
+@item gdbarch_bits_big_endian (@var{gdbarch})
+@findex gdbarch_bits_big_endian
+This is used if the numbering of bits in the targets does @strong{not} match
+the endianness of the target byte order.  A value of 1 means that the bits
 are numbered in a big-endian bit order, 0 means little-endian.
 
+@item set_gdbarch_bits_big_endian (@var{gdbarch}, @var{bits_big_endian})
+@findex set_gdbarch_bits_big_endian
+Calling set_gdbarch_bits_big_endian with a value of 1 indicates that the
+bits in the target are numbered in a big-endian bit order, 0 indicates
+little-endian.
+
+
 @item BREAKPOINT
 @findex BREAKPOINT
 This is the character array initializer for the bit pattern to put into