* Added a glossary to the manual.

This commit is contained in:
Eelco Dolstra 2005-04-01 15:34:23 +00:00
parent 6f788880b6
commit 4a83c12c5d
4 changed files with 82 additions and 7 deletions

View file

@ -18,7 +18,8 @@ MANUAL_SRCS = manual.xml introduction.xml installation.xml \
build-farm.xml \ build-farm.xml \
$(man1_MANS:.1=.xml) \ $(man1_MANS:.1=.xml) \
troubleshooting.xml bugs.xml opt-common.xml opt-common-syn.xml \ troubleshooting.xml bugs.xml opt-common.xml opt-common-syn.xml \
env-common.xml quick-start.xml nix-lang-ref.xml style.css images env-common.xml quick-start.xml nix-lang-ref.xml glossary.xml \
style.css images
manual.is-valid: $(MANUAL_SRCS) version.txt manual.is-valid: $(MANUAL_SRCS) version.txt
$(XMLLINT) --xinclude $< | $(XMLLINT) --noout --valid - $(XMLLINT) --xinclude $< | $(XMLLINT) --noout --valid -

79
doc/manual/glossary.xml Normal file
View file

@ -0,0 +1,79 @@
<appendix><title>Glossary</title>
<glosslist>
<glossentry><glossterm>derivation</glossterm>
<glossdef><para>A description of a build action. The result of a
derivation is a store object.</para></glossdef>
</glossentry>
<glossentry><glossterm>store</glossterm>
<glossdef><para>The location in the file system where store objects
live. Typically <filename>/nix/store</filename>.</para></glossdef>
</glossentry>
<glossentry><glossterm>store path</glossterm>
<glossdef><para>The location in the file system of a store object,
i.e., an immediate child of the Nix store
directory.</para></glossdef>
</glossentry>
<glossentry><glossterm>store object</glossterm>
<glossdef><para>A file that is an immediate child of the Nix store
directory. These can be regular files, but also entire directory
trees. Store objects can be sources (objects copied from outside of
the store), derivation outputs (objects produced by running a build
action), or derivations (files describing a build
action).</para></glossdef>
</glossentry>
<glossentry><glossterm>substitute</glossterm>
<glossdef><para>A substitute is a command invocation stored in the
Nix database that describes how to build a store object, bypassing
normal the build mechanism (i.e., derivations). Typically, the
substitute builds the store object by downloading a pre-built
version of the store object from some server.</para></glossdef>
</glossentry>
<glossentry><glossterm>purity</glossterm>
<glossdef><para>The assumption that equal Nix derivations when run
always produce the same output. This cannot be guaranteed in
general (e.g., a builder can rely on external inputs such as the
network or the system time) but the Nix model assumes
it.</para></glossdef>
</glossentry>
<glossentry><glossterm>Nix expression</glossterm>
<glossdef><para>A high-level description of software components and
compositions thereof. Deploying software using Nix entails writing
Nix expressions for your components. Nix expressions are translated
to derivations that are stored in the Nix store. These derivations
can then be built.</para></glossdef>
</glossentry>
</glosslist>
</appendix>

View file

@ -69,5 +69,6 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshooting.xml" /> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshooting.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="bugs.xml" /> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="bugs.xml" />
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="glossary.xml" />
</book> </book>

View file

@ -6,9 +6,3 @@
</para> </para>
</appendix> </appendix>
<!--
local variables:
sgml-parent-document: ("book.xml" "appendix")
end:
-->