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

42 lines
1.4 KiB
XML
Raw Normal View History

* Manual outline. svn path=/nixpkgs/trunk/; revision=12057
2008-06-12 14:10:11 +01:00
<book xmlns="http://docbook.org/ns/docbook"
xmlns:xi="http://www.w3.org/2001/XInclude">
nixpkgs docs: format =)
2018-05-02 00:54:21 +01: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 14:55:00 +01:00
<title>Nixpkgs Users and Contributors Guide</title>
nixpkgs docs: format =)
2018-05-02 00:54:21 +01:00
<subtitle>Version <xi:include href=".version" parse="text" />
</subtitle>
</info>
<xi:include href="introduction.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 11:17:58 +01:00
<part>
<title>Using Nixpkgs</title>
<xi:include href="configuration.xml" />
<xi:include href="overlays.xml" />
doc: move overrides into separate chapter
2019-10-21 10:19:46 +01:00
<xi:include href="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 11:17:58 +01:00
<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>
doc: move fetchers and trivial builders under builders
2019-10-20 12:34:32 +01: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 10:39:46 +01:00
<xi:include href="builders/special.xml" />
doc: move image builders into new images chapter
2019-10-21 09:57:56 +01: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 11:17:58 +01:00
<xi:include href="languages-frameworks/index.xml" />
doc: split packages part into xml file per package
2019-10-20 12:14:30 +01:00
<xi:include href="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 11:17:58 +01:00
</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>
* More stdenv documentation. Some of it has been moved from the Nix manual. svn path=/nixpkgs/trunk/; revision=12164
2008-06-19 17:00:37 +01:00
</book>
Reference in New Issue Copy Permalink