summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorStephen Bennett <spb@gentoo.org>2006-12-31 00:01:54 +0000
committerStephen Bennett <spb@gentoo.org>2006-12-31 00:01:54 +0000
commitc278fce2884447b0b27a053e9b74a646a901ff0f (patch)
tree162f53b7dfb47288ba12664ac030357e878e4840 /introduction.tex
parentCategory dirs, package dirs, the beginning of profiles/ (diff)
downloadpms-c278fce2884447b0b27a053e9b74a646a901ff0f.tar.gz
pms-c278fce2884447b0b27a053e9b74a646a901ff0f.tar.bz2
pms-c278fce2884447b0b27a053e9b74a646a901ff0f.zip
A load more stuff.
git-svn-id: http://svn.repogirl.net/pms/trunk@6 a05a4626-2124-0410-b604-e6c5abf33261
Diffstat (limited to 'introduction.tex')
-rw-r--r--introduction.tex19
1 files changed, 19 insertions, 0 deletions
diff --git a/introduction.tex b/introduction.tex
index e076bbc..a3e7020 100644
--- a/introduction.tex
+++ b/introduction.tex
@@ -1,4 +1,23 @@
\chapter{Introduction}
+\section{Aims and Motivation}
+This document aims to document fully the format of an ebuild repository and the ebuilds therein, as
+well as certain aspects of package manager behaviour required to support such a repository. The
+reason is simple: at present the only definition of what an ebuild can assume about its environment,
+the only definition of what is valid in an ebuild, is the source code of the latest Portage release
+and a general consensus about which features are too new to assume availability. This has several
+drawbacks: not only is it impossible to change any aspect of Portage behaviour without verifying
+that nothing in the tree relies upon it, but if a new package manager should appear it becomes
+impossible to fully support such an ill-defined standard. This document aims to address both of
+these concerns by defining almost all aspects of what an ebuild repository looks like, and how an
+ebuild is allowed to behave. Thus, both Portage and other package managers can change aspects of
+their behaviour not defined here without worry of incompatibilities with any particular repository.
+
+\section{Conventions}
+Text in \t{teletype} is used for filenames or variable names. \e{Italic} text is used for terms
+whose meaning may not be obvious to someone without specific prior knowledge, though a good
+knowledge of ebuild development is assumed throughout. Most of these terms are explained in the
+Glossary in chapter \ref{glossary}.
+
% vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en :