Skip to content

Commit b40ef6d

Browse files
authored
Merge pull request #4526 from NagyDonat/ad-hoc-docs-cleanup
[fix] dead links, typos etc. in the documentation
2 parents 12c0c04 + 4b2c5b2 commit b40ef6d

File tree

3 files changed

+24
-20
lines changed

3 files changed

+24
-20
lines changed

docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ macOS (OS X) development environment.
3232

3333
![Web interface showing list of analysed projects and bugs](images/demo.gif)
3434

35-
**:bulb: Check out our [DEMO](https://codechecker-demo.eastus.cloudapp.azure.com) showing some analysis results of open-source projects!**
35+
**Check out our [DEMO](https://codechecker-demo.eastus.cloudapp.azure.com) showing some analysis results of open-source projects!**
3636

3737
# Main features
3838
## Command line C/C++ Analysis
@@ -423,4 +423,4 @@ you should be greeted with a web application showing you the analysis results.
423423
* A high-level overview about the infrastructure is available amongst the
424424
[2015 Euro LLVM Conference](http://llvm.org/devmtg/2015-04) presentations.<br/>
425425
**Krupp, Dániel and Orbán, György and Horváth, Gábor and Babati, Bence**:<br/>
426-
[_Industrial Experiences with the Clang Static Analysis Toolset_](http://llvm.org/devmtg/2015-04/slides/Clang_static_analysis_toolset_final.pdf)
426+
[_Industrial Experiences with the Clang Static Analysis Toolset_](http://llvm.org/devmtg/2015-04/slides/Clang_static_analysis_toolset_final.pdf)

docs/analyzer/checker_and_analyzer_configuration.md

+20-16
Original file line numberDiff line numberDiff line change
@@ -12,29 +12,32 @@ Listing the available configuration options:
1212
Setting analyzer configuration options:
1313
`CodeChecker analyze --analyzer-config <key=value>`
1414

15-
You can find a comprehensive list of analyzer configuration options at the
16-
[clang static analyzer
17-
documentation](https://github.com/llvm-mirror/clang/tree/master/docs) pages.
15+
The descriptions of these global analyzer options are also available on the
16+
[Configuring the
17+
Analyzer](https://clang.llvm.org/docs/analyzer/user-docs/Options.html) page of
18+
the Clang Static Analyzer Documentation.
1819

1920
## Checker Configuration <a name="checker-configuration"></a>
2021

21-
Clang Static Analyzer checkers can be enabled and disabled using the
22-
`CodeChekcer analyze --enable <checker_name> --disable <checker_name>` flags.
23-
You can list/enable/disable all checkers for Clang Static Analyzer, except for
24-
the developer (debug and modeling) checkers.
22+
Clang Static Analyzer checkers can be enabled and disabled with the flags
23+
`CodeChecker analyze --enable <checker_name> --disable <checker_name>`. The
24+
checkers can be listed with `CodeChecker checkers --analyzers clangsa` and
25+
their full documentation can be found at the [Available
26+
Checkers](https://clang.llvm.org/docs/analyzer/checkers.html) page.
2527

26-
Some checkers can be customized using checker specific configuration options.
28+
Note that these high-level CodeChecker operations hide some internal (debug or
29+
modeling) checkers that are only relevant for the developers of the Clang
30+
Static Analyzer.
2731

28-
These can be listed using the `CodeChecker checkers --checker-config` command
29-
and can be set by `CodeChecker analyze --checker-config
30-
clangsa:<option-name>=<value>`.
31-
32-
You can find the documentation of the configuration options at the [Clang Static
33-
Analyzer
34-
checkers](https://github.com/llvm-mirror/clang/tree/master/lib/StaticAnalyzer/Checkers)
35-
page.
32+
Some checkers can be customized using checker specific configuration options,
33+
which can be set by `CodeChecker analyze --checker-config
34+
clangsa:<option-name>=<value>`. These options are documented on the [Available
35+
Checkers](https://clang.llvm.org/docs/analyzer/checkers.html) page (within the
36+
description of the corresponding checker) and they can be listed with the command
37+
`CodeChecker checkers --checker-config`.
3638

3739
## Clang Static Analyzer Special Configuration Options
40+
3841
In special cases, when the checker and analyzer configurability that is provided
3942
by CodeChecker is not enough, the Clang Static analyzer configuration can be
4043
extended through the `--saargs` analysis option. The content of the saargs file
@@ -58,6 +61,7 @@ maximum number of times the analyzer will go through a loop, the default
5861
value is 4).
5962

6063
### Enabling developer checkers
64+
6165
You cannot enable/disable developer checkers in CodeChecker using the `--enable`
6266
or `--disable` flags.
6367

docs/usage.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ it will contain much information about this.
118118
[user guide](analyzer/user_guide.md#log).
119119
* MacOS users need `intercept-build` to be available on the system,
120120
and in most cases, _System Integrity Protection_ needs to be turned off.
121-
See the [README](/README.md#mac-os-x) for details.
121+
See the [README](README.md#mac-os-x) for details.
122122

123123
## Step 2: Analyze your code
124124
Once the build is logged successfully and the `compile_commands.json` was
@@ -1080,4 +1080,4 @@ report directory but suppressed via GUI.
10801080
CodeChecker cmd diff -b baseline_run -n newcheck_reports --unresolved
10811081
report1 # Still in new-check.
10821082
# report7 not shown.
1083-
```
1083+
```

0 commit comments

Comments
 (0)