summaryrefslogtreecommitdiff
path: root/docs/CommandGuide/diagtool.rst
blob: 656ce10b23319f49e7ff9c34f9b53e522f881aeb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
diagtool - clang diagnostics tool
=================================

SYNOPSIS
--------

:program:`diagtool` *command* [*args*]

DESCRIPTION
-----------

:program:`diagtool` is a combination of four tools for dealing with diagnostics in :program:`clang`.

SUBCOMMANDS
-----------

:program:`diagtool` is separated into several subcommands each tailored to a
different purpose. A brief summary of each command follows, with more detail in
the sections that follow.

  * :ref:`find_diagnostic_id` - Print the id of the given diagnostic.
  * :ref:`list_warnings` - List warnings and their corresponding flags.
  * :ref:`show_enabled` - Show which warnings are enabled for a given command line.
  * :ref:`tree` - Show warning flags in a tree view.

.. _find_diagnostic_id:

find-diagnostic-id
~~~~~~~~~~~~~~~~~~

:program:`diagtool` find-diagnostic-id *diagnostic-name*

.. _list_warnings:

list-warnings
~~~~~~~~~~~~~

:program:`diagtool` list-warnings

.. _show_enabled:

show-enabled
~~~~~~~~~~~~

:program:`diagtool` show-enabled [*options*] *filename ...*

.. _tree:

tree
~~~~

:program:`diagtool` tree [*diagnostic-group*]