bfd/ChangeLog

[binutils.git] / bfd / coffcode.h

diff --git a/bfd/coffcode.h b/bfd/coffcode.h
index 484fb6b7ec77b2e51b03c33389e127d3810cf538..4f53e470e42c894ce0266f55f9e359abac2bd212 100644 (file)
--- a/bfd/coffcode.h
+++ b/bfd/coffcode.h
@@ -153,6 +153,14 @@ SUBSUBSECTION
        points to a function that allows the value of the flag to be altered
        at runtime, on formats that support long section names at all; on
        other formats it points to a stub that returns an error indication.
+       
+       With input BFDs, the flag is set according to whether any long section
+       names are detected while reading the section headers.  For a completely
+       new BFD, the flag is set to the default for the target format.  This
+       information can be used by a client of the BFD library when deciding
+       what output format to generate, and means that a BFD that is opened
+       for read and subsequently converted to a writeable BFD and modified
+       in-place will retain whatever format it had on input.
 
        If @code{COFF_LONG_SECTION_NAMES} is simply defined (blank), or is
        defined to the value "1", then long section names are enabled by