forked from microsoft/clang
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[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 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@332448 91177308-0d34-0410-b5e6-96231b3b80d8
- Loading branch information
1 parent
5a50603
commit ad35972
Showing
4 changed files
with
70 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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*] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -15,3 +15,4 @@ Basic Commands | |
:maxdepth: 1 | ||
|
||
clang | ||
diagtool |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters