about summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2024-04-09 11:53:28 +0000
committerbors <bors@rust-lang.org>2024-04-09 11:53:28 +0000
commita5feb4f05f09adca661c869b1bf2324898cbaa43 (patch)
tree0ea6dff0e8b598bcc278e9720de26df1b88f7b7e /docs
parent7a8374c162c64c17e865b98aad282d16b16e96d6 (diff)
parent81ef59f6ff50adde239e737f71b59d24d5423ccb (diff)
downloadrust-a5feb4f05f09adca661c869b1bf2324898cbaa43.tar.gz
rust-a5feb4f05f09adca661c869b1bf2324898cbaa43.zip
Auto merge of #17034 - ColinKinloch:flatpak_sdk_rust_enable, r=lnicola
Document enabling the flatpak rust SDK extension

Just having `org.freedesktop.Sdk.Extension.rust-stable` and `org.freedesktop.Sdk.Extension.llvm15` installed is not enough.
`/usr/lib/sdk/rust-stable/bin` at least needs to be added to the `PATH`.

In the case of VSCodium [ide-flatpak-wrapper](https://github.com/noonsleeper/ide-flatpak-wrapper) in included to do this.
Diffstat (limited to 'docs')
-rw-r--r--docs/user/manual.adoc5
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/user/manual.adoc b/docs/user/manual.adoc
index 8bc11fd481d..6521b6d8b36 100644
--- a/docs/user/manual.adoc
+++ b/docs/user/manual.adoc
@@ -210,7 +210,10 @@ While the sandbox can be disabled for some directories, `/usr/bin` will always b
 This prevents access to the system's C compiler, a system-wide installation of Rust, or any other libraries you might want to link to.
 Some compilers and libraries can be acquired as Flatpak SDKs, such as `org.freedesktop.Sdk.Extension.rust-stable` or `org.freedesktop.Sdk.Extension.llvm15`.
 
-If you use a Flatpak SDK for Rust, there should be no extra steps necessary.
+If you use a Flatpak SDK for Rust, it must be in your `PATH`:
+
+ * install the SDK extensions with `flatpak install org.freedesktop.Sdk.Extension.{llvm15,rust-stable}//23.08`
+ * enable SDK extensions in the editor with the environment variable `FLATPAK_ENABLE_SDK_EXT=llvm15,rust-stable` (this can be done using flatseal or `flatpak override`)
 
 If you want to use Flatpak in combination with `rustup`, the following steps might help: