From 25b8aa4a85c16cc2c1d114ea1939a6aea86fe0f7 Mon Sep 17 00:00:00 2001 From: AndersonTorres Date: Sat, 28 Nov 2020 21:10:04 -0300 Subject: Convert Kakoune documentation from XML DocBook to Commonmark --- doc/builders/packages/index.xml | 2 +- doc/builders/packages/kakoune.section.md | 9 +++++++++ doc/builders/packages/kakoune.xml | 12 ------------ 3 files changed, 10 insertions(+), 13 deletions(-) create mode 100644 doc/builders/packages/kakoune.section.md delete mode 100644 doc/builders/packages/kakoune.xml (limited to 'doc') diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml index e20b0c689a80..3c9a56a81b7f 100644 --- a/doc/builders/packages/index.xml +++ b/doc/builders/packages/index.xml @@ -11,7 +11,7 @@ - + diff --git a/doc/builders/packages/kakoune.section.md b/doc/builders/packages/kakoune.section.md new file mode 100644 index 000000000000..8e054777a757 --- /dev/null +++ b/doc/builders/packages/kakoune.section.md @@ -0,0 +1,9 @@ +# Kakoune {#sec-kakoune} + +Kakoune can be built to autoload plugins: + +```nix +(kakoune.override { + plugins = with pkgs.kakounePlugins; [ parinfer-rust ]; +}) +``` diff --git a/doc/builders/packages/kakoune.xml b/doc/builders/packages/kakoune.xml deleted file mode 100644 index 045dbd0a653b..000000000000 --- a/doc/builders/packages/kakoune.xml +++ /dev/null @@ -1,12 +0,0 @@ -
- Kakoune - - - Kakoune can be built to autoload plugins: -(kakoune.override { - plugins = with pkgs.kakounePlugins; [ parinfer-rust ]; -}) - -
-- cgit v1.2.3 From b6bca3d80619f1565ba0ea635b0d38234e41c6bd Mon Sep 17 00:00:00 2001 From: Wil Taylor Date: Mon, 30 Nov 2020 14:30:29 +1000 Subject: doc/Qt: migrate to CommonMark (#105004) * Updated QT section * Fixed trailing whitespace * Update doc/languages-frameworks/qt.section.md Co-authored-by: Jan Tojnar * Update doc/languages-frameworks/qt.section.md Co-authored-by: Jan Tojnar * Made changes to docs as per jtojnar's review * Added docbook tags for callouts back in Co-authored-by: Jan Tojnar --- doc/languages-frameworks/index.xml | 2 +- doc/languages-frameworks/qt.section.md | 124 +++++++++++++++++++++++++++ doc/languages-frameworks/qt.xml | 149 --------------------------------- 3 files changed, 125 insertions(+), 150 deletions(-) create mode 100644 doc/languages-frameworks/qt.section.md delete mode 100644 doc/languages-frameworks/qt.xml (limited to 'doc') diff --git a/doc/languages-frameworks/index.xml b/doc/languages-frameworks/index.xml index 7a4c54fca8d0..22bc6e1baaaf 100644 --- a/doc/languages-frameworks/index.xml +++ b/doc/languages-frameworks/index.xml @@ -25,7 +25,7 @@ - + diff --git a/doc/languages-frameworks/qt.section.md b/doc/languages-frameworks/qt.section.md new file mode 100644 index 000000000000..4a37eb4ef7db --- /dev/null +++ b/doc/languages-frameworks/qt.section.md @@ -0,0 +1,124 @@ +# Qt {#sec-language-qt} + +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. + +## Nix expression for a Qt package (default.nix) {#qt-default-nix} + +```{=docbook} + +{ mkDerivation, lib, qtbase }: + +mkDerivation { + pname = "myapp"; + version = "1.0"; + + buildInputs = [ qtbase ]; +} + + + + + + Import mkDerivation and Qt (such as qtbase modules directly. Do not import Qt package sets; the Qt versions of dependencies may not be coherent, causing build and runtime failures. + + + + + Use mkDerivation instead of stdenv.mkDerivation. mkDerivation is a wrapper around stdenv.mkDerivation which applies some Qt-specific settings. This deriver accepts the same arguments as stdenv.mkDerivation; refer to for details. + + + To use another deriver instead of stdenv.mkDerivation, use mkDerivationWith: + +mkDerivationWith myDeriver { + # ... +} + + If you cannot use mkDerivationWith, please refer to . + + + + + mkDerivation accepts the same arguments as stdenv.mkDerivation, such as buildInputs. + + + +``` + +## Locating runtime dependencies {#qt-runtime-dependencies} +Qt applications need to be wrapped to find runtime dependencies. If you cannot use `mkDerivation` or `mkDerivationWith` above, include `wrapQtAppsHook` in `nativeBuildInputs`: + +```nix +stdenv.mkDerivation { + # ... + + nativeBuildInputs = [ wrapQtAppsHook ]; +} +``` +Entries added to `qtWrapperArgs` are used to modify the wrappers created by `wrapQtAppsHook`. The entries are passed as arguments to [wrapProgram executable makeWrapperArgs](#fun-wrapProgram). + +```nix +mkDerivation { + # ... + + qtWrapperArgs = [ ''--prefix PATH : /path/to/bin'' ]; +} +``` + +Set `dontWrapQtApps` to stop applications from being wrapped automatically. It is required to wrap applications manually with `wrapQtApp`, using the syntax of [wrapProgram executable makeWrapperArgs](#fun-wrapProgram): + +```nix +mkDerivation { + # ... + + dontWrapQtApps = true; + preFixup = '' + wrapQtApp "$out/bin/myapp" --prefix PATH : /path/to/bin + ''; +} +``` + +> Note: `wrapQtAppsHook` 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. + +Libraries are built with every available version of Qt. Use the `meta.broken` attribute to disable the package for unsupported Qt versions: + +```nix +mkDerivation { + # ... + + # Disable this library with Qt < 5.9.0 + meta.broken = builtins.compareVersions qtbase.version "5.9.0" < 0; +} +``` +## Adding a library to Nixpkgs + Add a Qt library to all-packages.nix by adding it to the collection inside `mkLibsForQt5`. This ensures that the library is built with every available version of Qt as needed. + +### Example Adding a Qt library to all-packages.nix {#qt-library-all-packages-nix} + +``` +{ + # ... + + mkLibsForQt5 = self: with self; { + # ... + + mylib = callPackage ../path/to/mylib {}; + }; + + # ... +} +``` +## Adding an application to Nixpkgs +Add a Qt application to *all-packages.nix* using `libsForQt5.callPackage` instead of the usual `callPackage`. The former ensures that all dependencies are built with the same version of Qt. + +### Example Adding a QT application to all-packages.nix {#qt-application-all-packages-nix} +```nix +{ + # ... + + myapp = libsForQt5.callPackage ../path/to/myapp/ {}; + + # ... +} +``` diff --git a/doc/languages-frameworks/qt.xml b/doc/languages-frameworks/qt.xml deleted file mode 100644 index ec95621d8ff2..000000000000 --- a/doc/languages-frameworks/qt.xml +++ /dev/null @@ -1,149 +0,0 @@ -
- Qt - - - 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. - - - - Nix expression for a Qt package (<filename>default.nix</filename>) - -{ mkDerivation, lib, qtbase }: - -mkDerivation { - pname = "myapp"; - version = "1.0"; - - buildInputs = [ qtbase ]; -} - - - - - - - Import mkDerivation and Qt (such as qtbase modules directly. Do not import Qt package sets; the Qt versions of dependencies may not be coherent, causing build and runtime failures. - - - - - Use mkDerivation instead of stdenv.mkDerivation. mkDerivation is a wrapper around stdenv.mkDerivation which applies some Qt-specific settings. This deriver accepts the same arguments as stdenv.mkDerivation; refer to for details. - - - To use another deriver instead of stdenv.mkDerivation, use mkDerivationWith: - -mkDerivationWith myDeriver { - # ... -} - - If you cannot use mkDerivationWith, please refer to . - - - - - mkDerivation accepts the same arguments as stdenv.mkDerivation, such as buildInputs. - - - - - - Locating runtime dependencies - - Qt applications need to be wrapped to find runtime dependencies. If you cannot use mkDerivation or mkDerivationWith above, include wrapQtAppsHook in nativeBuildInputs: - -stdenv.mkDerivation { - # ... - - nativeBuildInputs = [ wrapQtAppsHook ]; -} - - - - - - Entries added to qtWrapperArgs are used to modify the wrappers created by wrapQtAppsHook. The entries are passed as arguments to . - -mkDerivation { - # ... - - qtWrapperArgs = [ ''--prefix PATH : /path/to/bin'' ]; -} - - - - - Set dontWrapQtApps to stop applications from being wrapped automatically. It is required to wrap applications manually with wrapQtApp, using the syntax of : - -mkDerivation { - # ... - - dontWrapQtApps = true; - preFixup = '' - wrapQtApp "$out/bin/myapp" --prefix PATH : /path/to/bin - ''; -} - - - - - - wrapQtAppsHook 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. - - - - - Libraries are built with every available version of Qt. Use the meta.broken attribute to disable the package for unsupported Qt versions: - -mkDerivation { - # ... - - # Disable this library with Qt < 5.9.0 - meta.broken = builtins.compareVersions qtbase.version "5.9.0" < 0; -} - - - - - Adding a library to Nixpkgs - - Add a Qt library to all-packages.nix by adding it to the collection inside mkLibsForQt5. This ensures that the library is built with every available version of Qt as needed. - - Adding a Qt library to <filename>all-packages.nix</filename> - -{ - # ... - - mkLibsForQt5 = self: with self; { - # ... - - mylib = callPackage ../path/to/mylib {}; - }; - - # ... -} - - - - - - - Adding an application to Nixpkgs - - Add a Qt application to all-packages.nix using libsForQt5.callPackage instead of the usual callPackage. The former ensures that all dependencies are built with the same version of Qt. - - Adding a Qt application to <filename>all-packages.nix</filename> - -{ - # ... - - myapp = libsForQt5.callPackage ../path/to/myapp/ {}; - - # ... -} - - - - -
-- cgit v1.2.3 From bbc9af1f0a30fe8106d6fb90f15ebb01845b3008 Mon Sep 17 00:00:00 2001 From: zimbatm Date: Mon, 30 Nov 2020 14:20:28 +0100 Subject: tree-wide: do not use pkgs.extend in nixpkgs Each invocation of pkgs.extends adds 130MB of allocation to the hydra evaluator. We are already struggling with the amount of memory nixpkgs requires. `pkgs.extend` is a useful escape-hatch, but should be not be used inside of nixpkgs directly. --- doc/using/overlays.xml | 1 + 1 file changed, 1 insertion(+) (limited to 'doc') diff --git a/doc/using/overlays.xml b/doc/using/overlays.xml index 4937e9508857..caacb0a04622 100644 --- a/doc/using/overlays.xml +++ b/doc/using/overlays.xml @@ -28,6 +28,7 @@ + NOTE: DO NOT USE THIS in nixpkgs. Further overlays can be added by calling the pkgs.extend or pkgs.appendOverlays, although it is often preferable to avoid these functions, because they recompute the Nixpkgs fixpoint, which is somewhat expensive to do. -- cgit v1.2.3 From 19973c1893837684ae228ac4f8106ad66e5ba34d Mon Sep 17 00:00:00 2001 From: AndersonTorres Date: Sat, 28 Nov 2020 20:49:03 -0300 Subject: Convert Emacs documentation from XML DocBook to CommonMark --- doc/builders/packages/emacs.section.md | 119 ++++++++++++++++++++++++++++++ doc/builders/packages/emacs.xml | 131 --------------------------------- doc/builders/packages/index.xml | 2 +- 3 files changed, 120 insertions(+), 132 deletions(-) create mode 100644 doc/builders/packages/emacs.section.md delete mode 100644 doc/builders/packages/emacs.xml (limited to 'doc') diff --git a/doc/builders/packages/emacs.section.md b/doc/builders/packages/emacs.section.md new file mode 100644 index 000000000000..3829b3575bb1 --- /dev/null +++ b/doc/builders/packages/emacs.section.md @@ -0,0 +1,119 @@ +# Emacs {#sec-emacs} + +## Configuring Emacs + +The Emacs package comes with some extra helpers to make it easier to configure. `emacsWithPackages` allows you to manage packages from ELPA. This means that you will not have to install that packages from within Emacs. For instance, if you wanted to use `company` `counsel`, `flycheck`, `ivy`, `magit`, `projectile`, and `use-package` you could use this as a `~/.config/nixpkgs/config.nix` override: + +```nix +{ + packageOverrides = pkgs: with pkgs; { + myEmacs = emacsWithPackages (epkgs: (with epkgs.melpaStablePackages; [ + company + counsel + flycheck + ivy + magit + projectile + use-package + ])); + } +} +``` + +You can install it like any other packages via `nix-env -iA myEmacs`. However, this will only install those packages. It will not `configure` them for us. To do this, we need to provide a configuration file. Luckily, it is possible to do this from within Nix! By modifying the above example, we can make Emacs load a custom config file. The key is to create a package that provide a `default.el` file in `/share/emacs/site-start/`. Emacs knows to load this file automatically when it starts. + +```nix +{ + packageOverrides = pkgs: with pkgs; rec { + myEmacsConfig = writeText "default.el" '' + ;; initialize package + + (require 'package) + (package-initialize 'noactivate) + (eval-when-compile + (require 'use-package)) + + ;; load some packages + + (use-package company + :bind ("<C-tab>" . company-complete) + :diminish company-mode + :commands (company-mode global-company-mode) + :defer 1 + :config + (global-company-mode)) + + (use-package counsel + :commands (counsel-descbinds) + :bind (([remap execute-extended-command] . counsel-M-x) + ("C-x C-f" . counsel-find-file) + ("C-c g" . counsel-git) + ("C-c j" . counsel-git-grep) + ("C-c k" . counsel-ag) + ("C-x l" . counsel-locate) + ("M-y" . counsel-yank-pop))) + + (use-package flycheck + :defer 2 + :config (global-flycheck-mode)) + + (use-package ivy + :defer 1 + :bind (("C-c C-r" . ivy-resume) + ("C-x C-b" . ivy-switch-buffer) + :map ivy-minibuffer-map + ("C-j" . ivy-call)) + :diminish ivy-mode + :commands ivy-mode + :config + (ivy-mode 1)) + + (use-package magit + :defer + :if (executable-find "git") + :bind (("C-x g" . magit-status) + ("C-x G" . magit-dispatch-popup)) + :init + (setq magit-completing-read-function 'ivy-completing-read)) + + (use-package projectile + :commands projectile-mode + :bind-keymap ("C-c p" . projectile-command-map) + :defer 5 + :config + (projectile-global-mode)) + ''; + + myEmacs = emacsWithPackages (epkgs: (with epkgs.melpaStablePackages; [ + (runCommand "default.el" {} '' + mkdir -p $out/share/emacs/site-lisp + cp ${myEmacsConfig} $out/share/emacs/site-lisp/default.el + '') + company + counsel + flycheck + ivy + magit + projectile + use-package + ])); + }; +} +``` + +This provides a fairly full Emacs start file. It will load in addition to the user's presonal config. You can always disable it by passing `-q` to the Emacs command. + +Sometimes `emacsWithPackages` is not enough, as this package set has some priorities imposed on packages (with the lowest priority assigned to Melpa Unstable, and the highest for packages manually defined in `pkgs/top-level/emacs-packages.nix`). But you can't control this priorities when some package is installed as a dependency. You can override it on per-package-basis, providing all the required dependencies manually - but it's tedious and there is always a possibility that an unwanted dependency will sneak in through some other package. To completely override such a package you can use `overrideScope'`. + +```nix +overrides = self: super: rec { + haskell-mode = self.melpaPackages.haskell-mode; + ... +}; +((emacsPackagesGen emacs).overrideScope' overrides).emacsWithPackages + (p: with p; [ + # here both these package will use haskell-mode of our own choice + ghc-mod + dante + ]) +``` diff --git a/doc/builders/packages/emacs.xml b/doc/builders/packages/emacs.xml deleted file mode 100644 index 9cce7c40863a..000000000000 --- a/doc/builders/packages/emacs.xml +++ /dev/null @@ -1,131 +0,0 @@ -
- Emacs - -
- Configuring Emacs - - - The Emacs package comes with some extra helpers to make it easier to configure. emacsWithPackages allows you to manage packages from ELPA. This means that you will not have to install that packages from within Emacs. For instance, if you wanted to use company, counsel, flycheck, ivy, magit, projectile, and use-package you could use this as a ~/.config/nixpkgs/config.nix override: - - - -{ - packageOverrides = pkgs: with pkgs; { - myEmacs = emacsWithPackages (epkgs: (with epkgs.melpaStablePackages; [ - company - counsel - flycheck - ivy - magit - projectile - use-package - ])); - } -} - - - - You can install it like any other packages via nix-env -iA myEmacs. However, this will only install those packages. It will not configure them for us. To do this, we need to provide a configuration file. Luckily, it is possible to do this from within Nix! By modifying the above example, we can make Emacs load a custom config file. The key is to create a package that provide a default.el file in /share/emacs/site-start/. Emacs knows to load this file automatically when it starts. - - - -{ - packageOverrides = pkgs: with pkgs; rec { - myEmacsConfig = writeText "default.el" '' -;; initialize package - -(require 'package) -(package-initialize 'noactivate) -(eval-when-compile - (require 'use-package)) - -;; load some packages - -(use-package company - :bind ("<C-tab>" . company-complete) - :diminish company-mode - :commands (company-mode global-company-mode) - :defer 1 - :config - (global-company-mode)) - -(use-package counsel - :commands (counsel-descbinds) - :bind (([remap execute-extended-command] . counsel-M-x) - ("C-x C-f" . counsel-find-file) - ("C-c g" . counsel-git) - ("C-c j" . counsel-git-grep) - ("C-c k" . counsel-ag) - ("C-x l" . counsel-locate) - ("M-y" . counsel-yank-pop))) - -(use-package flycheck - :defer 2 - :config (global-flycheck-mode)) - -(use-package ivy - :defer 1 - :bind (("C-c C-r" . ivy-resume) - ("C-x C-b" . ivy-switch-buffer) - :map ivy-minibuffer-map - ("C-j" . ivy-call)) - :diminish ivy-mode - :commands ivy-mode - :config - (ivy-mode 1)) - -(use-package magit - :defer - :if (executable-find "git") - :bind (("C-x g" . magit-status) - ("C-x G" . magit-dispatch-popup)) - :init - (setq magit-completing-read-function 'ivy-completing-read)) - -(use-package projectile - :commands projectile-mode - :bind-keymap ("C-c p" . projectile-command-map) - :defer 5 - :config - (projectile-global-mode)) - ''; - myEmacs = emacsWithPackages (epkgs: (with epkgs.melpaStablePackages; [ - (runCommand "default.el" {} '' -mkdir -p $out/share/emacs/site-lisp -cp ${myEmacsConfig} $out/share/emacs/site-lisp/default.el -'') - company - counsel - flycheck - ivy - magit - projectile - use-package - ])); - }; -} - - - - This provides a fairly full Emacs start file. It will load in addition to the user's presonal config. You can always disable it by passing -q to the Emacs command. - - - - Sometimes emacsWithPackages is not enough, as this package set has some priorities imposed on packages (with the lowest priority assigned to Melpa Unstable, and the highest for packages manually defined in pkgs/top-level/emacs-packages.nix). But you can't control this priorities when some package is installed as a dependency. You can override it on per-package-basis, providing all the required dependencies manually - but it's tedious and there is always a possibility that an unwanted dependency will sneak in through some other package. To completely override such a package you can use overrideScope'. - - - -overrides = self: super: rec { - haskell-mode = self.melpaPackages.haskell-mode; - ... -}; -((emacsPackagesGen emacs).overrideScope' overrides).emacsWithPackages (p: with p; [ - # here both these package will use haskell-mode of our own choice - ghc-mod - dante -]) - -
-
diff --git a/doc/builders/packages/index.xml b/doc/builders/packages/index.xml index e20b0c689a80..8b83e56cf141 100644 --- a/doc/builders/packages/index.xml +++ b/doc/builders/packages/index.xml @@ -9,7 +9,7 @@ - + -- cgit v1.2.3