nixpkgs/doc/manual.xml

<book xmlns="http://docbook.org/ns/docbook"
      xmlns:xi="http://www.w3.org/2001/XInclude">

  <info>

    <title>Nixpkgs Contributors Guide</title>

    <subtitle>Version <xi:include href=".version" parse="text" /></subtitle>

  </info>

  <xi:include href="introduction.chapter.xml" />
  <xi:include href="quick-start.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" />

</book>
* Manual outline. svn path=/nixpkgs/trunk/; revision=12057 2008-06-12 13:10:11 +00:00			`<book xmlns="http://docbook.org/ns/docbook"`
			`xmlns:xi="http://www.w3.org/2001/XInclude">`

			`<info>`

Nixpkgs manual: Add a Nix expression to build 2014-08-24 09:02:23 +00:00			`<title>Nixpkgs Contributors Guide</title>`
* Manual outline. svn path=/nixpkgs/trunk/; revision=12057 2008-06-12 13:10:11 +00:00
Nixpkgs manual: Add a Nix expression to build 2014-08-24 09:02:23 +00:00			`<subtitle>Version <xi:include href=".version" parse="text" /></subtitle>`
* Manual outline. svn path=/nixpkgs/trunk/; revision=12057 2008-06-12 13:10:11 +00:00
			`</info>`

Move all nixpkgs doc files in to the doc directory This makes a makefile-driven developer workflow nicer. 2018-03-24 14:47:41 +00:00			`<xi:include href="introduction.chapter.xml" />`
* Quick start section. * Updated some packages that are referenced in that section. svn path=/nixpkgs/trunk/; revision=12139 2008-06-17 14:19:59 +00:00			`<xi:include href="quick-start.xml" />`
			`<xi:include href="stdenv.xml" />`
nixpkgs manual: add multiple-output chapter 2016-04-03 17:17:26 +00:00			`<xi:include href="multiple-output.xml" />`
nixpkgs docs: Cross compilation docs 2017-01-22 20:52:35 +00:00			`<xi:include href="cross-compilation.xml" />`
Fixed a syntax error in the buildFHSChrootEnv example. Also, fixed the manual.xml so it actually builds. 2015-12-17 08:42:36 +00:00			`<xi:include href="configuration.xml" />`
all-packages.nix: Add pkgs.overridePackages 2015-06-24 20:57:37 +00:00			`<xi:include href="functions.xml" />`
* Started documenting the meta attributes, including a first (very incomplete) attempt at standardising the license attribute. svn path=/nixpkgs/trunk/; revision=14028 2009-02-10 23:29:42 +00:00			`<xi:include href="meta.xml" />`
nixpkgs manual: split languages into separate files There's no change in content except for amending the title of the section to mention "frameworks", as e.g. I don't consider Qt a language, and it's likely there will be more of similar cases in future. To be certain, I checked diff of the generated HTMLs. 2015-12-19 15:04:36 +00:00			`<xi:include href="languages-frameworks/index.xml" />`
docs: add section on common darwin issues 2017-10-29 16:15:43 +00:00			`<xi:include href="platform-notes.xml" />`
* Moved the Linux kernel maintenance notes to the manual, expanded them. svn path=/nixpkgs/trunk/; revision=12739 2008-08-27 12:59:55 +00:00			`<xi:include href="package-notes.xml" />`
Add overlays mechanism to Nixpkgs. This patch add a new argument to Nixpkgs default expression named "overlays". By default, the value of the argument is either taken from the environment variable `NIXPKGS_OVERLAYS`, or from the directory `~/.nixpkgs/overlays/`. If the environment variable does not name a valid directory then this mechanism would fallback on the home directory. If the home directory does not exists it will fallback on an empty list of overlays. The overlays directory should contain the list of extra Nixpkgs stages which would be used to extend the content of Nixpkgs, with additional set of packages. The overlays, i-e directory, files, symbolic links are used in alphabetical order. The simplest overlay which extends Nixpkgs with nothing looks like: ```nix self: super: { } ``` More refined overlays can use `super` as the basis for building new packages, and `self` as a way to query the final result of the fix-point. An example of overlay which extends Nixpkgs with a small set of packages can be found at: https://github.com/nbp/nixpkgs-mozilla/blob/nixpkgs-overlay/moz-overlay.nix To use this file, checkout the repository and add a symbolic link to the `moz-overlay.nix` file in `~/.nixpkgs/overlays` directory. 2016-12-17 18:05:21 +00:00			`<xi:include href="overlays.xml" />`
* Moved the coding conventions from maintainers/docs to the Nixpkgs manual. * Removed some out-dated files from maintainers/docs. svn path=/nixpkgs/trunk/; revision=17419 2009-09-25 14:27:26 +00:00			`<xi:include href="coding-conventions.xml" />`
Move the submitting-changes down, after coding conventions 2015-07-12 11:35:56 +00:00			`<xi:include href="submitting-changes.xml" />`
manual: reviewing contributions nixos -> nixpkgs (#20626) 2016-11-22 14:15:02 +00:00			`<xi:include href="reviewing-contributions.xml" />`
doc: make it clear the Contributing section is for the docs 2015-06-30 10:25:18 +00:00			`<xi:include href="contributing.xml" />`
Nixpkgs manual: Drop author bla bla 2014-08-24 08:56:35 +00:00
* More stdenv documentation. Some of it has been moved from the Nix manual. svn path=/nixpkgs/trunk/; revision=12164 2008-06-19 16:00:37 +00:00			`</book>`