From patchwork Sun Sep 30 12:01:14 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Tom Tromey X-Patchwork-Id: 29585 Received: (qmail 317 invoked by alias); 30 Sep 2018 12:01:33 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Unsubscribe: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Delivered-To: mailing list gdb-patches@sourceware.org Received: (qmail 302 invoked by uid 89); 30 Sep 2018 12:01:32 -0000 Authentication-Results: sourceware.org; auth=none X-Spam-SWARE-Status: No, score=-25.4 required=5.0 tests=AWL, BAYES_00, GIT_PATCH_0, GIT_PATCH_1, GIT_PATCH_2, GIT_PATCH_3, KAM_SHORT, RCVD_IN_DNSWL_NONE, SPF_HELO_PASS autolearn=ham version=3.3.2 spammy=expat, accordingly, Copy, formats X-HELO: gateway21.websitewelcome.com Received: from gateway21.websitewelcome.com (HELO gateway21.websitewelcome.com) (192.185.45.155) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with ESMTP; Sun, 30 Sep 2018 12:01:29 +0000 Received: from cm15.websitewelcome.com (cm15.websitewelcome.com [100.42.49.9]) by gateway21.websitewelcome.com (Postfix) with ESMTP id 36C8F400C80B0 for ; Sun, 30 Sep 2018 07:01:28 -0500 (CDT) Received: from box5379.bluehost.com ([162.241.216.53]) by cmsmtp with SMTP id 6aPVgEDch8YaU6aPbghcSQ; Sun, 30 Sep 2018 07:01:26 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=tromey.com; s=default; h=Message-Id:Date:Subject:Cc:To:From:Sender:Reply-To:MIME-Version :Content-Type:Content-Transfer-Encoding:Content-ID:Content-Description: Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc:Resent-Message-ID: In-Reply-To:References:List-Id:List-Help:List-Unsubscribe:List-Subscribe: List-Post:List-Owner:List-Archive; bh=amonjZYS/y725XJhOmJIS5kYG5bux7goyHaE9ONQZmg=; b=TIyjzZwMuh7KEfNDx8xSJWPucO fIq0YFpjrns2wZG4F8QfAg48MsRbkdRBuc6QgxdPKylWAJQkOhaM8/BdYg9mZTksitLPNMB14AZTp NWVdbNtLLjmnJN+CDtskS2orw; Received: from 97-122-190-66.hlrn.qwest.net ([97.122.190.66]:54594 helo=bapiya.Home) by box5379.bluehost.com with esmtpsa (TLSv1.2:ECDHE-RSA-AES256-GCM-SHA384:256) (Exim 4.91) (envelope-from ) id 1g6aPU-003xST-Uz; Sun, 30 Sep 2018 07:01:17 -0500 From: Tom Tromey To: gdb-patches@sourceware.org Cc: Tom Tromey Subject: [PATCH] Copy configure option documentation to gdb.texinfo Date: Sun, 30 Sep 2018 06:01:14 -0600 Message-Id: <20180930120114.27510-1-tom@tromey.com> I realized that while I'd updated the README, I didn't update gdb.texinfo to document the options to configure. This patch copies the text from README into gdb.texinfo, adding Texinfo markup. gdb/ChangeLog 2018-09-30 Tom Tromey * README: Minor change. gdb/doc/ChangeLog 2018-09-30 Tom Tromey * gdb.texinfo (Configure Options): Document configure options. --- gdb/ChangeLog | 4 ++ gdb/README | 4 +- gdb/doc/ChangeLog | 4 ++ gdb/doc/gdb.texinfo | 153 +++++++++++++++++++++++++++++++++++++++++++- 4 files changed, 160 insertions(+), 5 deletions(-) diff --git a/gdb/README b/gdb/README index a1798e431f..5881be23af 100644 --- a/gdb/README +++ b/gdb/README @@ -439,11 +439,11 @@ more obscure GDB `configure' options are not listed here. `--with-system-readline' Use the readline library installed on the host, rather than the - library supplied as part of GDB tarball. + library supplied as part of GDB. `--with-system-zlib Use the zlib library installed on the host, rather than the - library supplied as part of GDB tarball. + library supplied as part of GDB. `--with-expat' Build GDB with Expat, a library for XML parsing. (Done by diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo index b7a32c5407..49a2cdce9e 100644 --- a/gdb/doc/gdb.texinfo +++ b/gdb/doc/gdb.texinfo @@ -35593,11 +35593,158 @@ Configure @value{GDBN} for cross-debugging programs running on the specified @var{target}. Without this option, @value{GDBN} is configured to debug programs that run on the same machine (@var{host}) as @value{GDBN} itself. -There is no convenient way to generate a list of all available targets. +There is no convenient way to generate a list of all available +targets. Also see the @code{--enable-targets} option, below. @end table -There are many other options available as well, but they are generally -needed for special purposes only. +There are many other options that are specific to @value{GDBN}. This +lists just the most common ones; there are some very specialized +options not described here. + +@table @code +@item --enable-targets=@r{[}@var{target}@r{]}@dots{} +@itemx --enable-targets=all +Configure @value{GDBN} for cross-debugging programs running on the +specified list of targets. The special value @samp{all} configures +@value{GDBN} for debugging programs running on any target it supports. + +@item --with-gdb-datadir=@var{path} +Set the @value{GDBN}-specific data directory. @value{GDBN} will look +here for certain supporting files or scripts. This defaults to the +@file{gdb} subdirectory of @samp{datadi} (which can be set using +@code{--datadir}). + +@item --with-relocated-sources=@var{dir} +Sets up the default source path substitution rule so that directory +names recorded in debug information will be automatically adjusted for +any directory under @var{dir}. @var{dir} should be a subdirectory of +@value{GDBN}'s configured prefix, the one mentioned in the +@code{--prefix} or @code{--exec-prefix} options to configure. This +option is useful if GDB is supposed to be moved to a different place +after it is built. + +@item --enable-64-bit-bfd +Enable 64-bit support in BFD on 32-bit hosts. + +@item --disable-gdbmi +Build @value{GDBN} without the GDB/MI machine interface +(@pxref{GDB/MI}). + +@item --enable-tui +Build @value{GDBN} with the text-mode full-screen user interface +(TUI). Requires a curses library (ncurses and cursesX are also +supported). + +@item --with-curses +Use the curses library instead of the termcap library, for text-mode +terminal operations. + +@item --with-libunwind-ia64 +Use the libunwind library for unwinding function call stack on ia64 +target platforms. See http://www.nongnu.org/libunwind/index.html for +details. + +@item --with-system-readline +Use the readline library installed on the host, rather than the +library supplied as part of @value{GDBN}. + +@item --with-system-zlib +Use the zlib library installed on the host, rather than the library +supplied as part of @value{GDBN}. + +@item --with-expat +Build @value{GDBN} with Expat, a library for XML parsing. (Done by +default if libexpat is installed and found at configure time.) This +library is used to read XML files supplied with @value{GDBN}. If it +is unavailable, some features, such as remote protocol memory maps, +target descriptions, and shared library lists, that are based on XML +files, will not be available in @value{GDBN}. If your host does not +have libexpat installed, you can get the latest version from +`http://expat.sourceforge.net'. + +@item --with-libiconv-prefix@r{[}=@var{dir}@r{]} + +Build @value{GDBN} with GNU libiconv, a character set encoding +conversion library. This is not done by default, as on GNU systems +the @code{iconv} that is built in to the C library is sufficient. If +your host does not have a working @code{iconv}, you can get the latest +version of GNU iconv from `https://www.gnu.org/software/libiconv/'. + +@value{GDBN}'s build system also supports building GNU libiconv as +part of the overall build. @xref{Requirements}. + +@item --with-lzma +Build @value{GDBN} with LZMA, a compression library. (Done by default +if liblzma is installed and found at configure time.) LZMA is used by +@value{GDBN}'s "mini debuginfo" feature, which is only useful on +platforms using the ELF object file format. If your host does not +have liblzma installed, you can get the latest version from +`https://tukaani.org/xz/'. + +@item --with-mpfr +Build @value{GDBN} with GNU MPFR, a library for multiple-precision +floating-point computation with correct rounding. (Done by default if +GNU MPFR is installed and found at configure time.) This library is +used to emulate target floating-point arithmetic during expression +evaluation when the target uses different floating-point formats than +the host. If GNU MPFR is not available, @value{GDBN} will fall back +to using host floating-point arithmetic. If your host does not have +GNU MPFR installed, you can get the latest version from +`http://www.mpfr.org'. + +@item --with-python@r{[}=@var{python}@r{]} +Build @value{GDBN} with Python scripting support. (Done by default if +libpython is present and found at configure time.) Python makes +@value{GDBN} scripting much more powerful than the restricted CLI +scripting language. If your host does not have Python installed, you +can find it on `http://www.python.org/download/'. The oldest version +of Python supported by GDB is 2.4. The optional argument @var{python} +is used to find the Python headers and libraries. It can be either +the name of a Python executable, or the name of the directory in which +Python is installed. + +@item --with-guile[=GUILE]' +Build @value{GDBN} with GNU Guile scripting support. (Done by default +if libguile is present and found at configure time.) If your host +does not have Guile installed, you can find it at +`https://www.gnu.org/software/guile/'. The optional argument GUILE +can be a version number, which will cause @code{configure} to try to +use that version of Guile; or the file name of a @code{pkg-config} +executable, which will be queried to find the information needed to +compile and link against Guile. + +@item --without-included-regex +Don't use the regex library included with @value{GDBN} (as part of the +libiberty library). This is the default on hosts with version 2 of +the GNU C library. + +@item --with-sysroot=@var{dir} +Use @var{dir} as the default system root directory for libraries whose +file names begin with @file{/lib}' or @file{/usr/lib'}. (The value of +@var{dir} can be modified at run time by using the @command{set +sysroot} command.) If @var{dir} is under the @value{GDBN} configured +prefix (set with @code{--prefix} or @code{--exec-prefix options}, the +default system root will be automatically adjusted if and when +@value{GDBN} is moved to a different location. + +@item --with-system-gdbinit=@var{file} +Configure @value{GDBN} to automatically load a system-wide init file. +@var{file} should be an absolute file name. If @var{file} is in a +directory under the configured prefix, and @value{GDBN} is moved to +another location after being built, the location of the system-wide +init file will be adjusted accordingly. + +@item --enable-build-warnings +When building the @value{GDBN} sources, ask the compiler to warn about +any code which looks even vaguely suspicious. It passes many +different warning flags, depending on the exact version of the +compiler you are using. + +@item --enable-werror +Treat compiler warnings as werrors. It adds the @code{-Werror} flag +to the compiler, which will fail the compilation if the compiler +outputs any warning messages. +@end table @node System-wide configuration @section System-wide configuration and settings