drm-rust Committer Guidelines

This document describes the detailed merge criteria and committer guidelines for drm-rust. The same criteria and guidelines apply equally to both committers and maintainers.

Where Do I Apply My Patch?

Consult this handy flowchart to determine the best branch for your patch. If in doubt, ask a maintainer on IRC or Zulip.

digraph { next_0[shape=box, style=rounded, color=blue, label="drm-rust-next"]; wait[shape=box, style=rounded, color=blue, label="Wait for -rc1 to release."]; next_1[shape=box, style=rounded, color=blue, label="drm-rust-next"]; fixes_0[shape=box, style=rounded, color=blue, label="drm-rust-fixes"]; is_fix[shape=diamond, color=red, label="Is this a bug fix?"]; in_origin[shape=diamond, color=red, label="Is the bug in the current -rc?"]; is_late[shape=diamond, color=red, label="Is DRM in feature freeze?\n(occurs after -rc6)"]; is_fix -> is_late[label="no"]; is_fix -> in_origin[label="yes"]; is_late -> next_0[label="no"] is_late -> wait[label="yes"] in_origin -> next_1[label="no"]; in_origin -> fixes_0[label="yes"] }

Please also see the branch description and timeline in drm-rust.

General

The same guidelines as described in drm-misc Committer Guidelines do apply.

Submit Checklist

For the full submit checklist, please see Linux Kernel - Submit Checklist and Rust for Linux - Submit Checklist Addendum.

Without constraining the above, the following list provides the most important checks to run:

  • For every individual patch,

    • compile with CLIPPY=1 and CONFIG_RUST_KERNEL_DOCTESTS=y and ensure there are not build failures or warnings,

    • execute the rustfmt make target to ensure your patch is properly formatted,

    • execute the rustdoc make target and ensure it’s free of warnings,

    • execute the htmldocs or pdfdocs make target and ensure you did not introduce errors or warnings,

    • run ./scripts/checkpatch.pl –strict –codespell,

    • if your patch may affect doc-tests, ensure that all doc-tests do still pass.

  • For the whole series,

Tooling

drm-rust git repositories are managed with dim.