[patch][gdb,etc] Add configure option to disable building internal documentation.

Brooks Moses brooks@codesourcery.com
Tue Nov 6 23:18:00 GMT 2007


Currently, GDB's documentation targets build (and install) a number of
documents that are only relevant to people who are developing and/or
building the compiler, and which are not relevant to the end user on
whose system they have been installed.  These add clutter to the system
(thereby potentially confusing users), and are an inconvenience to
people who are packaging distributions.

This patch adds an --enable-internal-docs configure flag, which controls
whether or not this "internal" documentation is built and installed.  It
is on by default, so that the current behavior is unchanged.  Specifying
--disable-internal-docs (or --enable-internal-docs=no) will turn off
this "internal" documentation, so that the only documentation which is
built is that which is useful to an end-user.

Specifically, the documents disabled with --disable-internal-docs are
standards and configure from etc/, and gdbint, stabs, and annotate from
gdb/doc/.  This affects pdf, html, ps, and info documentation.

(I also have a corresponding patch for libiberty; my understanding is
that this should go to GCC first, and then it will get merged to
src/libiberty, yes?)

Tested by building gdb with various iterations of this flag, and
confirming that it works as expected and doesn't break the build.  Ok to
commit?

- Brooks

gdb/ChangeLog -------------------------------------------------------
2007-11-06  Brooks Moses  <brooks@codesourcery.com>

	* doc/configure.ac (enable-internal-docs): New option.
	(enable_internal_docs): New AC_SUBST variable.
	* Makefile.in: Condition internal documentation on
	enable_internal_docs.
	* configure: Regenerated.

etc/ChangeLog -------------------------------------------------------
2007-11-06  Brooks Moses  <brooks@codesourcery.com>

	* doc/configure.ac (enable-internal-docs): New option.
	(enable_internal_docs): New AC_SUBST variable.
	* Makefile.in: Condition internal documentation on
	enable_internal_docs.
	(install-info, install-html, install-pdf): Loop over
	filenames rather than hardcoding them.
	* configure: Regenerated.

---------------------------------------------------------------------
-------------- next part --------------
An embedded and charset-unspecified text was scrubbed...
Name: 2007-11-06_internal-docs2a.diff
URL: <http://sourceware.org/pipermail/gdb-patches/attachments/20071106/946c6c0b/attachment.ksh>


More information about the Gdb-patches mailing list