Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build and publish Theseus documentation for aarch64 #920

Open
NathanRoyer opened this issue Apr 4, 2023 · 1 comment
Open

Build and publish Theseus documentation for aarch64 #920

NathanRoyer opened this issue Apr 4, 2023 · 1 comment
Labels
documentation an issue about source or book docs help-wanted

Comments

@NathanRoyer
Copy link
Member

I sometimes run into problems adding such attributes to my code:

#[cfg(any(target_arch = "aarch64", doc))]

because when the documentation gets built, references to aarch64-only symbols are invalid/not found.

The first solution to this would be to declare an x86-equivalent for every such symbol.
However sometimes this is bad, for instance in arm_boards it would mean declaring a valid board_config for x86_64 even though this should only be used in aarch64-specific code and definitions.

@hecatia-elegua
Copy link
Contributor

hecatia-elegua commented Apr 4, 2023

https://doc.rust-lang.org/cargo/commands/cargo-doc.html#compilation-options
--target -> This flag may be specified multiple times.
I have not tried it, but it might do something.

https://doc.rust-lang.org/rustdoc/advanced-features.html#interactions-between-platform-specific-docs / rust-lang/rust#1998
sounds like it's probably not as easy as I thought

@kevinaboos kevinaboos changed the title Documentation builds on AArch64 Build and publish Theseus documentation for aarch64 Oct 17, 2023
@kevinaboos kevinaboos added help-wanted documentation an issue about source or book docs labels Oct 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation an issue about source or book docs help-wanted
Projects
None yet
Development

No branches or pull requests

3 participants