Skip to content

Reword and expand # Invariant section on MiscDeviceRegistration #1168

Open
@onestacked

Description

@onestacked

Currently the documentation on MiscDeviceRegistration:

/// A registration of a miscdevice.
///
/// # Invariants
///
/// `inner` is a registered misc device.

This invariant is not very precise, so reword and expand it, defining what it means for it to be "registered".

Originally Reported-by: Benno Lossin <[email protected]> in one of my Patch series.


This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes (including generating the documentation if changed, running the Rust doctests if changed, etc.), to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin and to add a Reported-by: tag, a Closes: tag to this issue and a Fixes: tag to the relevant commit. Please see https://docs.kernel.org/process/submitting-patches.html and https://rust-for-linux.com/contributing for details.

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomersmediumExpected to be an issue of medium difficulty to resolve.• libRelated to the `rust/` library.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions