Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: NixOS/nixpkgs
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: d7a921cad9d6
Choose a base ref
...
head repository: NixOS/nixpkgs
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: e36c7e61c39b
Choose a head ref
  • 8 commits
  • 46 files changed
  • 2 contributors

Commits on Oct 20, 2019

  1. doc: organize chapters into parts, and reduce toc depth 

    Reorganize the chapters into parts and reduce the TOC depth to make the
TOC useful again. The top-level TOC is very brief, but that is fine
because every part will have its own TOC.

Section titles of languages/frameworks are also simplified to just
the name of the language/framework.
    @FRidh
    FRidh committed Oct 20, 2019
    Copy the full SHA
    95dfbe2 View commit details

  2. doc: merge package notes and package-specific notes 

    Maybe there was an idea behind this separation, but looking at the
contents I don't see any reason for these being separate.
    @FRidh
    FRidh committed Oct 20, 2019
    1
    Copy the full SHA
    115018f View commit details

  3. doc: split packages part into xml file per package

    @FRidh
    FRidh committed Oct 20, 2019
    Copy the full SHA
    efb55d2 View commit details

  4. doc: move fetchers and trivial builders under builders

    @FRidh
    FRidh committed Oct 20, 2019
    Copy the full SHA
    16d733b View commit details

Commits on Oct 21, 2019

  1. doc: move image builders into new images chapter

    @FRidh
    FRidh committed Oct 21, 2019
    Copy the full SHA
    9d54ea9 View commit details

  2. doc: move overrides into separate chapter

    @FRidh
    FRidh committed Oct 21, 2019

    Verified

    This commit was created on GitHub.com and signed with GitHub’s verified signature.
    GPG key ID: B5690EEEBB952194
    Verified
    Learn about vigilant mode
    Copy the full SHA
    24b1ef5 View commit details

  3. doc: move fhs and mkShell under builders/special 

    In my opinion Functions should only contain pure functions. These are
both meant to provide derivations so I put them under Builders. Don't
know exactly *where* to put them so "special" it is...
    @FRidh
    FRidh committed Oct 21, 2019
    Copy the full SHA
    2b9713c View commit details

Commits on Oct 22, 2019

  1. Merge pull request #71434 from FRidh/manual 

    doc: organize chapters into parts, and reduce toc depth
    @FRidh
    FRidh authored Oct 22, 2019
    Copy the full SHA
    e36c7e6 View commit details
Showing with 883 additions and 829 deletions.
  1. +4 −4 doc/{functions → builders}/fetchers.xml
  2. +12 −0 doc/builders/images.xml
  3. 0 doc/{functions → builders/images}/appimagetools.xml
  4. 0 doc/{functions → builders/images}/dockertools.xml
  5. 0 doc/{functions → builders/images}/ocitools.xml
  6. 0 doc/{functions → builders/images}/snap/example-firefox.nix
  7. 0 doc/{functions → builders/images}/snap/example-hello.nix
  8. 0 doc/{functions → builders/images}/snaptools.xml
  9. +12 −0 doc/builders/special.xml
  10. 0 doc/{functions → builders/special}/fhs-environments.xml
  11. 0 doc/{functions/shell.xml → builders/special/mkshell.xml}
  12. +3 −3 doc/{functions → builders}/trivial-builders.xml
  13. 0 doc/{contributing.xml → contributing-to-documentation.xml}
  14. +1 −1 doc/doc-support/parameters.xml
  15. +0 −9 doc/functions.xml
  16. +1 −1 doc/languages-frameworks/emscripten.section.md
  17. +1 −1 doc/languages-frameworks/haskell.section.md
  18. +1 −1 doc/languages-frameworks/idris.section.md
  19. +3 −3 doc/languages-frameworks/index.xml
  20. +2 −2 doc/languages-frameworks/node.section.md
  21. +2 −2 doc/languages-frameworks/r.section.md
  22. +1 −1 doc/languages-frameworks/rust.section.md
  23. +1 −1 doc/languages-frameworks/vim.section.md
  24. +32 −16 doc/manual.xml
  25. +3 −3 doc/{functions → }/overrides.xml
  26. +0 −422 doc/package-notes.xml
  27. +0 −357 doc/package-specific-user-notes.xml
  28. +44 −0 doc/packages/citrix.xml
  29. +24 −0 doc/packages/dlib.xml
  30. +72 −0 doc/packages/eclipse.xml
  31. +17 −0 doc/packages/elm.xml
  32. +131 −0 doc/packages/emacs.xml
  33. +57 −0 doc/packages/ibus.xml
  34. +23 −0 doc/packages/index.xml
  35. +14 −0 doc/packages/kakoune.xml
  36. +85 −0 doc/packages/linux.xml
  37. +13 −0 doc/packages/locales.xml
  38. +25 −0 doc/packages/nginx.xml
  39. +9 −0 doc/packages/opengl.xml
  40. +25 −0 doc/packages/shell-helpers.xml
  41. +131 −0 doc/packages/steam.xml
  42. +13 −0 doc/packages/unfree.xml
  43. +85 −0 doc/packages/weechat.xml
  44. +34 −0 doc/packages/xorg.xml
  45. +1 −1 doc/platform-notes.xml
  46. +1 −1 doc/reviewing-contributions.xml
