Skip to content

gh-109408: Add the docs whitespace check from patchcheck to pre-commit #109854

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
hugovk merged 12 commits into from
Oct 10, 2023
+13 −33
Merged

gh-109408: Add the docs whitespace check from patchcheck to pre-commit #109854

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
dff437b
Run pre-commit as part of 'make patchcheck'
hugovk Sep 20, 2023
97c6ccf
Use f-strings
hugovk Sep 20, 2023
029a9a4
Add whitespace
hugovk Sep 20, 2023
d7690a3
Properly pluralise file(s), fix Unix typo
hugovk Sep 20, 2023
5cfcd19
Remove normalize_docs_whitespace from patchcheck, it's covered by pre…
hugovk Sep 20, 2023
1eb8042
Include inc files in pre-commit's trailing-whitespace
hugovk Sep 20, 2023
a85cd1c
Fix string
hugovk Sep 25, 2023
433153d
Use "s" variable for readability
hugovk Sep 25, 2023
a429344
Reinstate docs_modified
hugovk Sep 25, 2023
63c6d17
Reinstate doc_files for docs_modified
hugovk Sep 26, 2023
05a5d35
Revert makefile changes
hugovk Sep 27, 2023
f4b16ec
Merge branch 'main' into patchcheck-docs-whitespace
hugovk Oct 10, 2023
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
Prev Previous commit
Next Next commit
Add whitespace
  • Loading branch information
@hugovk
hugovk committed Sep 25, 2023
commit 029a9a4c16cda106cacd0fc70177880f84469c5f
5 changes: 5 additions & 0 deletions Tools/patchcheck/patchcheck.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,7 @@ def normalize_c_whitespace(file_paths):

ws_re = re.compile(br'\s+(\r?\n)$')


@status("Fixing docs whitespace", info=report_modified_files)
def normalize_docs_whitespace(file_paths):
fixed = []
Expand Down Expand Up @@ -244,6 +245,7 @@ def reported_news(file_paths):
return any(p.startswith(os.path.join('Misc', 'NEWS.d', 'next'))
for p in file_paths)


@status("configure regenerated", modal=True, info=str)
def regenerated_configure(file_paths):
"""Check if configure has been regenerated."""
Expand All @@ -252,6 +254,7 @@ def regenerated_configure(file_paths):
else:
return "not needed"


@status("pyconfig.h.in regenerated", modal=True, info=str)
def regenerated_pyconfig_h_in(file_paths):
"""Check if pyconfig.h.in has been regenerated."""
Expand All @@ -260,6 +263,7 @@ def regenerated_pyconfig_h_in(file_paths):
else:
return "not needed"


def ci(pull_request):
if pull_request == 'false':
print('Not a pull request; skipping')
Expand All @@ -281,6 +285,7 @@ def ci(pull_request):
print('(on UNIX you can run `make patchcheck` to make the fixes)')
sys.exit(1)


def main():
base_branch = get_base_branch()
file_paths = changed_files(base_branch)
Expand Down