Commit Graph

53 Commits

Author SHA1 Message Date
Jan Tojnar
f854ee87f0
doc: Port stdenv to Markdown
Added the following ids to avoid possible id conflicts from ids auto-generated from titles:

- setup-hook-perl
- setup-hook-python
- setup-hook-pkg-config
- setup-hook-automake
- setup-hook-autoconf
- setup-hook-libxml2
- setup-hook-gdk-pixbuf
2021-03-14 02:18:52 +01:00
Jan Tojnar
53830ca04c
doc: Port stdenv/multiple-output to Markdown 2021-03-14 02:18:40 +01:00
Jan Tojnar
921d0269cc
doc: Port stdenv/meta to Markdown 2021-03-14 02:15:14 +01:00
Ben Siraphob
92d319d5d5
doc/stdenv/platform-notes: convert to markdown 2021-02-21 06:45:21 +01:00
AndersonTorres
30bfb2f5d0 Convert fetchers from DocBook to CommonMark 2020-12-17 12:00:49 -03:00
AndersonTorres
59f9db8b09 Convert trivial-builders from DocBook to CommonMark 2020-12-17 12:00:48 -03:00
Ben Siraphob
71a7249a48 doc/stdenv/cross-compilation: convert to markdown 2020-12-13 19:49:39 +07:00
Jan Tojnar
5ad6509278
doc: Rename submitting-changes to chapter 2020-12-05 12:33:00 +01:00
Arnout Engelen
926c7e8b4e
doc: rename guide to 'Nixpkgs Manual'
For consistency with 'NixOS Manual' and 'Nix Manual', to better match what it's
often called in practice, and to match its URL and HTML title.
2020-09-24 14:07:25 +02:00
Frederik Rietdijk
acfc517a80 nixpkgs manual: move builders into one folder 2019-10-30 11:17:14 +01:00
Frederik Rietdijk
6f7b4b9ee8 nixpkgs manual: move using chapters into one folder 2019-10-30 11:17:14 +01:00
Frederik Rietdijk
680f6238bd nixpkgs manual: move stdenv chapters into one folder 2019-10-30 11:17:14 +01:00
Frederik Rietdijk
ddbf4c1bac nixpkgs manual: move contributing chapters into one folder 2019-10-30 11:17:14 +01:00
Frederik Rietdijk
8ee7740427 nixpkgs manual: various improvements in introduction
- rename to preface to be inline with NixOS manual
- refer to other manuals
- use https
- change example channel to 19.09
2019-10-30 10:25:09 +01:00
Frederik Rietdijk
2b9713c281 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...
2019-10-21 11:39:46 +02:00
Frederik Rietdijk
24b1ef5133 doc: move overrides into separate chapter 2019-10-21 11:19:46 +02:00
Frederik Rietdijk
9d54ea9b2d doc: move image builders into new images chapter 2019-10-21 10:57:56 +02:00
Frederik Rietdijk
16d733bbe5 doc: move fetchers and trivial builders under builders 2019-10-20 13:35:04 +02:00
Frederik Rietdijk
efb55d2a42 doc: split packages part into xml file per package 2019-10-20 13:35:04 +02:00
Frederik Rietdijk
115018ff15 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.
2019-10-20 13:35:04 +02:00
Frederik Rietdijk
95dfbe2d63 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.
2019-10-20 13:35:04 +02:00
Michael Raskin
4e750fa92c
[RFC] manual: rename to users and contributors manual, add some user notes … (#60682)
* manual: rename to users and contributors manual, add some user notes that should be there but don't fit in any chapter
* manual: move the package notes that are completely usage-related to the upper user notes section
* manual: link to package-specific development notes from user notes
2019-05-22 13:55:00 +00:00
Graham Christensen
77161de454
nixpkgs docs: format =) 2018-05-01 19:54:21 -04:00
Graham Christensen
92d53362d4
Move all nixpkgs doc files in to the doc directory
This makes a makefile-driven developer workflow nicer.
2018-03-25 19:52:00 -04:00
Daiderd Jordan
633b03c57f
docs: add section on common darwin issues 2017-11-01 18:08:19 +01:00
John Ericson
39fb46f538 nixpkgs docs: Cross compilation docs 2017-01-24 11:37:56 -05:00
Nicolas B. Pierron
f5dfe78a1e 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.
2017-01-16 01:17:33 +01:00
Eric Sagnes
2b1d67a275 manual: reviewing contributions nixos -> nixpkgs (#20626) 2016-11-22 15:15:02 +01:00
Eric Sagnes
96a4e1f80d nixpkgs manual: cleanup (#15611) 2016-05-22 10:05:37 +01:00
Eric Merritt
be5da0449e beam-support: update registry to latest '59b836d' 2016-04-23 19:03:28 -07:00
Vladimír Čunát
c73191f11e nixpkgs manual: add multiple-output chapter 2016-04-07 16:00:41 +02:00
Eric Merritt
6a493a2b43 erlang support: Add minimal documentation to nix
This commit adds some very minimial documentation to the Nix
manual. Hopefully, its enough to get someone started and serve as a
first footstep for future documentation writers
2016-01-15 08:17:33 -08:00
Vladimír Čunát
ef21e5ee60 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 16:08:00 +01:00
Avery Glitch
b72bcd1e32 Fixed a syntax error in the buildFHSChrootEnv example. Also, fixed the manual.xml so it actually builds. 2015-12-18 00:22:51 +11:00
Cillian de Róiste
8a1a97c35c Move the submitting-changes down, after coding conventions 2015-07-12 13:35:56 +02:00
Cillian de Róiste
3a0707f0c7 Move the details from CONTRIBUTING.md to the manual #8734 2015-07-12 13:33:55 +02:00
Luca Bruno
e7d81a371b doc: make it clear the Contributing section is for the docs 2015-06-30 12:25:55 +02:00
Luca Bruno
7f5f9072ad all-packages.nix: Add pkgs.overridePackages 2015-06-26 15:08:11 +02:00
Peter Simons
fdc1887a6e doc: add user's guide for the Haskell infrastructure
Resolves https://github.com/NixOS/nixpkgs/issues/4941.
2015-06-05 00:14:58 +02:00
Matthias Beyer
9bb80ffa2c Add documentation for nixpkgs.config settings (allowUnfree, allowUnfreePredicate, whitelistedLicenses, blacklistedLicenses) 2015-01-25 21:19:07 +01:00
Eelco Dolstra
438b9c543d Nixpkgs manual: Add a Nix expression to build 2014-08-24 11:03:55 +02:00
Eelco Dolstra
14f48dd5c2 Nixpkgs manual: Drop author bla bla 2014-08-24 11:03:55 +02:00
Domen Kožar
9471af0f8a doc: add section how to build the manual 2014-07-27 15:21:17 +02:00
Eelco Dolstra
041da5a6f9 Unify the Nixpkgs and NixOS version numbers 2013-10-10 13:28:22 +02:00
Eelco Dolstra
09ab016c6c * Sync CSS with the Nix manual.
svn path=/nixpkgs/trunk/; revision=34062
2012-05-11 21:42:00 +00:00
Eelco Dolstra
bfb4a0ccc8 * 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
Eelco Dolstra
24da0cbad8 svn path=/nixpkgs/trunk/; revision=17416 2009-09-25 11:15:50 +00:00
Eelco Dolstra
034248f57a * Document the generic Perl builder.
svn path=/nixpkgs/trunk/; revision=15124
2009-04-18 11:09:24 +00:00
Eelco Dolstra
79d3e0926d * 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
Eelco Dolstra
649ccdd2db * 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