[docs] core::global_allocator should link to std::alloc::GlobalAlloc

[yoshuawuyts]

Seaching for global_allocator in the docs only surfaces core::global_allocator. This surfaces no information on how to use it, since all that info is part of std::alloc::GlobalAlloc.

The solution seems to link from global_allocator to GlobalAlloc so people can read more. However I'm not sure how to create a link between these since they live in separate crates. What's the right way to go about this?

edit: if someone wants to pick this up, please do. This is probably a "good first issue" once we figure out how to link between the two.

Screenshots

References

• 2018 guide on allocators -- this is how I eventually learned about GlobalAlloc; ideally it'd be easier to find.

[jyn514]

The solution seems to link from global_allocator to GlobalAlloc so people can read more. However I'm not sure how to create a link between these since they live in separate crates. What's the right way to go about this?

These can't use intra-doc links, so you need to use relative links. I think ../std/alloc/trait.GlobalAlloc.html would work.

[jyn514]

Mentoring instructions: At

rust/library/core/src/macros/mod.rs

Line 1367 in 383da5e

/// Attribute macro applied to a static to register it as a global allocator.

add a link to ../std/alloc/trait.GlobalAlloc.html.

[mightyiam]

Could I take this on as my first issue?

[yoshuawuyts]

@mightyiam please do!

[LeSeulArtichaut]

Feel free to use the @rustbot claim command to assign the issue to yourself and show you're working on it

[mightyiam]

@rustbot claim

[yoshuawuyts]

yay; thanks for landing this @mightyiam!