alioth/nixpkgs
3
0
Fork 0
forked from mirrors/nixpkgs
Code Releases Activity
nixpkgs/doc/manual.xml

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

50 lines
2 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"
doc: assign ids to many headings without stable ids on headings we cannot generate stable links to these headings. nrd complains about this, but the current docbook workflow does not. a few generated ids remain, mostly in examples and footnotes. most of the examples are generated by nixdoc (which has since gained MD export functions, and the MD export does generate IDs).
2023-03-27 21:39:11 +01:00
xmlns:xi="http://www.w3.org/2001/XInclude"
xml:id="nixpkgs-manual">
nixpkgs docs: format =)
2018-05-02 00:54:21 +01:00
<info>
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 12:38:15 +01:00
<title>Nixpkgs Manual</title>
nixpkgs docs: format =)
2018-05-02 00:54:21 +01: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 10:40:40 +00:00
<xi:include href="preface.chapter.xml" />
doc: assign ids to many headings without stable ids on headings we cannot generate stable links to these headings. nrd complains about this, but the current docbook workflow does not. a few generated ids remain, mostly in examples and footnotes. most of the examples are generated by nixdoc (which has since gained MD export functions, and the MD export does generate IDs).
2023-03-27 21:39:11 +01:00
<part xml:id="part-using">
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
<title>Using Nixpkgs</title>
doc/using: convert to markdown
2021-04-23 09:42:08 +01:00
<xi:include href="using/configuration.chapter.xml" />
<xi:include href="using/overlays.chapter.xml" />
<xi:include href="using/overrides.chapter.xml" />
doc: Add Module System chapter start
2023-04-10 17:45:16 +01:00
</part>
<part>
<title>Nixpkgs <code>lib</code></title>
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" />
doc: Add Module System chapter start
2023-04-10 17:45:16 +01:00
<xi:include href="module-system/module-system.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>
doc: assign ids to many headings without stable ids on headings we cannot generate stable links to these headings. nrd complains about this, but the current docbook workflow does not. a few generated ids remain, mostly in examples and footnotes. most of the examples are generated by nixdoc (which has since gained MD export functions, and the MD export does generate IDs).
2023-03-27 21:39:11 +01:00
<part xml:id="part-stdenv">
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
<title>Standard environment</title>
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-02-21 07:37:40 +00:00
<xi:include href="stdenv/stdenv.chapter.xml" />
doc: Port stdenv/meta to Markdown
2021-02-21 05:50:05 +00:00
<xi:include href="stdenv/meta.chapter.xml" />
doc: Port stdenv/multiple-output to Markdown
2021-02-21 06:16:37 +00:00
<xi:include href="stdenv/multiple-output.chapter.xml" />
doc/stdenv/cross-compilation: convert to markdown
2020-11-29 13:48:45 +00:00
<xi:include href="stdenv/cross-compilation.chapter.xml" />
doc/stdenv/platform-notes: convert to markdown
2020-12-14 19:07:47 +00:00
<xi:include href="stdenv/platform-notes.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>
doc: assign ids to many headings without stable ids on headings we cannot generate stable links to these headings. nrd complains about this, but the current docbook workflow does not. a few generated ids remain, mostly in examples and footnotes. most of the examples are generated by nixdoc (which has since gained MD export functions, and the MD export does generate IDs).
2023-03-27 21:39:11 +01:00
<part xml:id="part-builders">
doc: move fetchers and trivial builders under builders
2019-10-20 12:34:32 +01:00
<title>Builders</title>
Convert fetchers from DocBook to CommonMark
2020-12-16 17:36:46 +00:00
<xi:include href="builders/fetchers.chapter.xml" />
Convert trivial-builders from DocBook to CommonMark
2020-12-13 18:44:53 +00:00
<xi:include href="builders/trivial-builders.chapter.xml" />
doc: move testers to their own chapter
2022-04-20 19:26:52 +01:00
<xi:include href="builders/testers.chapter.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" />
postgresqlTestHook: init
2022-04-16 16:17:46 +01:00
<xi:include href="hooks/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
<xi:include href="languages-frameworks/index.xml" />
nixpkgs manual: move builders into one folder
2019-10-30 09:41:25 +00: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 11:17:58 +01:00
</part>
doc: assign ids to many headings without stable ids on headings we cannot generate stable links to these headings. nrd complains about this, but the current docbook workflow does not. a few generated ids remain, mostly in examples and footnotes. most of the examples are generated by nixdoc (which has since gained MD export functions, and the MD export does generate IDs).
2023-03-27 21:39:11 +01:00
<part xml:id="part-contributing">
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
<title>Contributing to Nixpkgs</title>
doc/contributing/*.xml: Convert to markdown
2021-04-23 05:46:02 +01:00
<xi:include href="contributing/quick-start.chapter.xml" />
<xi:include href="contributing/coding-conventions.chapter.xml" />
doc: Rename submitting-changes to chapter
2020-12-05 11:33:00 +00:00
<xi:include href="contributing/submitting-changes.chapter.xml" />
documentation: Add content about Vulnerability roundups Signed-off-by: Pamplemousse <xav.maso@gmail.com>
2021-03-15 19:17:28 +00:00
<xi:include href="contributing/vulnerability-roundup.chapter.xml" />
doc/contributing/*.xml: Convert to markdown
2021-04-23 05:46:02 +01:00
<xi:include href="contributing/reviewing-contributions.chapter.xml" />
<xi:include href="contributing/contributing-to-documentation.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>
* 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>
Copy permalink