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.

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

Jump to bottom

Remove coverity from the DevGuide #1411

Merged
merged 4 commits into from
Sep 24, 2024
Merged

Remove coverity from the DevGuide #1411

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8c37c7b
Remove coverity
Mariatta Sep 24, 2024
bf2a5c1
Update conf.py
Mariatta Sep 24, 2024
d15952c
Link to valgrind doc on CPython repo.
Mariatta Sep 24, 2024
08912be
Update development-tools/clang.rst
Mariatta Sep 24, 2024
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: 0 additions & 2 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,11 +114,9 @@
rediraffe_redirects = {
# Development Tools
"clang.rst": "development-tools/clang.rst",
"coverity.rst": "development-tools/coverity.rst",
"gdb.rst": "development-tools/gdb.rst",
# Advanced Tools was renamed Development Tools in gh-1149
"advanced-tools/clang.rst": "development-tools/clang.rst",
"advanced-tools/coverity.rst": "development-tools/coverity.rst",
"advanced-tools/gdb.rst": "development-tools/gdb.rst",
# Core Developers
"coredev.rst": "core-developers/become-core-developer.rst",
Expand Down
1 change: 0 additions & 1 deletion core-developers/experts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,6 @@ buildbots zware, pablogsal
bytecode benjaminp, 1st1, markshannon, brandtbucher, carljm, iritkatriel
context managers ncoghlan
core workflow Mariatta, ezio-melotti, hugovk, AA-Turner
coverity scan tiran, Yhg1s
cryptography gpshead, dstufft
data formats
database malemburg
Expand Down
2 changes: 1 addition & 1 deletion development-tools/clang.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 •
edited
Loading

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

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.

etc.

Clang/LLVM setup
Expand Down
141 changes: 0 additions & 141 deletions development-tools/coverity.rst
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion development-tools/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,4 @@ Development tools
clinic
gdb
clang
coverity
warnings
Loading