about summary refs log tree commit diff
path: root/doc/languages-frameworks/qt.xml
diff options
context:
space:
mode:
authorJan Tojnar <jtojnar@gmail.com>2019-09-18 22:12:54 +0200
committerJan Tojnar <jtojnar@gmail.com>2019-09-18 22:12:54 +0200
commit83c2ad80ca8c6087b034155e2a767c4f72a6df3f (patch)
treec41b8748c9226bbabef4306dafcc3899e936e32c /doc/languages-frameworks/qt.xml
parent641f6356d387ef493812de23f75114effc0cc398 (diff)
downloadnixlib-83c2ad80ca8c6087b034155e2a767c4f72a6df3f.tar
nixlib-83c2ad80ca8c6087b034155e2a767c4f72a6df3f.tar.gz
nixlib-83c2ad80ca8c6087b034155e2a767c4f72a6df3f.tar.bz2
nixlib-83c2ad80ca8c6087b034155e2a767c4f72a6df3f.tar.lz
nixlib-83c2ad80ca8c6087b034155e2a767c4f72a6df3f.tar.xz
nixlib-83c2ad80ca8c6087b034155e2a767c4f72a6df3f.tar.zst
nixlib-83c2ad80ca8c6087b034155e2a767c4f72a6df3f.zip
doc: re-format
Diffstat (limited to 'doc/languages-frameworks/qt.xml')
-rw-r--r--doc/languages-frameworks/qt.xml60
1 files changed, 13 insertions, 47 deletions
diff --git a/doc/languages-frameworks/qt.xml b/doc/languages-frameworks/qt.xml
index d6f3314ab08d..8d97de504ad3 100644
--- a/doc/languages-frameworks/qt.xml
+++ b/doc/languages-frameworks/qt.xml
@@ -4,11 +4,7 @@
  <title>Qt</title>
 
  <para>
-  This section describes the differences between Nix expressions for Qt
-  libraries and applications and Nix expressions for other C++ software. Some
-  knowledge of the latter is assumed. There are primarily two problems which
-  the Qt infrastructure is designed to address: ensuring consistent versioning
-  of all dependencies and finding dependencies at runtime.
+  This section describes the differences between Nix expressions for Qt libraries and applications and Nix expressions for other C++ software. Some knowledge of the latter is assumed. There are primarily two problems which the Qt infrastructure is designed to address: ensuring consistent versioning of all dependencies and finding dependencies at runtime.
  </para>
 
  <example xml:id='qt-default-nix'>
