]> git.ipfire.org Git - thirdparty/elfutils.git/commitdiff
doc: Always distribute all man pages
authorMark Wielaard <mark@klomp.org>
Tue, 11 Jun 2024 16:48:49 +0000 (18:48 +0200)
committerMark Wielaard <mark@klomp.org>
Sun, 16 Jun 2024 12:33:21 +0000 (14:33 +0200)
dist targets shouldn't depend on configure conditionals.

     * doc/Makefile.am: Remove DEBUGINFOD and LIBDEBUGINFOD from
     dist targets. Add comments about which man pages go into which
     section.

Signed-off-by: Mark Wielaard <mark@klomp.org>
doc/Makefile.am

index 0c094af2289b8d31e5cd8fbb2b439890b25e9c84..d707f2adf19edfb156d87c11c5c8916793976d0a 100644 (file)
 ## You should have received a copy of the GNU General Public License
 ## along with this program.  If not, see <http://www.gnu.org/licenses/>.
 EXTRA_DIST = COPYING-GFDL README
+
+# Section 1, Executable programs or shell commands
+# The tools manpages that depend on program prefix (will get eu- prefixed)
 dist_man1_MANS=readelf.1 elfclassify.1 srcfiles.1
-notrans_dist_man3_MANS=elf_update.3 elf_getdata.3 elf_clone.3 elf_begin.3
-notrans_dist_man7_MANS=
-notrans_dist_man8_MANS=
-notrans_dist_man1_MANS=
 
-if DEBUGINFOD
-if !LIBDEBUGINFOD
-notrans_dist_man7_MANS += debuginfod-client-config.7
-endif
-notrans_dist_man8_MANS += debuginfod.8 debuginfod.service.8
-endif
+# Tools that don't get a program prefix
+notrans_dist_man1_MANS= debuginfod-find.1
+
+# Section 3, Library calls
+# libelf man pages (all notrans)
+notrans_dist_man3_MANS=elf_update.3 elf_getdata.3 elf_clone.3 elf_begin.3
 
-if LIBDEBUGINFOD
-notrans_dist_man7_MANS += debuginfod-client-config.7
+# libdebuginfod man pages (also notrans)
+# Note we include them even when not building them because we want
+# to ship (dist) them always. It is up to the user if they build the
+# library or not, but they should always get the manual.
 notrans_dist_man3_MANS += debuginfod_add_http_header.3
 notrans_dist_man3_MANS += debuginfod_begin.3
 notrans_dist_man3_MANS += debuginfod_end.3
@@ -44,5 +45,9 @@ notrans_dist_man3_MANS += debuginfod_get_user_data.3
 notrans_dist_man3_MANS += debuginfod_get_url.3
 notrans_dist_man3_MANS += debuginfod_set_progressfn.3
 notrans_dist_man3_MANS += debuginfod_set_user_data.3
-notrans_dist_man1_MANS += debuginfod-find.1
-endif
+
+# Section 7, Miscellaneous (including macro packages and conventions)
+notrans_dist_man7_MANS= debuginfod-client-config.7
+
+# Section 8, System administration commands
+notrans_dist_man8_MANS= debuginfod.8 debuginfod.service.8