diff options
author | Jonas Devlieghere <jonas@devlieghere.com> | 2018-05-16 10:23:25 +0000 |
---|---|---|
committer | Jonas Devlieghere <jonas@devlieghere.com> | 2018-05-16 10:23:25 +0000 |
commit | b48447a1d603a6609b9d6735fda6f875266237c8 (patch) | |
tree | c40c30fb49137b764613b733d0c6e526dd56c1fa /clang/docs/CommandGuide/diagtool.rst | |
parent | 45ccdd178504809201a68057105b8ebbc8aa7568 (diff) | |
download | bcm5719-llvm-b48447a1d603a6609b9d6735fda6f875266237c8.tar.gz bcm5719-llvm-b48447a1d603a6609b9d6735fda6f875266237c8.zip |
[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
Diffstat (limited to 'clang/docs/CommandGuide/diagtool.rst')
-rw-r--r-- | clang/docs/CommandGuide/diagtool.rst | 52 |
1 files changed, 52 insertions, 0 deletions
diff --git a/clang/docs/CommandGuide/diagtool.rst b/clang/docs/CommandGuide/diagtool.rst new file mode 100644 index 00000000000..59417f71f69 --- /dev/null +++ b/clang/docs/CommandGuide/diagtool.rst @@ -0,0 +1,52 @@ +diagtool - clang diagnostics tool +================================= + +SYNOPSIS +-------- + +:program:`diagtool` *command* [*args*] + +DESCRIPTION +----------- + +:program:`diagtool` is a combination of four tool 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*] |