@@ -28,38 +24,26 @@ mkDerivation { <co xml:id='qt-default-nix-co-2' />
  <calloutlist>
   <callout arearefs='qt-default-nix-co-1'>
    <para>
-    Import <literal>mkDerivation</literal> and Qt (such as
-    <literal>qtbase</literal> modules directly. <emphasis>Do not</emphasis>
-    import Qt package sets; the Qt versions of dependencies may not be
-    coherent, causing build and runtime failures.
+    Import <literal>mkDerivation</literal> and Qt (such as <literal>qtbase</literal> modules directly. <emphasis>Do not</emphasis> import Qt package sets; the Qt versions of dependencies may not be coherent, causing build and runtime failures.
    </para>
   </callout>
   <callout arearefs='qt-default-nix-co-2'>
    <para>
-    Use <literal>mkDerivation</literal> instead of
-    <literal>stdenv.mkDerivation</literal>. <literal>mkDerivation</literal> is
-    a wrapper around <literal>stdenv.mkDerivation</literal> which applies some
-    Qt-specific settings. This deriver accepts the same arguments as
-    <literal>stdenv.mkDerivation</literal>; refer to
-    <xref linkend='chap-stdenv' /> for details.
+    Use <literal>mkDerivation</literal> instead of <literal>stdenv.mkDerivation</literal>. <literal>mkDerivation</literal> is a wrapper around <literal>stdenv.mkDerivation</literal> which applies some Qt-specific settings. This deriver accepts the same arguments as <literal>stdenv.mkDerivation</literal>; refer to <xref linkend='chap-stdenv' /> for details.
    </para>
    <para>
-    To use another deriver instead of <literal>stdenv.mkDerivation</literal>,
-    use <literal>mkDerivationWith</literal>:
+    To use another deriver instead of <literal>stdenv.mkDerivation</literal>, use <literal>mkDerivationWith</literal>:
 <programlisting>
 mkDerivationWith myDeriver {
   # ...
 }
 </programlisting>
-    If you cannot use <literal>mkDerivationWith</literal>, please refer to
-    <xref linkend='qt-runtime-dependencies' />.
+    If you cannot use <literal>mkDerivationWith</literal>, please refer to <xref linkend='qt-runtime-dependencies' />.
    </para>
   </callout>
   <callout arearefs='qt-default-nix-co-3'>
    <para>
-    <literal>mkDerivation</literal> accepts the same arguments as
-    <literal>stdenv.mkDerivation</literal>, such as
-    <literal>buildInputs</literal>.
+    <literal>mkDerivation</literal> accepts the same arguments as <literal>stdenv.mkDerivation</literal>, such as <literal>buildInputs</literal>.
    </para>
   </callout>
  </calloutlist>
@@ -67,10 +51,7 @@ mkDerivationWith myDeriver {
  <formalpara xml:id='qt-runtime-dependencies'>
   <title>Locating runtime dependencies</title>
   <para>
-   Qt applications need to be wrapped to find runtime dependencies. If you
-   cannot use <literal>mkDerivation</literal> or
-   <literal>mkDerivationWith</literal> above, include
-   <literal>wrapQtAppsHook</literal> in <literal>nativeBuildInputs</literal>:
+   Qt applications need to be wrapped to find runtime dependencies. If you cannot use <literal>mkDerivation</literal> or <literal>mkDerivationWith</literal> above, include <literal>wrapQtAppsHook</literal> in <literal>nativeBuildInputs</literal>:
 <programlisting>
 stdenv.mkDerivation {
   # ...
@@ -82,9 +63,7 @@ stdenv.mkDerivation {
  </formalpara>
 
  <para>
-  Entries added to <literal>qtWrapperArgs</literal> are used to modify the
-  wrappers created by <literal>wrapQtAppsHook</literal>. The entries are passed
-  as arguments to <xref linkend='fun-wrapProgram' />.
+  Entries added to <literal>qtWrapperArgs</literal> are used to modify the wrappers created by <literal>wrapQtAppsHook</literal>. The entries are passed as arguments to <xref linkend='fun-wrapProgram' />.
 <programlisting>
 mkDerivation {
   # ...
@@ -95,10 +74,7 @@ mkDerivation {
  </para>
 
  <para>
-  Set <literal>dontWrapQtApps</literal> to stop applications from being wrapped
-  automatically. It is required to wrap applications manually with
-  <literal>wrapQtApp</literal>, using the syntax of
-  <xref linkend='fun-wrapProgram' />:
+  Set <literal>dontWrapQtApps</literal> to stop applications from being wrapped automatically. It is required to wrap applications manually with <literal>wrapQtApp</literal>, using the syntax of <xref linkend='fun-wrapProgram' />:
 <programlisting>
 mkDerivation {
   # ...
@@ -113,17 +89,12 @@ mkDerivation {
 
  <note>
   <para>
-   <literal>wrapQtAppsHook</literal> ignores files that are non-ELF
-   executables. This means that scripts won't be automatically wrapped so
-   you'll need to manually wrap them as previously mentioned. An example of
-   when you'd always need to do this is with Python applications that use PyQT.
+   <literal>wrapQtAppsHook</literal> ignores files that are non-ELF executables. This means that scripts won't be automatically wrapped so you'll need to manually wrap them as previously mentioned. An example of when you'd always need to do this is with Python applications that use PyQT.
   </para>
  </note>
 
  <para>
-  Libraries are built with every available version of Qt. Use the
-  <literal>meta.broken</literal> attribute to disable the package for
-  unsupported Qt versions:
+  Libraries are built with every available version of Qt. Use the <literal>meta.broken</literal> attribute to disable the package for unsupported Qt versions:
 <programlisting>
 mkDerivation {
   # ...
@@ -137,9 +108,7 @@ mkDerivation {
  <formalpara>
   <title>Adding a library to Nixpkgs</title>
   <para>
-   Add a Qt library to <filename>all-packages.nix</filename> by adding it to
-   the collection inside <literal>mkLibsForQt5</literal>. This ensures that the
-   library is built with every available version of Qt as needed.
+   Add a Qt library to <filename>all-packages.nix</filename> by adding it to the collection inside <literal>mkLibsForQt5</literal>. This ensures that the library is built with every available version of Qt as needed.
    <example xml:id='qt-library-all-packages-nix'>
     <title>Adding a Qt library to <filename>all-packages.nix</filename></title>
 <programlisting>
@@ -162,10 +131,7 @@ mkDerivation {
  <formalpara>
   <title>Adding an application to Nixpkgs</title>
   <para>
-   Add a Qt application to <filename>all-packages.nix</filename> using
-   <literal>libsForQt5.callPackage</literal> instead of the usual
-   <literal>callPackage</literal>. The former ensures that all dependencies are
-   built with the same version of Qt.
+   Add a Qt application to <filename>all-packages.nix</filename> using <literal>libsForQt5.callPackage</literal> instead of the usual <literal>callPackage</literal>. The former ensures that all dependencies are built with the same version of Qt.
    <example xml:id='qt-application-all-packages-nix'>
     <title>Adding a Qt application to <filename>all-packages.nix</filename></title>
 <programlisting>