8 changes: 4 additions & 4 deletions doc/functions/fetchers.xml → doc/builders/fetchers.xml
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<section xmlns="http://docbook.org/ns/docbook"
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="sec-pkgs-fetchers">
<title>Fetcher functions</title>
xml:id="chap-pkgs-fetchers">
<title>Fetchers</title>

<para>
When using Nix, you will frequently need to download source code and other files from the internet. Nixpkgs comes with a few helper functions that allow you to fetch fixed-output derivations in a structured way.
@@ -145,4 +145,4 @@ stdenv.mkDerivation {
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>
12 changes: 12 additions & 0 deletions doc/builders/images.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="chap-images">
<title>Images</title>
<para>
This chapter describes tools for creating various types of images.
</para>
<xi:include href="images/appimagetools.xml" />
<xi:include href="images/dockertools.xml" />
<xi:include href="images/ocitools.xml" />
<xi:include href="images/snaptools.xml" />
</chapter>
0 doc/functions/appimagetools.xml → doc/builders/images/appimagetools.xml
View file
File renamed without changes.
0 doc/functions/dockertools.xml → doc/builders/images/dockertools.xml
View file
File renamed without changes.
0 doc/functions/ocitools.xml → doc/builders/images/ocitools.xml
View file
File renamed without changes.
0 doc/functions/snap/example-firefox.nix → doc/builders/images/snap/example-firefox.nix
View file
File renamed without changes.
0 doc/functions/snap/example-hello.nix → doc/builders/images/snap/example-hello.nix
View file
File renamed without changes.
0 doc/functions/snaptools.xml → doc/builders/images/snaptools.xml
View file
File renamed without changes.
12 changes: 12 additions & 0 deletions doc/builders/special.xml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="chap-special">
<title>Special builders</title>
<para>
This chapter describes several special builders.
</para>
<xi:include href="special/fhs-environments.xml" />
<xi:include href="special/mkshell.xml" />
</chapter>


0 doc/functions/fhs-environments.xml → doc/builders/special/fhs-environments.xml
View file
File renamed without changes.
0 doc/functions/shell.xml → doc/builders/special/mkshell.xml
View file
File renamed without changes.
6 changes: 3 additions & 3 deletions doc/functions/trivial-builders.xml → doc/builders/trivial-builders.xml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<section xmlns="http://docbook.org/ns/docbook"
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="sec-trivial-builders">
xml:id="chap-trivial-builders">
<title>Trivial builders</title>

<para>
@@ -76,4 +76,4 @@
</listitem>
</varlistentry>
</variablelist>
</section>
</chapter>
0 doc/contributing.xml → doc/contributing-to-documentation.xml
View file
File renamed without changes.
2 changes: 1 addition & 1 deletion doc/doc-support/parameters.xml
View file
Original file line number Diff line number Diff line change
@@ -8,7 +8,7 @@
<xsl:param name="html.script" select="'./highlightjs/highlight.pack.js ./highlightjs/loader.js'" />
<xsl:param name="xref.with.number.and.title" select="1" />
<xsl:param name="use.id.as.filename" select="1" />
<xsl:param name="toc.section.depth" select="3" />
<xsl:param name="toc.section.depth" select="0" />
<xsl:param name="admon.style" select="''" />
<xsl:param name="callout.graphics.extension" select="'.svg'" />
</xsl:stylesheet>
9 changes: 0 additions & 9 deletions doc/functions.xml
View file
Original file line number Diff line number Diff line change
@@ -7,17 +7,8 @@
The nixpkgs repository has several utility functions to manipulate Nix expressions.
</para>
<xi:include href="functions/library.xml" />
<xi:include href="functions/overrides.xml" />
<xi:include href="functions/generators.xml" />
<xi:include href="functions/debug.xml" />
<xi:include href="functions/fetchers.xml" />
<xi:include href="functions/trivial-builders.xml" />
<xi:include href="functions/fhs-environments.xml" />
<xi:include href="functions/shell.xml" />
<xi:include href="functions/dockertools.xml" />
<xi:include href="functions/snaptools.xml" />
<xi:include href="functions/appimagetools.xml" />
<xi:include href="functions/prefer-remote-fetch.xml" />
<xi:include href="functions/nix-gitignore.xml" />
<xi:include href="functions/ocitools.xml" />
</chapter>
2 changes: 1 addition & 1 deletion doc/languages-frameworks/emscripten.section.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# User's Guide to Emscripten in Nixpkgs
# Emscripten

[Emscripten](https://github.com/kripken/emscripten): An LLVM-to-JavaScript Compiler

2 changes: 1 addition & 1 deletion doc/languages-frameworks/haskell.section.md
View file
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ title: User's Guide for Haskell in Nixpkgs
author: Peter Simons
date: 2015-06-01
---
# User's Guide to the Haskell Infrastructure
# Haskell


## How to install Haskell packages
2 changes: 1 addition & 1 deletion doc/languages-frameworks/idris.section.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Idris packages
# Idris

## Installing Idris

6 changes: 3 additions & 3 deletions doc/languages-frameworks/index.xml
View file
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="chap-language-support">
<title>Support for specific programming languages and frameworks</title>
<title>Languages and frameworks</title>
<para>
The <link linkend="chap-stdenv">standard build environment</link> makes it easy to build typical Autotools-based packages with very little code. Any other kind of package can be accomodated by overriding the appropriate phases of <literal>stdenv</literal>. However, there are specialised functions in Nixpkgs to easily build packages for other programming languages, such as Perl or Haskell. These are described in this chapter.
</para>
<xi:include href="android.section.xml" />
<xi:include href="beam.xml" />
<xi:include href="bower.xml" />
<xi:include href="coq.xml" />
<xi:include href="crystal.section.xml" />
<xi:include href="emscripten.section.xml" />
<xi:include href="gnome.xml" />
<xi:include href="go.xml" />
<xi:include href="haskell.section.xml" />
@@ -27,6 +29,4 @@
<xi:include href="texlive.xml" />
<xi:include href="titanium.section.xml" />
<xi:include href="vim.section.xml" />
<xi:include href="emscripten.section.xml" />
<xi:include href="crystal.section.xml" />
</chapter>
4 changes: 2 additions & 2 deletions doc/languages-frameworks/node.section.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Node.js packages
================
Node.js
=======
The `pkgs/development/node-packages` folder contains a generated collection of
[NPM packages](https://npmjs.com/) that can be installed with the Nix package
manager.
4 changes: 2 additions & 2 deletions doc/languages-frameworks/r.section.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
R packages
==========
R
=

## Installation

2 changes: 1 addition & 1 deletion doc/languages-frameworks/rust.section.md
View file
Original file line number Diff line number Diff line change
@@ -4,7 +4,7 @@ author: Matthias Beyer
date: 2017-03-05
---

# User's Guide to the Rust Infrastructure
# Rust

To install the rust compiler and cargo put

2 changes: 1 addition & 1 deletion doc/languages-frameworks/vim.section.md
View file
Original file line number Diff line number Diff line change
@@ -3,7 +3,7 @@ title: User's Guide for Vim in Nixpkgs
author: Marc Weber
date: 2016-06-25
---
# User's Guide to Vim Plugins/Addons/Bundles/Scripts in Nixpkgs
# Vim

Both Neovim and Vim can be configured to include your favorite plugins
and additional libraries.
48 changes: 32 additions & 16 deletions doc/manual.xml
View file
Original file line number Diff line number Diff line change
@@ -6,20 +6,36 @@
</subtitle>
</info>
<xi:include href="introduction.chapter.xml" />
<xi:include href="quick-start.xml" />
<xi:include href="package-specific-user-notes.xml" />
<xi:include href="stdenv.xml" />
<xi:include href="multiple-output.xml" />
<xi:include href="cross-compilation.xml" />
<xi:include href="configuration.xml" />
<xi:include href="functions.xml" />
<xi:include href="meta.xml" />
<xi:include href="languages-frameworks/index.xml" />
<xi:include href="platform-notes.xml" />
<xi:include href="package-notes.xml" />
<xi:include href="overlays.xml" />
<xi:include href="coding-conventions.xml" />
<xi:include href="submitting-changes.xml" />
<xi:include href="reviewing-contributions.xml" />
<xi:include href="contributing.xml" />
<part>
<title>Using Nixpkgs</title>
<xi:include href="configuration.xml" />
<xi:include href="overlays.xml" />
<xi:include href="overrides.xml" />
<xi:include href="functions.xml" />
</part>
<part>
<title>Standard environment</title>
<xi:include href="stdenv.xml" />
<xi:include href="meta.xml" />
<xi:include href="multiple-output.xml" />
<xi:include href="cross-compilation.xml" />
<xi:include href="platform-notes.xml" />
</part>
<part>
<title>Builders</title>
<xi:include href="builders/fetchers.xml" />
<xi:include href="builders/trivial-builders.xml" />
<xi:include href="builders/special.xml" />
<xi:include href="builders/images.xml" />
<xi:include href="languages-frameworks/index.xml" />
<xi:include href="packages/index.xml" />
</part>
<part>
<title>Contributing to Nixpkgs</title>
<xi:include href="quick-start.xml" />
<xi:include href="coding-conventions.xml" />
<xi:include href="submitting-changes.xml" />
<xi:include href="reviewing-contributions.xml" />
<xi:include href="contributing-to-documentation.xml" />
</part>
</book>
6 changes: 3 additions & 3 deletions doc/functions/overrides.xml → doc/overrides.xml
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<section xmlns="http://docbook.org/ns/docbook"
<chapter xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="sec-overrides">
xml:id="chap-overrides">
<title>Overriding</title>

<para>
@@ -148,4 +148,4 @@ c = lib.makeOverridable f { a = 1; b = 2; };
The variable <varname>c</varname> however also has some additional functions, like <link linkend="sec-pkg-override">c.override</link> which can be used to override the default arguments. In this example the value of <varname>(c.override { a = 4; }).result</varname> is 6.
</para>
</section>
</section>
</chapter>
Loading