X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=gdb%2FREADME;h=e65c5ea7ffab53ebb71e2a3d3ac4ad09d778b8c7;hb=098caef485a4ece6096e6cdbb4cd9726e4a13386;hp=5881be23af804da6a4807288fdcfacee330f11d4;hpb=a95746f91769c0f65e9393ff83aad0871d1a666b;p=binutils-gdb.git diff --git a/gdb/README b/gdb/README index 5881be23af8..e65c5ea7ffa 100644 --- a/gdb/README +++ b/gdb/README @@ -432,6 +432,15 @@ more obscure GDB `configure' options are not listed here. Use the curses library instead of the termcap library, for text-mode terminal operations. +`--with-debuginfod' + Build GDB with libdebuginfod, the debuginfod client library. Used + to automatically fetch source files and separate debug files from + debuginfod servers using the associated executable's build ID. + Enabled by default if libdebuginfod is installed and found at + configure time. debuginfod is packaged with elfutils, starting + with version 0.178. You can get the latest version from + 'https://sourceware.org/elfutils/'. + `--with-libunwind-ia64' Use the libunwind library for unwinding function call stack on ia64 target platforms. @@ -439,7 +448,8 @@ 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. + library supplied as part of GDB. Readline 7 or newer is required; + this is enforced by the build system. `--with-system-zlib Use the zlib library installed on the host, rather than the @@ -474,6 +484,11 @@ more obscure GDB `configure' options are not listed here. not have liblzma installed, you can get the latest version from `https://tukaani.org/xz/'. +`--with-libgmp-prefix=DIR' + Build GDB using the GMP library installed at the directory DIR. + If your host does not have GMP installed, you can get the latest + version at `https://gmplib.org/'. + `--with-mpfr' Build GDB with GNU MPFR, a library for multiple-precision floating-point computation with correct rounding. (Done by @@ -483,7 +498,7 @@ more obscure GDB `configure' options are not listed here. floating-point formats than the host. If GNU MPFR is not available, GDB 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'. + can get the latest version from `https://www.mpfr.org/'. `--with-python[=PYTHON]' Build GDB with Python scripting support. (Done by default if @@ -491,7 +506,7 @@ more obscure GDB `configure' options are not listed here. GDB 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 + version of Python supported by GDB is 2.6. The optional argument 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. @@ -506,6 +521,16 @@ more obscure GDB `configure' options are not listed here. `pkg-config' executable, which will be queried to find the information needed to compile and link against Guile. +`--enable-source-highlight' + When printing source code, use source highlighting. This requires + libsource-highlight to be installed and is enabled by default + if the library is found. + +`--with-xxhash' + Use libxxhash for hashing. This has no user-visible effect but + speeds up various GDB operations such as symbol loading. Enabled + by default if libxxhash is found. + `--without-included-regex' Don't use the regex library included with GDB (as part of the libiberty library). This is the default on hosts with version 2 @@ -527,6 +552,15 @@ more obscure GDB `configure' options are not listed here. after being built, the location of the system-wide init file will be adjusted accordingly. +`--with-system-gdbinit-dir=DIR' + Configure GDB to automatically load system-wide init files from + a directory. Files with extensions `.gdb', `.py' (if Python + support is enabled) and `.scm' (if Guile support is enabled) are + supported. DIR should be an absolute directory name. If DIR is + in a directory under the configured prefix, and GDB is moved to + another location after being built, the location of the system- + wide init directory will be adjusted accordingly. + `--enable-build-warnings' When building the GDB sources, ask the compiler to warn about any code which looks even vaguely suspicious. It passes many @@ -538,6 +572,19 @@ more obscure GDB `configure' options are not listed here. the compiler, which will fail the compilation if the compiler outputs any warning messages. +`--enable-ubsan' + Enable the GCC undefined behavior sanitizer. By default this is + disabled in GDB releases, but enabled when building from git. + The undefined behavior sanitizer checks for C++ undefined + behavior. It has a performance cost, so if you are looking at + GDB's performance, you should disable it. + +`--enable-unit-tests[=yes|no]' + Enable (i.e., include) support for unit tests when compiling GDB + and GDBServer. Note that if this option is not passed, GDB will + have selftests if it is a development build, and will *not* have + selftests if it is a non-development build. + `configure' accepts other options, for compatibility with configuring other GNU tools recursively. @@ -550,12 +597,11 @@ of remote stubs to be used with remote.c. They are designed to run standalone on an m68k, i386, or SPARC cpu and communicate properly with the remote.c stub over a serial line. - The directory gdb/gdbserver/ contains `gdbserver', a program that + The directory gdbserver/ contains `gdbserver', a program that allows remote debugging for Unix applications. GDBserver is only -supported for some native configurations, including Sun 3, Sun 4, and -Linux. +supported for some native configurations. - The file gdb/gdbserver/README includes further notes on GDBserver; in + The file gdbserver/README includes further notes on GDBserver; in particular, it explains how to build GDBserver for cross-debugging (where GDBserver runs on the target machine, which is of a different architecture than the host machine running GDB).