Skip to content

doc: Contributing tools/checkpatch.sh example update.#18758

Merged
acassis merged 1 commit into
apache:masterfrom
cederom:cederom-20260418-docs-contributing-checkpatch-update
Apr 18, 2026
Merged

doc: Contributing tools/checkpatch.sh example update.#18758
acassis merged 1 commit into
apache:masterfrom
cederom:cederom-20260418-docs-contributing-checkpatch-update

Conversation

@cederom
Copy link
Copy Markdown
Contributor

@cederom cederom commented Apr 18, 2026

Summary

  • Add ./tools/checkpatch.sh -c -u -m -g HEAD~...HEAD example to match checks performed by our CI.
  • Add cross-reference to checkpatch.sh documentation.

Impact

  • Documentation: adds more broad example of checkpatch verification before PR is submitted to match parameters used by our CI (including codespell and encoding).

Testing

% uname -a
FreeBSD hexagon 14.4-RELEASE-p1 FreeBSD 14.4-RELEASE-p1 GENERIC amd64

% cd Documentation
% pipenv shell
(Documentation) hexagon% gmake html
Removing everything under '_build'...
Running Sphinx v6.2.1
myst v3.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions=set(), disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
Tags updated
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 1567 source files that are out of date
updating environment: [new config] 1567 added, 0 changed, 0 removed
reading sources... 
(..)
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output...
(..)
copying downloadable files...
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in _build/html.
shot-2026-04-18_15-29-51

@github-actions github-actions Bot added Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small labels Apr 18, 2026
hartmannathan
hartmannathan previously approved these changes Apr 18, 2026
Copy link
Copy Markdown
Contributor

@hartmannathan hartmannathan left a comment

Choose a reason for hiding this comment

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

Thanks for improving docs!

Comment thread Documentation/contributing/coding_style.rst Outdated
* Add `./tools/checkpatch.sh -c -u -m -g HEAD~...HEAD` example
  to match checks performed by our CI.
* Add cross-reference to checkpatch.sh documentation.

Signed-off-by: Tomasz 'CeDeROM' CEDRO <tomek@cedro.info>
@cederom cederom dismissed stale reviews from hartmannathan and xiaoxiang781216 via c52a773 April 18, 2026 13:29
@cederom cederom force-pushed the cederom-20260418-docs-contributing-checkpatch-update branch from 693d111 to c52a773 Compare April 18, 2026 13:29
Copy link
Copy Markdown
Contributor

@hartmannathan hartmannathan left a comment

Choose a reason for hiding this comment

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

Looks great. Thank you!

@acassis acassis merged commit 8653569 into apache:master Apr 18, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Area: Documentation Improvements or additions to documentation Size: S The size of the change in this PR is small

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants