Skip to content

rustdoc: Clean private_intra_doc_links warnings and make them deny #321

Closed

Description

@ojeda
warning: public documentation for `File` links to private item `File::ptr`
  --> rust/kernel/file.rs:15:18
   |
15 | /// The pointer [`File::ptr`] is non-null and valid. Its reference count is also non-zero.
   |                  ^^^^^^^^^^^ this item is private
   |
   = note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
   = note: this link will resolve properly if you pass `--document-private-items`

warning: public documentation for `PollTable` links to private item `PollTable::ptr`
  --> rust/kernel/file_operations.rs:28:18
   |
28 | /// The pointer [`PollTable::ptr`] is null or valid.
   |                  ^^^^^^^^^^^^^^^^ this item is private
   |
   = note: this link will resolve properly if you pass `--document-private-items`

warning: public documentation for `Pages` links to private item `Pages::pages`
  --> rust/kernel/pages.rs:34:18
   |
34 | /// The pointer [`Pages::pages`] is valid and points to 2^ORDER pages.
   |                  ^^^^^^^^^^^^^^ this item is private
   |
   = note: this link will resolve properly if you pass `--document-private-items`

warning: public documentation for `IovIter` links to private item `IovIter::ptr`
  --> rust/kernel/iov_iter.rs:32:18
   |
32 | /// The pointer [`IovIter::ptr`] is non-null and valid.
   |                  ^^^^^^^^^^^^^^ this item is private
   |
   = note: this link will resolve properly if you pass `--document-private-items`

warning: 4 warnings emitted

Activity

  1. added
    • docsRelated to `Documentation/rust/`, `samples/`, generated docs, doctests, typos...
    on May 29, 2021
  2. nbdd0121 commented on May 29, 2021

    @nbdd0121
    Member

    I think we should warn these warnings (including missing_docs) locally and deny them in the CI.

  3. ojeda commented on Jul 6, 2021

    @ojeda
    MemberAuthor

    This was done in #412.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomers• docsRelated to `Documentation/rust/`, `samples/`, generated docs, doctests, typos...

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions