diff options
author | pennae <github@quasiparticle.net> | 2023-06-10 18:13:33 +0200 |
---|---|---|
committer | pennae <github@quasiparticle.net> | 2023-06-10 18:17:05 +0200 |
commit | 2f76a3df6405df203b7392edca0e5000d4787057 (patch) | |
tree | 3d3c8fd10a7ce4d66bc1f97e1c3c65226e959d48 /doc/languages-frameworks/qt.section.md | |
parent | 2ecc93d6fe1be154da6ef9e268b46ec242998511 (diff) |
doc: don't use docbook program listings/callouts
nixos-render-docs does not support this, and since the examples are small there isn't that much value in callouts here. change them to simple MD code blocks and lists instead.
Diffstat (limited to 'doc/languages-frameworks/qt.section.md')
-rw-r--r-- | doc/languages-frameworks/qt.section.md | 29 |
1 files changed, 7 insertions, 22 deletions
diff --git a/doc/languages-frameworks/qt.section.md b/doc/languages-frameworks/qt.section.md index e09194e391e1c..2300c5f60edeb 100644 --- a/doc/languages-frameworks/qt.section.md +++ b/doc/languages-frameworks/qt.section.md @@ -10,37 +10,22 @@ pure and explicit at build-time, at the cost of introducing an extra indirection ## Nix expression for a Qt package (default.nix) {#qt-default-nix} -```{=docbook} -<programlisting> -{ stdenv, lib, qtbase, wrapQtAppsHook }: <co xml:id='qt-default-nix-co-1' /> +```nix +{ stdenv, lib, qtbase, wrapQtAppsHook }: stdenv.mkDerivation { pname = "myapp"; version = "1.0"; buildInputs = [ qtbase ]; - nativeBuildInputs = [ wrapQtAppsHook ]; <co xml:id='qt-default-nix-co-2' /> + nativeBuildInputs = [ wrapQtAppsHook ]; } -</programlisting> - - <calloutlist> - <callout arearefs='qt-default-nix-co-1'> - <para> - Import Qt modules directly, that is: <literal>qtbase</literal>, <literal>qtdeclarative</literal>, etc. - <emphasis>Do not</emphasis> import Qt package sets such as <literal>qt5</literal> - because the Qt versions of dependencies may not be coherent, causing build and runtime failures. - </para> - </callout> - <callout arearefs='qt-default-nix-co-2'> - <para> - All Qt packages must include <literal>wrapQtAppsHook</literal> in - <literal>nativeBuildInputs</literal>, or you must explicitly set - <literal>dontWrapQtApps</literal>. - </para> - </callout> - </calloutlist> ``` +It is important to import Qt modules directly, that is: `qtbase`, `qtdeclarative`, etc. *Do not* import Qt package sets such as `qt5` because the Qt versions of dependencies may not be coherent, causing build and runtime failures. + +Additionally all Qt packages must include `wrapQtAppsHook` in `nativeBuildInputs`, or you must explicitly set `dontWrapQtApps`. + ## Locating runtime dependencies {#qt-runtime-dependencies} Qt applications must be wrapped to find runtime dependencies. |