Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
  • Register
  • Sign in
  • L linux
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • Deployments
    • Deployments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Commits
  • Issue Boards
Collapse sidebar
  • Kirill Smelkov
  • linux
  • Repository
  • linux
  • rust
  • kernel
  • workqueue.rs
Find file BlameHistoryPermalink
  • Valentin Obst's avatar
    rust: kernel: fix multiple typos in documentation · b6cda913
    Valentin Obst authored Jan 31, 2024
    
    
    Fixes multiple trivial typos in documentation and comments of the
    kernel crate.
    
    allocator:
    - Fix a trivial list item alignment issue in the last SAFETY comment of
      `krealloc_aligned`.
    
    init:
    - Replace 'type' with 'trait' in the doc comments of the `PinInit` and
      `Init` traits.
    - Add colons before starting lists.
    - Add spaces between the type and equal sign to respect the code
      formatting rules in example code.
    - End a sentence with a full stop instead of a colon.
    
    ioctl:
    - Replace 'an' with 'a' where appropriate.
    
    str:
    - Replace 'Return' with 'Returns' in the doc comment of `bytes_written`
      as the text describes what the function does.
    
    sync/lock:
    - Fix a trivial list item alignment issue in the Safety section of the
      `Backend` trait's description.
    
    sync/lock/spinlock:
    - The code in this module operates on spinlocks, not mutexes. Thus,
      replace 'mutex' with 'spinlock' in the SAFETY comment of `unlock`.
    
    workqueue:
    - Replace "wont" with "won't" in the doc comment of `__enqueue`.
    
    Signed-off-by: default avatarValentin Obst <kernel@valentinobst.de>
    Reviewed-by: default avatarTrevor Gross <tmgross@umich.edu>
    Reviewed-by: default avatarMartin Rodriguez Reboredo <yakoyoku@gmail.com>
    Reviewed-by: default avatarAlice Ryhl <aliceryhl@google.com>
    Link: https://lore.kernel.org/r/20240131-doc-fixes-v3-v3-1-0c8af94ed7de@valentinobst.de
    
    
    Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
    b6cda913
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7