Skip to content

Fix issues in documentation #4542

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 28, 2025
Merged

Fix issues in documentation #4542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ For this reason, you need to use `codechecker` command instead of `CodeChecker`
everywhere. For a full list of available commands in the _codechecker_ snap
package, run `snap info codechecker`.

## Linux
## Linux: Build from source

For a detailed dependency list, and for instructions on how to install newer
Clang and Clang-Tidy versions, please see [Requirements](deps.md).
Expand Down
9 changes: 4 additions & 5 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,8 @@ CodeChecker store \
```

### Definition of "run"
A run, in the simplest case is a single analysis snapshot of your software.

A "run" is a single execution of an analysis on a given version of the software. A run can contain the result of multiple analyzers (e.g. clang-tidy, clang static analyzer, cppcheck, etc.).

You can follow up the quality status of your product by storing the analysis
results of consecutive git commits of a git branch into the same run. In this
Expand Down Expand Up @@ -561,8 +562,7 @@ the suppression will be stored in a database that is unrelated to the source
code.

It is also possible to suppress multiple reports located in a specific folder
or reported by a given checker. For further details see
(this guide)[analyzer/user_guide.md#setting-with-config-file].
or reported by a given checker. For further details see [this guide](analyzer/user_guide.md#setting-with-config-file).

### Ignore modules from your analysis
You can ignore analysis results for certain files for example 3rd party
Expand All @@ -576,15 +576,14 @@ modules. For that use the `--ignore` parameter of the analyze command:
For the skip file format see the [user guide](analyzer/user_guide.md#skip).

```sh
CodeChecker analyze --build "make" --ignore ./skip.file" --output ./reports
CodeChecker analyze --build "make" --ignore ./skip.file --output ./reports
```

### Enable/Disable Checkers
You can list the checkers using the following command
```sh
CodeChecker checkers --details
```
those marked with (+) are enabled by default.

Every supported checker is reported by the `checkers` command and all of its
subcommands.
Expand Down
2 changes: 2 additions & 0 deletions docs/web/authentication.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,8 @@ option of `CodeChecker server` command.

## <i>Dictionary</i> authentication <a name="dictionary-authentication"></a>

> *Note*: Storing passwords in a plain text file is *strongly discouraged* due to security risks. If no other option is available, ensure that the file permissions are restricted to 0600 to limit access *only* to the file owner.

The `authentication.method_dictionary` contains a plaintext `username:password`
credentials for authentication. If the user's login matches any of the
credentials listed, the user will be authenticated.
Expand Down