Skip to content

Commit e191d14

Browse files
committed
use consistent spelling of 'the static analyzer'
1 parent c3b4558 commit e191d14

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

clang/docs/analyzer/user-docs/CommandLineUsage.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Command Line Usage: scan-build and CodeChecker
22
==============================================
33

4-
This document provides guidelines for running Clang Static Analyzer from the command line on whole projects.
4+
This document provides guidelines for running the static analyzer from the command line on whole projects.
55
CodeChecker and scan-build are two CLI tools for using CSA on multiple files (tranlation units).
66
Both provide a way of driving the analyzer, detecting compilation flags, and generating reports.
77
CodeChecker is more actively maintained, provides heuristics for working with multiple versions of popular compilers and it also comes with a web-based GUI for viewing, filtering, categorizing and suppressing the results.
@@ -10,9 +10,9 @@ Therefore CodeChecker is recommended in case you need any of the above features
1010
Comparison of CodeChecker and scan-build
1111
----------------------------------------
1212

13-
Static Analyzer is by design a GUI tool originally intended to be consumed by the XCode IDE.
13+
The static analyzer is by design a GUI tool originally intended to be consumed by the XCode IDE.
1414
Its purpose is to find buggy execution paths in the program, and such paths are very hard to comprehend by looking at a non-interactive standard output.
15-
It is possible, however, to invoke the Static Analyzer from the command line in order to obtain analysis results, and then later view them interactively in a graphical interface.
15+
It is possible, however, to invoke the static analyzer from the command line in order to obtain analysis results, and then later view them interactively in a graphical interface.
1616
The following tools are used commonly to run the analyzer from the command line.
1717
Both tools are wrapper scripts to drive the analysis and the underlying invocations of the Clang compiler:
1818

@@ -21,8 +21,8 @@ Both tools are wrapper scripts to drive the analysis and the underlying invocati
2121
- Works on all major platforms (Windows, Linux, macOS) and is available as a package in many Linux distributions.
2222
- Does not include support for cross-translation-unit analysis.
2323

24-
2. CodeChecker_ is a driver and web server that runs the Static Analyzer on your projects on demand and maintains a database of issues.
25-
- Perfect for managing large amounts of Static Analyzer warnings in a collaborative environment.
24+
2. CodeChecker_ is a driver and web server that runs the static analyzer on your projects on demand and maintains a database of issues.
25+
- Perfect for managing large amounts of thee static analyzer warnings in a collaborative environment.
2626
- Generally much more feature-rich than scan-build.
2727
- Supports incremental analysis: Results can be stored in a database, subsequent analysis runs can be compared to list the newly added defects.
2828
- :doc:`CrossTranslationUnit` is supported fully on Linux via CodeChecker.
@@ -162,7 +162,7 @@ Conceptually Xcode projects for iPhone applications are nearly the same as their
162162
Recommendation: use "Build and Analyze"
163163
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
164164

165-
The absolute easiest way to analyze iPhone projects is to use the `Analyze feature in Xcode <https://developer.apple.com/library/ios/recipes/xcode_help-source_editor/chapters/Analyze.html#//apple_ref/doc/uid/TP40009975-CH4-SW1>`_ (which is based on the Clang Static Analyzer). There a user can analyze their project right from a menu without most of the setup described later.
165+
The absolute easiest way to analyze iPhone projects is to use the `Analyze feature in Xcode <https://developer.apple.com/library/ios/recipes/xcode_help-source_editor/chapters/Analyze.html#//apple_ref/doc/uid/TP40009975-CH4-SW1>`_ (which is based on the static analyzer). There a user can analyze their project right from a menu without most of the setup described later.
166166

167167
`Instructions are available <../xcode.html>`_ on this website on how to use open source builds of the analyzer as a replacement for the one bundled with Xcode.
168168

clang/docs/analyzer/user-docs/Installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This page describes how to download and install the analyzer. Once the analyzer
1010
Building the Analyzer from Source
1111
---------------------------------
1212

13-
Currently there are no officially supported binary distributions for Clang Static Analyzer.
13+
Currently there are no officially supported binary distributions for the static analyzer.
1414
You must build Clang and LLVM manually.
1515
To do so, please follow the instructions for `building Clang from source code <https://clang.llvm.org/get_started.html#build>`_.
1616

clang/docs/analyzer/user-docs/UsingWithXCode.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Running the analyzer within Xcode
44
.. contents::
55
:local:
66

7-
Since Xcode 3.2, users have been able to run the Clang Static Analyzer `directly within Xcode <https://developer.apple.com/library/ios/recipes/xcode_help-source_editor/chapters/Analyze.html#//apple_ref/doc/uid/TP40009975-CH4-SW1>`_.
7+
Since Xcode 3.2, users have been able to run the static analyzer `directly within Xcode <https://developer.apple.com/library/ios/recipes/xcode_help-source_editor/chapters/Analyze.html#//apple_ref/doc/uid/TP40009975-CH4-SW1>`_.
88

99
It integrates directly with the Xcode build system and presents analysis results directly within Xcode's editor.
1010

0 commit comments

Comments
 (0)