diff options
| author | norablackcat <blackcatgames@protonmail.com> | 2023-05-16 05:18:45 -0600 |
|---|---|---|
| committer | Nora Allen <blackcatgames@protonmail.com> | 2023-05-17 20:25:01 +0000 |
| commit | 1df30b01ff151bbb5718270e49ca67b5e45e048d (patch) | |
| tree | d8e376960efbcc946033f873c3174971e91bb4f2 | |
| parent | 1b31d528b9c5cc1bc17af0f58d9c314b74f8e8b3 (diff) | |
| download | mesa-1df30b01ff151bbb5718270e49ca67b5e45e048d.tar.gz | |
docs/rusticl: add Contributing section
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/23051>
| -rw-r--r-- | docs/envvars.rst | 2 | ||||
| -rw-r--r-- | docs/rusticl.rst | 20 |
2 files changed, 19 insertions, 3 deletions
diff --git a/docs/envvars.rst b/docs/envvars.rst index 9ed93749027..5b7352113a1 100644 --- a/docs/envvars.rst +++ b/docs/envvars.rst @@ -898,6 +898,8 @@ Clover environment variables allows specifying additional linker options. Specified options are appended after the options set by the OpenCL program in ``clLinkProgram``. + +.. _rusticl-env-var: Rusticl environment variables ----------------------------- diff --git a/docs/rusticl.rst b/docs/rusticl.rst index 9217fc766af..e82fa8debd6 100644 --- a/docs/rusticl.rst +++ b/docs/rusticl.rst @@ -33,9 +33,23 @@ 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`` +Contributing +------------ + +The minimum configuration you need to start developing with rust +is ``RUSTC=clippy-driver meson configure -Dgallium-rusticl=true +-Dllvm=enabled -Drust_std=2021``. In addition you probably want to enable +any device drivers on your platform. Some device drivers as well as some +features are locked behind flags during runtime. See +:ref:`Rusticl environment variables <rusticl-env-var>` for +more info. + +All patches that are potentially conformance breaking and also patches +that add new features should be ran against the appropriate conformance +tests. + +Also, make sure the formatting is in order before submitting code. 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 |