Module: Mesa Branch: main Commit: e14c418862eb130070bb0fa2917313c6367b4497 URL: http://cgit.freedesktop.org/mesa/mesa/commit/?id=e14c418862eb130070bb0fa2917313c6367b4497
Author: Eric Engestrom <[email protected]> Date: Tue Sep 13 09:16:19 2022 +0100 docs: move rusticl readme into docs/ And convert it from Markdown to rST. Signed-off-by: Eric Engestrom <[email protected]> Reviewed-by: Karol Herbst <[email protected]> Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/18568> --- docs/index.rst | 1 + docs/rusticl.rst | 30 ++++++++++++++++++++++++++++++ src/gallium/frontends/rusticl/README.md | 15 --------------- 3 files changed, 31 insertions(+), 15 deletions(-) diff --git a/docs/index.rst b/docs/index.rst index 217afaf787d..c6795fef9da 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -118,6 +118,7 @@ Linux, FreeBSD, and other operating systems. vulkan/index nir/index isl/index + rusticl android macos Linux Kernel Drivers <https://www.kernel.org/doc/html/latest/gpu/> diff --git a/docs/rusticl.rst b/docs/rusticl.rst new file mode 100644 index 00000000000..25306243d64 --- /dev/null +++ b/docs/rusticl.rst @@ -0,0 +1,30 @@ +Rusticl +======= + +The easiest way to build Rusticl is by either installing ``rustc``, +``rustfmt`` and ``bindgen`` from your distribution or to simply use +rustup. Just make sure that the ``rustfmt`` and ``bindgen`` components +are installed. Then simply add ``-Dgallium-rusticl=true -Dllvm=enabled +-Drust_std=2021`` to your build options. + +Most of the code related to Mesa's C code lives inside ``/mesa``, with +the occasional use of enums, structs or constants through the code base. + +If you need help ping ``karolherbst`` either in ``#dri-devel`` or +``#rusticl`` on OFTC. + +Also, make sure that before submitting code to verify the formatting is +in order. That can easily be done via ``git ls-files */{lib,app}.rs +| xargs rustfmt`` + +When submitting Merge Requests or filing bugs related to Rusticl, make +sure to add the ``Rusticl`` label so people subscribed to that Label get +pinged. + +Known issues +------------ + +One issue you might come across is, that the Rust edition meson sets is +not right. This is a known `meson bug +<https://github.com/mesonbuild/meson/issues/10664>`__ and in order to +fix it, simply run ``meson configure $your_build_dir -Drust_std=2021`` diff --git a/src/gallium/frontends/rusticl/README.md b/src/gallium/frontends/rusticl/README.md deleted file mode 100644 index 4cf82cb9512..00000000000 --- a/src/gallium/frontends/rusticl/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Rusticl - -The easiest way to build Rusticl is by either installing `rustc`, `rustfmt` and `bindgen` from your distribution or to simply use rustup. Just make sure that the `rustfmt` and `bindgen` components are installed. Then simply add `-Dgallium-rusticl=true -Dllvm=enabled -Drust_std=2021` to your build options. - -Most of the code related to Mesa's C code lives inside `/mesa`, with the occasional use of enums, structs or constants through the code base. - -If you need help ping `karolherbst` either in `#dri-devel` or `#rusticl` on OFTC. - -Also, make sure that before submitting code to verify the formatting is in order. That can easily be done via `git ls-files */{lib,app}.rs | xargs rustfmt` - -When submitting Merge Requests or filing bugs related to Rusticl, make sure to add the `Rusticl` label so people subscribed to that Label get pinged. - -## Known issues - -One issue you might come across is, that the Rust edition meson sets is not right. This is a known [meson bug](https://github.com/mesonbuild/meson/issues/10664) and in order to fix it, simply run `meson configure $your_build_dir -Drust_std=2021`
