maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/clang/docs/CommandGuide/diagtool.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

53 lines
1.1 KiB
ReStructuredText
Raw Normal View History

[diagtool] Add diagtool to install target. Although not very well known, diagtool is an incredibly convenient utility for dealing with diagnostics. Particularly useful are the "tree" and "show-enabled" commands: - The former prints the hierarchy of diagnostic (warning) flags and which of them are enabled by default. - The latter can be used to replace an invocation to clang and will print which diagnostics are disabled, warnings or errors. For instance: `diagtool show-enabled -Wall -Werror /tmp/test.c` will print that -Wunused-variable (warn_unused_variable) will be treated as an error. This patch adds them to the install target so it gets shipped with the LLVM release. It also adds a very basic man page and mentions this change in the release notes. Differential revision: https://reviews.llvm.org/D46694 llvm-svn: 332448
2018-05-16 18:23:25 +08:00
diagtool - clang diagnostics tool
=================================
SYNOPSIS
--------
:program:`diagtool` *command* [*args*]
DESCRIPTION
-----------
[Test Commit] Fix typo in diagtool.rst Test commit after obtaining commit access. llvm-svn: 369148
2019-08-17 04:26:48 +08:00
:program:`diagtool` is a combination of four tools for dealing with diagnostics in :program:`clang`.
[diagtool] Add diagtool to install target. Although not very well known, diagtool is an incredibly convenient utility for dealing with diagnostics. Particularly useful are the "tree" and "show-enabled" commands: - The former prints the hierarchy of diagnostic (warning) flags and which of them are enabled by default. - The latter can be used to replace an invocation to clang and will print which diagnostics are disabled, warnings or errors. For instance: `diagtool show-enabled -Wall -Werror /tmp/test.c` will print that -Wunused-variable (warn_unused_variable) will be treated as an error. This patch adds them to the install target so it gets shipped with the LLVM release. It also adds a very basic man page and mentions this change in the release notes. Differential revision: https://reviews.llvm.org/D46694 llvm-svn: 332448
2018-05-16 18:23:25 +08:00
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*]