public/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
nixpkgs/doc/manual.xml

42 lines
1.5 KiB
XML
Raw Normal View History

* 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">
nixpkgs docs: format =)
2018-05-01 19:54:21 -04:00
<info>
[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
<title>Nixpkgs Users and Contributors Guide</title>
nixpkgs docs: format =)
2018-05-01 19:54:21 -04:00
<subtitle>Version <xi:include href=".version" parse="text" />
</subtitle>
</info>
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-28 11:40:40 +01:00
<xi:include href="preface.chapter.xml" />
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 12:17:58 +02:00
<part>
<title>Using Nixpkgs</title>
nixpkgs manual: move using chapters into one folder
2019-10-30 10:39:04 +01:00
<xi:include href="using/configuration.xml" />
<xi:include href="using/overlays.xml" />
<xi:include href="using/overrides.xml" />
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 12:17:58 +02:00
<xi:include href="functions.xml" />
</part>
<part>
<title>Standard environment</title>
nixpkgs manual: move stdenv chapters into one folder
2019-10-30 10:29:10 +01:00
<xi:include href="stdenv/stdenv.xml" />
<xi:include href="stdenv/meta.xml" />
<xi:include href="stdenv/multiple-output.xml" />
<xi:include href="stdenv/cross-compilation.xml" />
<xi:include href="stdenv/platform-notes.xml" />
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 12:17:58 +02:00
</part>
<part>
doc: move fetchers and trivial builders under builders
2019-10-20 13:34:32 +02:00
<title>Builders</title>
<xi:include href="builders/fetchers.xml" />
<xi:include href="builders/trivial-builders.xml" />
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
<xi:include href="builders/special.xml" />
doc: move image builders into new images chapter
2019-10-21 10:57:56 +02:00
<xi:include href="builders/images.xml" />
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 12:17:58 +02:00
<xi:include href="languages-frameworks/index.xml" />
nixpkgs manual: move builders into one folder
2019-10-30 10:41:25 +01:00
<xi:include href="builders/packages/index.xml" />
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 12:17:58 +02:00
</part>
<part>
<title>Contributing to Nixpkgs</title>
nixpkgs manual: move contributing chapters into one folder
2019-10-30 10:27:47 +01:00
<xi:include href="contributing/quick-start.xml" />
<xi:include href="contributing/coding-conventions.xml" />
<xi:include href="contributing/submitting-changes.xml" />
<xi:include href="contributing/reviewing-contributions.xml" />
<xi:include href="contributing/contributing-to-documentation.xml" />
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 12:17:58 +02:00
</part>
* 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>
Reference in New Issue Copy Permalink