COFF CALC_ADDEND comment

Message ID Y8VJCZte0qnkPRWk@squeak.grove.modra.org
State Repeat Merge
Headers
Series COFF CALC_ADDEND comment |

Checks

Context Check Description
snail/binutils-gdb-check warning Git am fail log

Commit Message

Alan Modra Jan. 16, 2023, 12:54 p.m. UTC
  Old COFF (and AOUT) targets have unusual relocation addends.

	* coffcode.h (<Reading relocations>): Describe COFF addends.
  

Patch

diff --git a/bfd/coffcode.h b/bfd/coffcode.h
index e952bd77d6a..168bb8a55c2 100644
--- a/bfd/coffcode.h
+++ b/bfd/coffcode.h
@@ -5092,6 +5092,14 @@  SUBSUBSECTION
 	structure, in a back end specific way. For instance, the 386
 	uses the @code{r_type} to directly produce an index
 	into a howto table vector.
+
+	o Note that @code{arelent.addend} for COFF is often not what
+	most people understand as a relocation addend, but rather an
+	adjustment to the relocation addend stored in section contents
+	of relocatable object files.  The value found in section
+	contents may also be confusing, depending on both symbol value
+	and addend somewhat similar to the field value for a
+	final-linked object.  See @code{CALC_ADDEND}.
 */
 
 #ifndef CALC_ADDEND