]> git.ipfire.org Git - thirdparty/binutils-gdb.git/commitdiff
Update documentation to mention Pygments
authorTom Tromey <tromey@adacore.com>
Thu, 12 Aug 2021 18:38:37 +0000 (12:38 -0600)
committerTom Tromey <tromey@adacore.com>
Thu, 12 Aug 2021 20:29:56 +0000 (14:29 -0600)
Philippe Blain pointed out that the gdb documentation does not mention
that Pygments may be used for source highlighting.  This patch updates
the docs to reflect how highlighting is actually done.

(cherry picked from commit 6a33fa0efec5aa87230a84bcab3c097237dd7f90)

gdb/doc/ChangeLog
2021-08-12  Tom Tromey  <tromey@adacore.com>

* gdb.texinfo (Output Styling): Mention Pygments.

gdb/doc/ChangeLog
gdb/doc/gdb.texinfo

index 9adc42414a0c9c43e41fdc9d1de1741507273519..67822b88a91ab1fb6d52fd6b106191e2044a6010 100644 (file)
@@ -1,3 +1,7 @@
+2021-08-12  Tom Tromey  <tromey@adacore.com>
+
+       * gdb.texinfo (Output Styling): Mention Pygments.
+
 2021-07-26  Tankut Baris Aktemur  <tankut.baris.aktemur@intel.com>
 
        PR gdb/28076
index a486bbe3607991174aac7ac9c5911967f3dd4871..8608c86352155b532d5f88b7d856cc37b25b542a 100644 (file)
@@ -26033,10 +26033,16 @@ Show the current state of styling.
 
 @item set style sources @samp{on|off}
 Enable or disable source code styling.  This affects whether source
-code, such as the output of the @code{list} command, is styled.  Note
-that source styling only works if styling in general is enabled, and
-if @value{GDBN} was linked with the GNU Source Highlight library.  The
-default is @samp{on}.
+code, such as the output of the @code{list} command, is styled.  The
+default is @samp{on}.  Note that source styling only works if styling
+in general is enabled, and if a source highlighting library is
+available to @value{GDBN}.
+
+There are two ways that highlighting can be done.  First, if
+@value{GDBN} was linked with the GNU Source Highlight library, then it
+is used.  Otherwise, if @value{GDBN} was configured with Python
+scripting support, and if the Python Pygments package is available,
+then it will be used.
 
 @item show style sources
 Show the current state of source code styling.