Skip to content
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.

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

Remove coverity from the DevGuide #1411

Merged
merged 4 commits into from
Sep 24, 2024
Merged

Conversation

Mariatta
Copy link
Member

@Mariatta Mariatta commented Sep 24, 2024

The CPython Coverity Scan hasn't been updated since 2020.
People listed as admins and experts of coverity scan are no longer administering/maintaining it.

On Discord, it was decided to drop this from CPython core workflow.

Closes #1410


📚 Documentation preview 📚: https://cpython-devguide--1411.org.readthedocs.build/

@@ -54,7 +54,7 @@ A complete list of sanitizers can be found at `Controlling Code Generation

Clang and its sanitizers have strengths (and weaknesses). Its just one tool in
the war chest to uncovering bugs and improving code quality. Clang should be
used to complement other methods, including Code Reviews, Valgrind, Coverity,
used to complement other methods, including Code Reviews, Valgrind,
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Question, do we have more info about "Valgrind"? It was mentioned only once on the entire devguide.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How to use valgrind? What is it for?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Valgrind is a tool for finding C-level memory issues, like memory leaks or writes to uninitialized memory.

Copy link
Member

@encukou encukou Sep 24, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Interesting, we also have a https://github.com/python/cpython/blob/main/Misc/README.coverity that perhaps should be cleaned up from the repo.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I found references to coverity on the CPython repo. In addition to README.coverity,
also Misc\coverity_model.c

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's documented here: https://github.com/python/cpython/blob/main/Misc/README.valgrind

I updated to link to that doc. Thanks.

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@Mariatta
Copy link
Member Author

Related CPython PR: python/cpython#124460

@Mariatta Mariatta merged commit 0095748 into python:main Sep 24, 2024
4 checks passed
@Mariatta Mariatta deleted the remove-coverity branch September 24, 2024 20:14
@Mariatta
Copy link
Member Author

Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Drop the info about Coverity Scans
3 participants