Re: [PATCH RFC v2 1/5] rust: add useful ops for u64

[Timur Tabi <ttabi@nvidia.com>]

On Tue, 2025-03-04 at 22:53 +0900, Alexandre Courbot wrote:
> +/// Useful operations for `u64`.
> +pub trait U64Ext {
> +    /// Build a `u64` by combining its `high` and `low` parts.
> +    ///
> +    /// ```
> +    /// use kernel::num::U64Ext;
> +    /// assert_eq!(u64::from_u32s(0x01234567, 0x89abcdef),
> 0x01234567_89abcdef);
> +    /// ```
> +    fn from_u32s(high: u32, low: u32) -> Self;
> +
> +    fn upper_32_bits(self) -> u32;
> +    fn lower_32_bits(self) -> u32;
> +}

This generates a few warnings when I build it:

  RUSTC L rust/kernel.o
warning: missing documentation for a method
  --> rust/kernel/num.rs:15:5
   |
15 |     fn upper_32_bits(self) -> u32;
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = note: requested on the command line with `-W missing-docs`

warning: missing documentation for a method
  --> rust/kernel/num.rs:16:5
   |
16 |     fn lower_32_bits(self) -> u32;
   |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: missing documentation for a function
  --> rust/kernel/num.rs:33:1
   |
33 | pub const fn upper_32_bits(v: u64) -> u32 {
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: missing documentation for a function
  --> rust/kernel/num.rs:37:1
   |
37 | pub const fn lower_32_bits(v: u64) -> u32 {
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: missing documentation for a function
  --> rust/kernel/num.rs:41:1
   |
41 | pub const fn u32s_to_u64(high: u32, low: u32) -> u64 {
   | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

warning: 5 warnings emitted