Make the objfile constructor private

[deliverable/binutils-gdb.git] / gdb / README

diff --git a/gdb/README b/gdb/README
index 5881be23af804da6a4807288fdcfacee330f11d4..be7fdcb65d807c178a54ee4c3ab87a086bf75284 100644 (file)
--- a/gdb/README
+++ b/gdb/README
@@ -439,7 +439,8 @@ more obscure GDB `configure' options are not listed here.
 
 `--with-system-readline'
      Use the readline library installed on the host, rather than the
 
 `--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
 
 `--with-system-zlib
      Use the zlib library installed on the host, rather than the


@@ -491,7 +492,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
      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.
      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 +507,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.
 
      `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
 `--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 +538,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. 
 
      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
 `--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 +558,19 @@ more obscure GDB `configure' options are not listed here.
      the compiler, which will fail the compilation if the compiler
      outputs any warning messages.
 
      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.
 
 `configure' accepts other options, for compatibility with configuring
 other GNU tools recursively.