diff mbox series

rust: prelude: prevent doc inline of external imports

Message ID 20221214093451.zdyhmdyxwz73n6pe@imap.mailbox.org
State New
Headers
Series rust: prelude: prevent doc inline of external imports |

Commit Message

Finn Behrens Dec. 14, 2022, 9:34 a.m. UTC 
  This shows exactly where the items are from, previously the items from
macros, alloc and core where shown as a decleration from the kernel crate,
this shows the correct path.

Signed-off-by: Finn Behrens <fin@nyantec.com>
---
 rust/kernel/prelude.rs | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

Comments

Vincenzo Palazzo Dec. 21, 2022, 9:33 a.m. UTC | #1 
IMOHO this make sense.

Reviewed-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com> 

On Wed Dec 14, 2022 at 10:34 AM CET, Finn Behrens wrote:
> This shows exactly where the items are from, previously the items from
> macros, alloc and core where shown as a decleration from the kernel crate,
> this shows the correct path.
>
> Signed-off-by: Finn Behrens <fin@nyantec.com>
> ---
>  rust/kernel/prelude.rs | 8 +++++++-
>  1 file changed, 7 insertions(+), 1 deletion(-)
>
> diff --git a/rust/kernel/prelude.rs b/rust/kernel/prelude.rs
> index 7a90249ee9b9..917721e791b6 100644
> --- a/rust/kernel/prelude.rs
> +++ b/rust/kernel/prelude.rs
> @@ -11,15 +11,21 @@
>  //! use kernel::prelude::*;
>  //! ```
>  
> +#[doc(no_inline)]
>  pub use core::pin::Pin;
>  
> +#[doc(no_inline)]
>  pub use alloc::{boxed::Box, vec::Vec};
>  
> +#[doc(no_inline)]
>  pub use macros::{module, vtable};
>  
>  pub use super::build_assert;
>  
> -pub use super::{dbg, pr_alert, pr_crit, pr_debug, pr_emerg, pr_err, pr_info, pr_notice, pr_warn};
> +// super::std_vendor is hidden, which makes the macro inline for some reason
> +#[doc(no_inline)]
> +pub use super::dbg;
> +pub use super::{pr_alert, pr_crit, pr_debug, pr_emerg, pr_err, pr_info, pr_notice, pr_warn};
>  
>  pub use super::static_assert;
>  
> -- 
> 2.31.1
Miguel Ojeda Jan. 16, 2023, 11:35 p.m. UTC | #2 
On Wed, Dec 14, 2022 at 10:35 AM Finn Behrens <fin@nyantec.com> wrote:
>
> This shows exactly where the items are from, previously the items from
> macros, alloc and core where shown as a decleration from the kernel crate,
> this shows the correct path.

Applied to rust-next, thanks all! (as discussed, I added the Link on
my side, plus fixed a couple typos and the comment style).

Cheers,
Miguel
diff mbox series

Patch

diff --git a/rust/kernel/prelude.rs b/rust/kernel/prelude.rs
index 7a90249ee9b9..917721e791b6 100644
--- a/rust/kernel/prelude.rs
+++ b/rust/kernel/prelude.rs
@@ -11,15 +11,21 @@ 
 //! use kernel::prelude::*;
 //! ```
 
+#[doc(no_inline)]
 pub use core::pin::Pin;
 
+#[doc(no_inline)]
 pub use alloc::{boxed::Box, vec::Vec};
 
+#[doc(no_inline)]
 pub use macros::{module, vtable};
 
 pub use super::build_assert;
 
-pub use super::{dbg, pr_alert, pr_crit, pr_debug, pr_emerg, pr_err, pr_info, pr_notice, pr_warn};
+// super::std_vendor is hidden, which makes the macro inline for some reason
+#[doc(no_inline)]
+pub use super::dbg;
+pub use super::{pr_alert, pr_crit, pr_debug, pr_emerg, pr_err, pr_info, pr_notice, pr_warn};
 
 pub use super::static_assert;