Skip to content

Fix format, rendering, typos, syntax in the readme #8461

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

Open
vkucera wants to merge 1 commit into
base: main
Choose a base branch
from
+53 −52
Open

Fix format, rendering, typos, syntax in the readme #8461

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
105 changes: 53 additions & 52 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# **Cppcheck**
# **Cppcheck**

|release-windows|OSS-Fuzz|Coverity Scan Build Status|include-what-you-use|License|
|:--:|:--:|:--:|:--:|:--:|
|[![release-windows](https://github.com/danmar/cppcheck/actions/workflows/release-windows.yml/badge.svg?branch=main)](https://github.com/danmar/cppcheck/actions/workflows/release-windows.yml)|[![OSS-Fuzz](https://oss-fuzz-build-logs.storage.googleapis.com/badges/cppcheck.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:cppcheck)|[![Coverity Scan Build Status](https://img.shields.io/coverity/scan/512.svg)](https://scan.coverity.com/projects/512)|[![include-what-you-use](https://github.com/danmar/cppcheck/actions/workflows/iwyu.yml/badge.svg?branch=main)](https://github.com/danmar/cppcheck/actions/workflows/iwyu.yml)|[![License](https://img.shields.io/badge/license-GPL3.0-blue.svg)](https://opensource.org/licenses/GPL-3.0)

|[![release-windows](https://github.com/danmar/cppcheck/actions/workflows/release-windows.yml/badge.svg?branch=main)](https://github.com/danmar/cppcheck/actions/workflows/release-windows.yml)|[![OSS-Fuzz](https://oss-fuzz-build-logs.storage.googleapis.com/badges/cppcheck.svg)](https://bugs.chromium.org/p/oss-fuzz/issues/list?sort=-opened&can=1&q=proj:cppcheck)|[![Coverity Scan Build Status](https://img.shields.io/coverity/scan/512.svg)](https://scan.coverity.com/projects/512)|[![include-what-you-use](https://github.com/danmar/cppcheck/actions/workflows/iwyu.yml/badge.svg?branch=main)](https://github.com/danmar/cppcheck/actions/workflows/iwyu.yml)|[![License](https://img.shields.io/badge/license-GPL3.0-blue.svg)](https://opensource.org/licenses/GPL-3.0)|

## About the name

Expand All @@ -21,7 +20,8 @@ Cppcheck is a hobby project with limited resources. You can help us by donating

1. Download (and extract) Cppcheck source code.
2. Run (Linux/MacOS example):
```

```shell
cd cppcheck/
python3 -m venv .venv
source .venv/bin/activate
Expand All @@ -30,9 +30,9 @@ Cppcheck is a hobby project with limited resources. You can help us by donating
./tools/donate-cpu.py
```

The script will analyse debian source code and upload the results to a cppcheck server. We need these results both to improve Cppcheck and to detect regressions.
The script will analyse Debian source code and upload the results to a Cppcheck server. We need these results both to improve Cppcheck and to detect regressions.

You can stop the script whenever you like with Ctrl C.
You can stop the script whenever you like with Ctrl+C.

## Compiling

Expand All @@ -43,6 +43,7 @@ To build the GUI application, you need to use the CMake build system.
When building the command line tool, [PCRE](http://www.pcre.org/) is optional. It is used if you build with rules.

There are multiple compilation choices:

* CMake - cross platform build tool
* (Windows) Visual Studio
* (Windows) Qt Creator + MinGW
Expand All @@ -62,22 +63,22 @@ cmake --build build
```

If you want to compile the GUI you can use the flag.
-DBUILD_GUI=ON
`-DBUILD_GUI=ON`

For rules support (requires pcre) use the flag.
-DHAVE_RULES=ON
`-DHAVE_RULES=ON`

For release builds it is recommended that you use:
-DUSE_MATCHCOMPILER=ON
`-DUSE_MATCHCOMPILER=ON`

For building the tests use the flag.
-DBUILD_TESTING=ON
`-DBUILD_TESTING=ON`

Using cmake you can generate project files for Visual Studio,XCode,etc.
Using CMake you can generate project files for Visual Studio, XCode, etc.

#### Building a specific configuration

For single-configuration generators (like "Unix Makefiles") you can generate and build a specific configuration (e.g. "RelWithDebInfo") using:
For single-configuration generators (like "Unix Makefiles") you can generate and build a specific configuration (e.g. "`RelWithDebInfo`") using:

```shell
cmake -S . -B build_RelWithDebInfo -DCMAKE_BUILD_TYPE=RelWithDebInfo ..
Expand All @@ -93,24 +94,24 @@ cmake --build build --config RelWithDebInfo

### Visual Studio

Use the cppcheck.sln file. The file is configured for Visual Studio 2019, but the platform toolset can be changed easily to older or newer versions. The solution contains platform targets for both x86 and x64.
Use the `cppcheck.sln` file. The file is configured for Visual Studio 2019, but the platform toolset can be changed easily to older or newer versions. The solution contains platform targets for both x86 and x64.

To compile with rules, select "Release-PCRE" or "Debug-PCRE" configuration. pcre.lib (pcre64.lib for x64 builds) and pcre.h are expected to be in /externals then. A current version of PCRE for Visual Studio can be obtained using [vcpkg](https://github.com/microsoft/vcpkg).
To compile with rules, select "`Release-PCRE`" or "`Debug-PCRE`" configuration. `pcre.lib` (`pcre64.lib` for x64 builds) and `pcre.h` are expected to be in `/externals` then. A current version of PCRE for Visual Studio can be obtained using [vcpkg](https://github.com/microsoft/vcpkg).

### Visual Studio (from command line)

If you do not wish to use the Visual Studio IDE, you can compile cppcheck from the command line the following command.
If you do not wish to use the Visual Studio IDE, you can compile Cppcheck from the command line the following command.

```shell
msbuild cppcheck.sln
```

### VS Code (on Windows)

Install MSYS2 to get GNU toolchain with g++ and gdb (https://www.msys2.org/).
Create a settings.json file in the .vscode folder with the following content (adjust path as necessary):
Install MSYS2 to get GNU toolchain with g++ and gdb (<https://www.msys2.org/>).
Create a `settings.json` file in the `.vscode` folder with the following content (adjust path as necessary):

```
```json
{
"terminal.integrated.shell.windows": "C:\\msys64\\usr\\bin\\bash.exe",
"terminal.integrated.shellArgs.windows": [
Expand All @@ -123,11 +124,11 @@ Create a settings.json file in the .vscode folder with the following content (ad
}
```

Run "make" in the terminal to build cppcheck.
Run `make` in the terminal to build Cppcheck.

For debugging create a launch.json file in the .vscode folder with the following content, which covers configuration for debugging cppcheck and misra.py:
For debugging create a `launch.json` file in the `.vscode` folder with the following content, which covers configuration for debugging Cppcheck and `misra.py`:

```
```json
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
Expand Down Expand Up @@ -174,7 +175,7 @@ For debugging create a launch.json file in the .vscode folder with the following
### Qt Creator + MinGW

The PCRE dll is needed to build the CLI. It can be downloaded here:
http://software-download.name/pcre-library-windows/
<http://software-download.name/pcre-library-windows/>

### GNU compilers

Expand Down Expand Up @@ -204,22 +205,22 @@ g++ -o cppcheck -std=c++11 -Iexternals -Iexternals/simplecpp -Iexternals/tinyxml

#### Flags

- `MATCHCOMPILER=yes`
* `MATCHCOMPILER=yes`
Several `Token` matching patterns are converted into more efficient C++ code at compile time (requires Python to be installed).

- `FILESDIR=/usr/share/cppcheck`
Specifies the folder where cppcheck files (addons, cfg, platform) are installed to.
* `FILESDIR=/usr/share/cppcheck`
Specifies the folder where Cppcheck files (addons, cfg, platform) are installed to.

- `HAVE_RULES=yes`
* `HAVE_RULES=yes`
Enables rules (requires PCRE to be installed).

- `CXXOPTS="-O2"`
* `CXXOPTS="-O2"`
Enables most compiler optimizations.

- `CPPOPTS="-DNDEBUG"`
* `CPPOPTS="-DNDEBUG"`
Disables assertions.

- `HAVE_BOOST=yes`
* `HAVE_BOOST=yes`
Enables usage of more efficient container from Boost (requires Boost to be installed).

### MinGW
Expand All @@ -230,18 +231,18 @@ mingw32-make

If you encounter the following error with `MATCHCOMPILER=yes` you need to specify your Python interpreter via `PYTHON_INTERPRETER`.

```
```text
process_begin: CreateProcess(NULL, which python3, ...) failed.
makefile:24: pipe: No error
process_begin: CreateProcess(NULL, which python, ...) failed.
makefile:27: pipe: No error
makefile:30: *** Did not find a Python interpreter. Stop.
```

### Other Compiler/IDE
### Other compiler/IDE

1. Create an empty project file / makefile.
2. Add all cpp files in the cppcheck cli and lib folders to the project file / makefile.
2. Add all cpp files in the Cppcheck cli and lib folders to the project file / makefile.
3. Add all cpp files in the externals folders to the project file / makefile.
4. Compile.

Expand All @@ -255,41 +256,41 @@ mv cppcheck cppcheck.exe

## Packages

Besides building yourself on the platform of your choice there are also several ways to obtain pre-built packages.<br/>
Besides building yourself on the platform of your choice there are also several ways to obtain pre-built packages.

### Official

Official packages are maintained by the Cppcheck team.

- (Windows) An official Windows installer is available via the official Cppcheck SourceForge page: https://cppcheck.sourceforge.io.
- (Windows) Official builds of the current development versions are available via the [release-windows](https://github.com/danmar/cppcheck/actions/workflows/release-windows.yml) workflow. They are built nightly for the `main` branch and for each commit for release branches. As these are development versions please refrain from using these in production environments!
- A portable package (i.e. does not require installation) is available as the `portable` artifact. This is still a work-in-progress - see https://trac.cppcheck.net/ticket/10771 for details.
- An installer is available via the `installer` artifact.
- (Multi-Platform) A premium version with additional features provided by the original author of Cppcheck is available for purchase via https://www.cppcheck.com.
* (Windows) An official Windows installer is available via the official Cppcheck SourceForge page: <https://cppcheck.sourceforge.io>.
* (Windows) Official builds of the current development versions are available via the [release-windows](https://github.com/danmar/cppcheck/actions/workflows/release-windows.yml) workflow. They are built nightly for the `main` branch and for each commit for release branches. As these are development versions please refrain from using these in production environments!
* A portable package (i.e. does not require installation) is available as the `portable` artifact. This is still a work-in-progress - see <https://trac.cppcheck.net/ticket/10771> for details.
* An installer is available via the `installer` artifact.
* (Multi-Platform) A premium version with additional features provided by the original author of Cppcheck is available for purchase via <https://www.cppcheck.com>.

### Third-party

Third-party packages are ***not*** maintained by the Cppcheck team but their respective packagers.

*Note:* The following list is purely informational and listed in no particular order.

*Note:* Please always try to obtain the package from the primary official source of your operating system/distro first and make sure you are getting the latest released/tagged version (see https://github.com/danmar/cppcheck/tags). Some packages might not carry the latest patch version though.
*Note:* Please always try to obtain the package from the primary official source of your operating system/distro first and make sure you are getting the latest released/tagged version (see <https://github.com/danmar/cppcheck/tags>). Some packages might not carry the latest patch version though.

*Note:* Some issues might be related to additional patches carried by the builds in these packages or by the packaging itself. Please try to verify the issue with an official build before reporting it upstream. Otherwise you might need toreport it to the respective maintainer of the package.

- (Windows / Outdated) A portable package is available via https://portableapps.com/apps/development/cppcheck-portable.
- (Windows / Outdated) A package is available via https://community.chocolatey.org/packages/cppcheck.
- (Windows / Outdated) A package is available via https://winget.run/pkg/Cppcheck/Cppcheck.
- (Windows) A package is available via https://scoop.sh/#/apps?q=cppcheck.
- (Linux/Unix) Many major distros offer Cppcheck packages via their integrated package managers (`yum`, `apt`, `pacman`, etc.). See https://pkgs.org/search/?q=cppcheck or https://repology.org/project/cppcheck for an overview.
- (Linux/Unix) Unless you are using a "rolling" distro, it is likely that they are not carrying the latest version. There are several external (mainly unsupported) repositories like AUR (ArchLinux), PPA (ubuntu), EPEL (CentOS/Fedora) etc. which might provide up-to-date packages.
- (Linux/Unix / Outdated) The Canonical Snapcraft packages (https://snapcraft.io/cppcheck / https://snapcraft.io/cppcheckgui) are unmaintained and contain very old (development) versions. Please refrain from using them! See https://trac.cppcheck.net/ticket/11641 for more details.
- (MacOS) A package is available via Homebrew (`brew`). See https://formulae.brew.sh/formula/cppcheck.
- (MacOS) A package is available via https://ports.macports.org/port/cppcheck.
- (Multi-Platform) A package is available via https://anaconda.org/conda-forge/cppcheck.
- (Multi-Platform) A package is available via https://conan.io/center/recipes/cppcheck.
- Packages are also available from various download portals (mainly the Windows installer - sometimes re-packaged).
* (Windows / Outdated) A portable package is available via <https://portableapps.com/apps/development/cppcheck-portable>.
* (Windows / Outdated) A package is available via <https://community.chocolatey.org/packages/cppcheck>.
* (Windows / Outdated) A package is available via <https://winget.run/pkg/Cppcheck/Cppcheck>.
* (Windows) A package is available via <https://scoop.sh/#/apps?q=cppcheck>.
* (Linux/Unix) Many major distros offer Cppcheck packages via their integrated package managers (`yum`, `apt`, `pacman`, etc.). See <https://pkgs.org/search/?q=cppcheck> or <https://repology.org/project/cppcheck> for an overview.
* (Linux/Unix) Unless you are using a "rolling" distro, it is likely that they are not carrying the latest version. There are several external (mainly unsupported) repositories like AUR (ArchLinux), PPA (Ubuntu), EPEL (CentOS/Fedora) etc. which might provide up-to-date packages.
* (Linux/Unix / Outdated) The Canonical Snapcraft packages (<https://snapcraft.io/cppcheck> / <https://snapcraft.io/cppcheckgui>) are unmaintained and contain very old (development) versions. Please refrain from using them! See <https://trac.cppcheck.net/ticket/11641> for more details.
* (MacOS) A package is available via Homebrew (`brew`). See <https://formulae.brew.sh/formula/cppcheck>.
* (MacOS) A package is available via <https://ports.macports.org/port/cppcheck>.
* (Multi-Platform) A package is available via <https://anaconda.org/conda-forge/cppcheck>.
* (Multi-Platform) A package is available via <https://conan.io/center/recipes/cppcheck>.
* Packages are also available from various download portals (mainly the Windows installer - sometimes re-packaged).

## Webpage

https://cppcheck.sourceforge.io/
<https://cppcheck.sourceforge.io/>