doc: remove UsingNoAutoLayout #544
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This feature no longer exists. Instead, developers should not call `libtock_build_scripts::auto_layout();` from their build.rs file.
ppannuto
approved these changes
Jun 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The
no_auto_layoutfeature no longer exists. That makes this document outdated. It was actually my PR #482 that removed it. The difference between before that PR and after that PR is that theruntimecrate (which is required) used to have the build.rs code that sets up the linker script. After that PR, the build.rs code is in its own crate that can be optionally included. Hence, it seems like we no longer need that feature.Now, developers can get the same functionality by just not calling
libtock_build_scripts::auto_layout();from their build.rs file.It's possible we should do more than just remove this file. The build scripts crate https://github.com/tock/libtock-rs/tree/master/build_scripts has documentation on how to use
auto_layout(). I started writing a replacement document but didn't have much to say and it seemed redundant with what is in the build scripts readme.