libbfd.texi zero size

Message ID ZO/SSQvOm453+DTV@squeak.grove.modra.org
State New
Headers
Series libbfd.texi zero size |

Checks

Context Check Description
linaro-tcwg-bot/tcwg_binutils_build--master-arm warning Patch is already merged
linaro-tcwg-bot/tcwg_binutils_build--master-aarch64 warning Patch is already merged
linaro-tcwg-bot/tcwg_binutils_check--master-aarch64 warning Patch is already merged
linaro-tcwg-bot/tcwg_binutils_check--master-arm warning Patch is already merged

Commit Message

Alan Modra Aug. 30, 2023, 11:35 p.m. UTC
  Pattern rules in doc/local.mk exist that specify how to make
libbfd.texi from libfd.h or libbfd.c.  Since both files exist and the
libbfd.h rule is first, libbfd.h is used.  libbfd.h doesn't contain
the documentation..

	* doc/local.mk (doc/%stamp): Put rule making this from %.c
	before %.h rule.
	* Makefile.in: Regenerate.
	* libbfd.c (Byte swapping routines): Don't omit description.
  

Patch

diff --git a/bfd/Makefile.in b/bfd/Makefile.in
index bb530271fca..f8bc859e6cf 100644
--- a/bfd/Makefile.in
+++ b/bfd/Makefile.in
@@ -2489,10 +2489,10 @@  doc/chew.stamp: $(srcdir)/doc/chew.c doc/$(am__dirstamp)
 
 .PRECIOUS: doc/%.stamp
 doc/%.texi: doc/%.stamp ; @true
-doc/%.stamp: $(srcdir)/%.h $(srcdir)/doc/doc.str $(MKDOC) doc/$(am__dirstamp)
-	$(AM_V_GEN)$(REGEN_TEXI)
 doc/%.stamp: $(srcdir)/%.c $(srcdir)/doc/doc.str $(MKDOC) doc/$(am__dirstamp)
 	$(AM_V_GEN)$(REGEN_TEXI)
+doc/%.stamp: $(srcdir)/%.h $(srcdir)/doc/doc.str $(MKDOC) doc/$(am__dirstamp)
+	$(AM_V_GEN)$(REGEN_TEXI)
 
 # Avoid the %.stamp generating a builddir/bfd.texi that overrides the
 # srcdir/ as well as regenerating doc/bfd.info for each make run.
diff --git a/bfd/doc/local.mk b/bfd/doc/local.mk
index d80f70416a3..f602e7d947f 100644
--- a/bfd/doc/local.mk
+++ b/bfd/doc/local.mk
@@ -111,10 +111,10 @@  REGEN_TEXI = \
 
 .PRECIOUS: %D%/%.stamp
 %D%/%.texi: %D%/%.stamp ; @true
-%D%/%.stamp: $(srcdir)/%.h $(srcdir)/%D%/doc.str $(MKDOC) %D%/$(am__dirstamp)
-	$(AM_V_GEN)$(REGEN_TEXI)
 %D%/%.stamp: $(srcdir)/%.c $(srcdir)/%D%/doc.str $(MKDOC) %D%/$(am__dirstamp)
 	$(AM_V_GEN)$(REGEN_TEXI)
+%D%/%.stamp: $(srcdir)/%.h $(srcdir)/%D%/doc.str $(MKDOC) %D%/$(am__dirstamp)
+	$(AM_V_GEN)$(REGEN_TEXI)
 
 # Avoid the %.stamp generating a builddir/bfd.texi that overrides the
 # srcdir/ as well as regenerating doc/bfd.info for each make run.
diff --git a/bfd/libbfd.c b/bfd/libbfd.c
index fafdf49cb04..3c37717f775 100644
--- a/bfd/libbfd.c
+++ b/bfd/libbfd.c
@@ -728,6 +728,13 @@  SYNOPSIS
 	void bfd_putl16 (bfd_vma, void *);
 	uint64_t bfd_get_bits (const void *, int, bool);
 	void bfd_put_bits (uint64_t, void *, int, bool);
+
+DESCRIPTION
+	Read and write integers in a particular endian order.  getb
+	and putb functions handle big-endian, getl and putl handle
+	little-endian.  bfd_get_bits and bfd_put_bits specify
+	big-endian by passing TRUE in the last parameter,
+	little-endian by passing FALSE.
 */
 
 bfd_vma