about summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorWeijia Wang <9713184+wegank@users.noreply.github.com>2024-04-09 08:26:23 +0200
committerWeijia Wang <9713184+wegank@users.noreply.github.com>2024-04-09 08:26:23 +0200
commit3f59355d8466fc2b1cfe45cd21e4476a686bfeaf (patch)
treee3f355b60c44bab4ddf55f4a87836c88abf738b1 /doc
parentf682fc1115301f70586f107573d2e4705cb238dd (diff)
parent038c0347a0d39cb187d76260785b610f05706a23 (diff)
downloadnixlib-3f59355d8466fc2b1cfe45cd21e4476a686bfeaf.tar
nixlib-3f59355d8466fc2b1cfe45cd21e4476a686bfeaf.tar.gz
nixlib-3f59355d8466fc2b1cfe45cd21e4476a686bfeaf.tar.bz2
nixlib-3f59355d8466fc2b1cfe45cd21e4476a686bfeaf.tar.lz
nixlib-3f59355d8466fc2b1cfe45cd21e4476a686bfeaf.tar.xz
nixlib-3f59355d8466fc2b1cfe45cd21e4476a686bfeaf.tar.zst
nixlib-3f59355d8466fc2b1cfe45cd21e4476a686bfeaf.zip
Merge branch 'staging-next' into staging
Diffstat (limited to 'doc')
-rw-r--r--doc/packages/index.md1
-rw-r--r--doc/packages/krita.section.md37
-rw-r--r--doc/packages/shell-helpers.section.md8
-rw-r--r--doc/stdenv/stdenv.chapter.md4
4 files changed, 44 insertions, 6 deletions
diff --git a/doc/packages/index.md b/doc/packages/index.md
index 1f45018ffc4a..38dba5b3498f 100644
--- a/doc/packages/index.md
+++ b/doc/packages/index.md
@@ -14,6 +14,7 @@ fish.section.md
 fuse.section.md
 ibus.section.md
 kakoune.section.md
+krita.section.md
 linux.section.md
 locales.section.md
 etc-files.section.md
diff --git a/doc/packages/krita.section.md b/doc/packages/krita.section.md
new file mode 100644
index 000000000000..ba427bd62ba1
--- /dev/null
+++ b/doc/packages/krita.section.md
@@ -0,0 +1,37 @@
+# Krita {#sec-krita}
+
+## Python plugins {#krita-python-plugins}
+
+"pykrita" plugins should be installed following
+[Krita's manual](https://docs.krita.org/en/user_manual/python_scripting/install_custom_python_plugin.html).
+This generally involves extracting the extension to `~/.local/share/krita/pykrita/`.
+
+## Binary plugins {#krita-binary-plugins}
+
+Binary plugins are Dynamically Linked Libraries to be loaded by Krita.
+
+_Note: You most likely won't need to deal with binary plugins,
+all known plugins are bundled and enabled by default._
+
+### Installing binary plugins {#krita-install-binary-plugins}
+
+You can choose what plugins are added to Krita by overriding the
+`binaryPlugins` attribute.
+
+If you want to add plugins instead of replacing, you can read the
+list of previous plugins via `pkgs.krita.binaryPlugins`:
+
+```nix
+(pkgs.krita.override (old: {
+    binaryPlugins = old.binaryPlugins ++ [ your-plugin ];
+}))
+```
+
+### Example structure of a binary plugin {#krita-binary-plugin-structure}
+
+```
+/nix/store/00000000000000000000000000000000-krita-plugin-example-1.2.3
+└── lib
+   └── kritaplugins
+      └── krita_example.so
+```
diff --git a/doc/packages/shell-helpers.section.md b/doc/packages/shell-helpers.section.md
index e7c2b0abebfc..1c73303f8284 100644
--- a/doc/packages/shell-helpers.section.md
+++ b/doc/packages/shell-helpers.section.md
@@ -2,11 +2,11 @@
 
 Some packages provide the shell integration to be more useful. But unlike other systems, nix doesn't have a standard `share` directory location. This is why a bunch `PACKAGE-share` scripts are shipped that print the location of the corresponding shared folder. Current list of such packages is as following:
 
-- `fzf` : `fzf-share`
+- `sk` : `sk-share`
 
-E.g. `fzf` can then be used in the `.bashrc` like this:
+E.g. `sk` can then be used in the `.bashrc` like this:
 
 ```bash
-source "$(fzf-share)/completion.bash"
-source "$(fzf-share)/key-bindings.bash"
+source "$(sk-share)/completion.bash"
+source "$(sk-share)/key-bindings.bash"
 ```
diff --git a/doc/stdenv/stdenv.chapter.md b/doc/stdenv/stdenv.chapter.md
index a1e27b7bdf7f..f3cdb1f2dc0c 100644
--- a/doc/stdenv/stdenv.chapter.md
+++ b/doc/stdenv/stdenv.chapter.md
@@ -797,7 +797,7 @@ A shell array containing additional arguments passed to the configure script. Yo
 
 ##### `dontAddPrefix` {#var-stdenv-dontAddPrefix}
 
-By default, the flag `--prefix=$prefix` is added to the configure flags. If this is undesirable, set this variable to true.
+By default, `./configure` is passed the concatenation of [`prefixKey`](#var-stdenv-prefixKey) and [`prefix`](#var-stdenv-prefix) on the command line. Disable this by setting `dontAddPrefix` to `true`.
 
 ##### `prefix` {#var-stdenv-prefix}
 
@@ -805,7 +805,7 @@ The prefix under which the package must be installed, passed via the `--prefix`
 
 ##### `prefixKey` {#var-stdenv-prefixKey}
 
-The key to use when specifying the prefix. By default, this is set to `--prefix=` as that is used by the majority of packages.
+The key to use when specifying the installation [`prefix`](#var-stdenv-prefix). By default, this is set to `--prefix=` as that is used by the majority of packages. Other packages may need `--prefix ` (with a trailing space) or `PREFIX=`.
 
 ##### `dontAddStaticConfigureFlags` {#var-stdenv-dontAddStaticConfigureFlags}