Docs: Explain the release build. And also how-to install Cppcheck #8044
Conversation
|
| After you compiled your binary you can run the followning cmake command to install Cppcheck: | ||
|
|
||
| ```shell | ||
| sudo cmake --install build |
There was a problem hiding this comment.
sudo only applies to linux (and mac?)
this is a "rough" installation in my humble opinion. a package should be used.
There was a problem hiding this comment.
This is for installing the compiled source code. That's why it's under compile. Currently you don't explain it.
This is not meant for users who just download and install the package. But again this is part under the Compile section.
There was a problem hiding this comment.
I would think that users also read this readme sometimes. and I fear that some users might think it's officially supported approach to run cmake --install because we talk about it here. Imho a proper installation package should be created instead.
I'd rather discourage that cmake --install is used. I'm not sure if we actively maintain and test at all. @firewave do you have any feeling about how robust it is?
As a developer I want to know how to compile Cppcheck. I feel that it makes sense to tell users/developers how to compile their own copy of cppcheck in this readme.
There was a problem hiding this comment.
I fully understand you. I thought about that already. Hence I start my sentence again repeating it's about compiling: "After you compiled your binary"
| cmake --build build | ||
| ``` | ||
|
|
||
| デフォルトのビルドタイプは `Debug` です。`Release` ビルドが必要な場合は、ビルドフラグ (上記の最初の `cmake` コマンドで) を使用できます。 |
There was a problem hiding this comment.
Well, I'm wondering why you have a japense readme if you don't speak it 🤣? The Japanese readme is very outdated actually.
There was a problem hiding this comment.
I don't know any japanese.
It has been updated now and then by a japanese guy. I don't want to have some auto translations that we don't know if they are proper or not. So the choice should be either to:
- find somebody that really speaks japanese that wants to maintain this
- remove it
@fu7mu4 are you interested to review/update the file?
|
|
||
| For building the tests use the flag. | ||
| -DBUILD_TESTS=ON | ||
| For rules support (requires pcre) use the flag: `-DHAVE_RULES=ON` |
There was a problem hiding this comment.
Maybe we can use this change to explain what rules are and if one should enable it or not.
There was a problem hiding this comment.
for information my idea is to get rid of pcre and use std::regex instead. the pcre library we use is end of life. there is work in progress..
3 participants
Uh oh!
There was an error while loading. Please reload this page.