123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <html>
- <!-- Copyright (C) 1988-2017 Free Software Foundation, Inc.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.3 or
- any later version published by the Free Software Foundation; with the
- Invariant Sections being "Funding Free Software", the Front-Cover
- Texts being (a) (see below), and with the Back-Cover Texts being (b)
- (see below). A copy of the license is included in the section entitled
- "GNU Free Documentation License".
- (a) The FSF's Front-Cover Text is:
- A GNU Manual
- (b) The FSF's Back-Cover Text is:
- You have freedom to copy and modify this GNU Manual, like GNU
- software. Copies published by the Free Software Foundation raise
- funds for GNU development. -->
- <!-- Created by GNU Texinfo 5.2, http://www.gnu.org/software/texinfo/ -->
- <head>
- <title>Using the GNU Compiler Collection (GCC): Diagnostic Message Formatting Options</title>
- <meta name="description" content="Using the GNU Compiler Collection (GCC): Diagnostic Message Formatting Options">
- <meta name="keywords" content="Using the GNU Compiler Collection (GCC): Diagnostic Message Formatting Options">
- <meta name="resource-type" content="document">
- <meta name="distribution" content="global">
- <meta name="Generator" content="makeinfo">
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
- <link href="index.html#Top" rel="start" title="Top">
- <link href="Option-Index.html#Option-Index" rel="index" title="Option Index">
- <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
- <link href="Invoking-GCC.html#Invoking-GCC" rel="up" title="Invoking GCC">
- <link href="Warning-Options.html#Warning-Options" rel="next" title="Warning Options">
- <link href="Objective_002dC-and-Objective_002dC_002b_002b-Dialect-Options.html#Objective_002dC-and-Objective_002dC_002b_002b-Dialect-Options" rel="prev" title="Objective-C and Objective-C++ Dialect Options">
- <style type="text/css">
- <!--
- a.summary-letter {text-decoration: none}
- blockquote.smallquotation {font-size: smaller}
- div.display {margin-left: 3.2em}
- div.example {margin-left: 3.2em}
- div.indentedblock {margin-left: 3.2em}
- div.lisp {margin-left: 3.2em}
- div.smalldisplay {margin-left: 3.2em}
- div.smallexample {margin-left: 3.2em}
- div.smallindentedblock {margin-left: 3.2em; font-size: smaller}
- div.smalllisp {margin-left: 3.2em}
- kbd {font-style:oblique}
- pre.display {font-family: inherit}
- pre.format {font-family: inherit}
- pre.menu-comment {font-family: serif}
- pre.menu-preformatted {font-family: serif}
- pre.smalldisplay {font-family: inherit; font-size: smaller}
- pre.smallexample {font-size: smaller}
- pre.smallformat {font-family: inherit; font-size: smaller}
- pre.smalllisp {font-size: smaller}
- span.nocodebreak {white-space:nowrap}
- span.nolinebreak {white-space:nowrap}
- span.roman {font-family:serif; font-weight:normal}
- span.sansserif {font-family:sans-serif; font-weight:normal}
- ul.no-bullet {list-style: none}
- -->
- </style>
- </head>
- <body lang="en" bgcolor="#FFFFFF" text="#000000" link="#0000FF" vlink="#800080" alink="#FF0000">
- <a name="Diagnostic-Message-Formatting-Options"></a>
- <div class="header">
- <p>
- Next: <a href="Warning-Options.html#Warning-Options" accesskey="n" rel="next">Warning Options</a>, Previous: <a href="Objective_002dC-and-Objective_002dC_002b_002b-Dialect-Options.html#Objective_002dC-and-Objective_002dC_002b_002b-Dialect-Options" accesskey="p" rel="prev">Objective-C and Objective-C++ Dialect Options</a>, Up: <a href="Invoking-GCC.html#Invoking-GCC" accesskey="u" rel="up">Invoking GCC</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
- </div>
- <hr>
- <a name="Options-to-Control-Diagnostic-Messages-Formatting"></a>
- <h3 class="section">3.7 Options to Control Diagnostic Messages Formatting</h3>
- <a name="index-options-to-control-diagnostics-formatting"></a>
- <a name="index-diagnostic-messages"></a>
- <a name="index-message-formatting"></a>
- <p>Traditionally, diagnostic messages have been formatted irrespective of
- the output device’s aspect (e.g. its width, …). You can use the
- options described below
- to control the formatting algorithm for diagnostic messages,
- e.g. how many characters per line, how often source location
- information should be reported. Note that some language front ends may not
- honor these options.
- </p>
- <dl compact="compact">
- <dt><code>-fmessage-length=<var>n</var></code></dt>
- <dd><a name="index-fmessage_002dlength"></a>
- <p>Try to format error messages so that they fit on lines of about
- <var>n</var> characters. If <var>n</var> is zero, then no line-wrapping is
- done; each error message appears on a single line. This is the
- default for all front ends.
- </p>
- </dd>
- <dt><code>-fdiagnostics-show-location=once</code></dt>
- <dd><a name="index-fdiagnostics_002dshow_002dlocation"></a>
- <p>Only meaningful in line-wrapping mode. Instructs the diagnostic messages
- reporter to emit source location information <em>once</em>; that is, in
- case the message is too long to fit on a single physical line and has to
- be wrapped, the source location won’t be emitted (as prefix) again,
- over and over, in subsequent continuation lines. This is the default
- behavior.
- </p>
- </dd>
- <dt><code>-fdiagnostics-show-location=every-line</code></dt>
- <dd><p>Only meaningful in line-wrapping mode. Instructs the diagnostic
- messages reporter to emit the same source location information (as
- prefix) for physical lines that result from the process of breaking
- a message which is too long to fit on a single line.
- </p>
- </dd>
- <dt><code>-fdiagnostics-color[=<var>WHEN</var>]</code></dt>
- <dt><code>-fno-diagnostics-color</code></dt>
- <dd><a name="index-fdiagnostics_002dcolor"></a>
- <a name="index-highlight_002c-color"></a>
- <a name="index-GCC_005fCOLORS-environment-variable"></a>
- <p>Use color in diagnostics. <var>WHEN</var> is ‘<samp>never</samp>’, ‘<samp>always</samp>’,
- or ‘<samp>auto</samp>’. The default depends on how the compiler has been configured,
- it can be any of the above <var>WHEN</var> options or also ‘<samp>never</samp>’
- if <code>GCC_COLORS</code> environment variable isn’t present in the environment,
- and ‘<samp>auto</samp>’ otherwise.
- ‘<samp>auto</samp>’ means to use color only when the standard error is a terminal.
- The forms <samp>-fdiagnostics-color</samp> and <samp>-fno-diagnostics-color</samp> are
- aliases for <samp>-fdiagnostics-color=always</samp> and
- <samp>-fdiagnostics-color=never</samp>, respectively.
- </p>
- <p>The colors are defined by the environment variable <code>GCC_COLORS</code>.
- Its value is a colon-separated list of capabilities and Select Graphic
- Rendition (SGR) substrings. SGR commands are interpreted by the
- terminal or terminal emulator. (See the section in the documentation
- of your text terminal for permitted values and their meanings as
- character attributes.) These substring values are integers in decimal
- representation and can be concatenated with semicolons.
- Common values to concatenate include
- ‘<samp>1</samp>’ for bold,
- ‘<samp>4</samp>’ for underline,
- ‘<samp>5</samp>’ for blink,
- ‘<samp>7</samp>’ for inverse,
- ‘<samp>39</samp>’ for default foreground color,
- ‘<samp>30</samp>’ to ‘<samp>37</samp>’ for foreground colors,
- ‘<samp>90</samp>’ to ‘<samp>97</samp>’ for 16-color mode foreground colors,
- ‘<samp>38;5;0</samp>’ to ‘<samp>38;5;255</samp>’
- for 88-color and 256-color modes foreground colors,
- ‘<samp>49</samp>’ for default background color,
- ‘<samp>40</samp>’ to ‘<samp>47</samp>’ for background colors,
- ‘<samp>100</samp>’ to ‘<samp>107</samp>’ for 16-color mode background colors,
- and ‘<samp>48;5;0</samp>’ to ‘<samp>48;5;255</samp>’
- for 88-color and 256-color modes background colors.
- </p>
- <p>The default <code>GCC_COLORS</code> is
- </p><div class="smallexample">
- <pre class="smallexample">error=01;31:warning=01;35:note=01;36:range1=32:range2=34:locus=01:\
- quote=01:fixit-insert=32:fixit-delete=31:\
- diff-filename=01:diff-hunk=32:diff-delete=31:diff-insert=32
- </pre></div>
- <p>where ‘<samp>01;31</samp>’ is bold red, ‘<samp>01;35</samp>’ is bold magenta,
- ‘<samp>01;36</samp>’ is bold cyan, ‘<samp>32</samp>’ is green, ‘<samp>34</samp>’ is blue,
- ‘<samp>01</samp>’ is bold, and ‘<samp>31</samp>’ is red.
- Setting <code>GCC_COLORS</code> to the empty string disables colors.
- Supported capabilities are as follows.
- </p>
- <dl compact="compact">
- <dt><code>error=</code></dt>
- <dd><a name="index-error-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for error: markers.
- </p>
- </dd>
- <dt><code>warning=</code></dt>
- <dd><a name="index-warning-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for warning: markers.
- </p>
- </dd>
- <dt><code>note=</code></dt>
- <dd><a name="index-note-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for note: markers.
- </p>
- </dd>
- <dt><code>range1=</code></dt>
- <dd><a name="index-range1-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for first additional range.
- </p>
- </dd>
- <dt><code>range2=</code></dt>
- <dd><a name="index-range2-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for second additional range.
- </p>
- </dd>
- <dt><code>locus=</code></dt>
- <dd><a name="index-locus-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for location information, ‘<samp>file:line</samp>’ or
- ‘<samp>file:line:column</samp>’ etc.
- </p>
- </dd>
- <dt><code>quote=</code></dt>
- <dd><a name="index-quote-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for information printed within quotes.
- </p>
- </dd>
- <dt><code>fixit-insert=</code></dt>
- <dd><a name="index-fixit_002dinsert-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for fix-it hints suggesting text to
- be inserted or replaced.
- </p>
- </dd>
- <dt><code>fixit-delete=</code></dt>
- <dd><a name="index-fixit_002ddelete-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for fix-it hints suggesting text to
- be deleted.
- </p>
- </dd>
- <dt><code>diff-filename=</code></dt>
- <dd><a name="index-diff_002dfilename-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for filename headers within generated patches.
- </p>
- </dd>
- <dt><code>diff-hunk=</code></dt>
- <dd><a name="index-diff_002dhunk-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for the starts of hunks within generated patches.
- </p>
- </dd>
- <dt><code>diff-delete=</code></dt>
- <dd><a name="index-diff_002ddelete-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for deleted lines within generated patches.
- </p>
- </dd>
- <dt><code>diff-insert=</code></dt>
- <dd><a name="index-diff_002dinsert-GCC_005fCOLORS-capability"></a>
- <p>SGR substring for inserted lines within generated patches.
- </p></dd>
- </dl>
- </dd>
- <dt><code>-fno-diagnostics-show-option</code></dt>
- <dd><a name="index-fno_002ddiagnostics_002dshow_002doption"></a>
- <a name="index-fdiagnostics_002dshow_002doption"></a>
- <p>By default, each diagnostic emitted includes text indicating the
- command-line option that directly controls the diagnostic (if such an
- option is known to the diagnostic machinery). Specifying the
- <samp>-fno-diagnostics-show-option</samp> flag suppresses that behavior.
- </p>
- </dd>
- <dt><code>-fno-diagnostics-show-caret</code></dt>
- <dd><a name="index-fno_002ddiagnostics_002dshow_002dcaret"></a>
- <a name="index-fdiagnostics_002dshow_002dcaret"></a>
- <p>By default, each diagnostic emitted includes the original source line
- and a caret ‘<samp>^</samp>’ indicating the column. This option suppresses this
- information. The source line is truncated to <var>n</var> characters, if
- the <samp>-fmessage-length=n</samp> option is given. When the output is done
- to the terminal, the width is limited to the width given by the
- <code>COLUMNS</code> environment variable or, if not set, to the terminal width.
- </p>
- </dd>
- <dt><code>-fdiagnostics-parseable-fixits</code></dt>
- <dd><a name="index-fdiagnostics_002dparseable_002dfixits"></a>
- <p>Emit fix-it hints in a machine-parseable format, suitable for consumption
- by IDEs. For each fix-it, a line will be printed after the relevant
- diagnostic, starting with the string “fix-it:”. For example:
- </p>
- <div class="smallexample">
- <pre class="smallexample">fix-it:"test.c":{45:3-45:21}:"gtk_widget_show_all"
- </pre></div>
- <p>The location is expressed as a half-open range, expressed as a count of
- bytes, starting at byte 1 for the initial column. In the above example,
- bytes 3 through 20 of line 45 of “test.c” are to be replaced with the
- given string:
- </p>
- <div class="smallexample">
- <pre class="smallexample">00000000011111111112222222222
- 12345678901234567890123456789
- gtk_widget_showall (dlg);
- ^^^^^^^^^^^^^^^^^^
- gtk_widget_show_all
- </pre></div>
- <p>The filename and replacement string escape backslash as “\\", tab as “\t”,
- newline as “\n”, double quotes as “\"”, non-printable characters as octal
- (e.g. vertical tab as “\013”).
- </p>
- <p>An empty replacement string indicates that the given range is to be removed.
- An empty range (e.g. “45:3-45:3”) indicates that the string is to
- be inserted at the given position.
- </p>
- </dd>
- <dt><code>-fdiagnostics-generate-patch</code></dt>
- <dd><a name="index-fdiagnostics_002dgenerate_002dpatch"></a>
- <p>Print fix-it hints to stderr in unified diff format, after any diagnostics
- are printed. For example:
- </p>
- <div class="smallexample">
- <pre class="smallexample">--- test.c
- +++ test.c
- @ -42,5 +42,5 @
- void show_cb(GtkDialog *dlg)
- {
- - gtk_widget_showall(dlg);
- + gtk_widget_show_all(dlg);
- }
- </pre></div>
- <p>The diff may or may not be colorized, following the same rules
- as for diagnostics (see <samp>-fdiagnostics-color</samp>).
- </p>
- </dd>
- <dt><code>-fno-show-column</code></dt>
- <dd><a name="index-fno_002dshow_002dcolumn"></a>
- <p>Do not print column numbers in diagnostics. This may be necessary if
- diagnostics are being scanned by a program that does not understand the
- column numbers, such as <code>dejagnu</code>.
- </p>
- </dd>
- </dl>
- <hr>
- <div class="header">
- <p>
- Next: <a href="Warning-Options.html#Warning-Options" accesskey="n" rel="next">Warning Options</a>, Previous: <a href="Objective_002dC-and-Objective_002dC_002b_002b-Dialect-Options.html#Objective_002dC-and-Objective_002dC_002b_002b-Dialect-Options" accesskey="p" rel="prev">Objective-C and Objective-C++ Dialect Options</a>, Up: <a href="Invoking-GCC.html#Invoking-GCC" accesskey="u" rel="up">Invoking GCC</a> [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Option-Index.html#Option-Index" title="Index" rel="index">Index</a>]</p>
- </div>
- </body>
- </html>
|