8000 Nova docu update by dasteihn · Pull Request #45 · Rust-for-Linux/rust-for-linux.com · GitHub
[go: up one dir, main page]

Skip to content

Nova docu update #45

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

Merged
merged 2 commits into from
Jul 4, 2025
Merged

Nova docu update #45

merged 2 commits into from
Jul 4, 2025

Conversation

dasteihn
Copy link
Contributor
@dasteihn dasteihn commented Jun 13, 2025

The Nova documentation is quite outdated. This PR performs an update.

Rendered view:
https://github.com/dasteihn/rust-for-linux.com/blob/nova-docu-update/src/Nova-GPU-Driver.md

@dakr please review.

Copy link
Member
@dakr dakr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for writing this up, very much appreciated!

It can be expected that, as the driver continues to grow, various other abstractions
will be needed.
Another reason is that Rust's macros are helpful when creating firmware bindings
for continuously changing firmware versions and their ABIs.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hopefully that's a benefit we won't need to leverage too much if the firmware ABI gains some stability.

@dasteihn
Copy link
Contributor Author

@dakr @Gnurou Updated. New version here.


## Status
Rust's most desired feature are its guarantees for memory safety, notably the
elimination of Use-after-Free errors. Those are errors GPU drivers suffer from
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think you forgot to update this section, can you please put what I came up with at the beginning of "### Why write it in Rust?"?

The documentation for Nova should be updated.

To prepare for that, add an architecture overview image.

Signed-off-by: Philipp Stanner <phasta@kernel.org>
@dasteihn dasteihn force-pushed the nova-docu-update branch 2 times, most recently from 6a76147 to a2ce796 Compare July 3, 2025 07:29
@dasteihn dasteihn force-pushed the nova-docu-update branch 3 times, most recently from fb47ac0 to 7d63987 Compare July 3, 2025 09:55
The current documentation for the RfL-User "Nova" is more than one year
old and quite outdated.

Update the Nova documentation.

Signed-off-by: Philipp Stanner <phasta@kernel.org>
@dasteihn dasteihn force-pushed the nova-docu-update branch from 7d63987 to daf9c78 Compare July 3, 2025 10:10
@ojeda ojeda merged commit bbcf66d into Rust-for-Linux:main Jul 4, 2025
@ojeda
Copy link
Member
ojeda commented Jul 4, 2025

This is live now, thanks!

The image uses transparency -- I would recommend using a white background, since otherwise the image is very hard to read under the darker themes.

@dakr
Copy link
Member
dakr commented Jul 4, 2025

Thanks @ojeda and @dasteihn!

@dasteihn Can you please take a look, adjust the background and send a patch if necessary?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0