diff options
author | Ciaran McCreesh <ciaran.mccreesh@googlemail.com> | 2009-04-11 20:48:43 +0100 |
---|---|---|
committer | Ciaran McCreesh <ciaran.mccreesh@googlemail.com> | 2009-04-23 23:56:39 +0100 |
commit | ef961a6f9b91fc0e4ff41da84a3f92888c13d116 (patch) | |
tree | e6e038a62f21526db08fd65a4dd92f0b1e0ac170 /metadata-cache.tex | |
parent | Move EAPI definitions into its own chapter. (diff) | |
download | pms-ef961a6f9b91fc0e4ff41da84a3f92888c13d116.tar.gz pms-ef961a6f9b91fc0e4ff41da84a3f92888c13d116.tar.bz2 pms-ef961a6f9b91fc0e4ff41da84a3f92888c13d116.zip |
Move metadata cache into its own chapter.
Also clarify that the cache can contain bogus entries or be incomplete.
Diffstat (limited to 'metadata-cache.tex')
-rw-r--r-- | metadata-cache.tex | 51 |
1 files changed, 51 insertions, 0 deletions
diff --git a/metadata-cache.tex b/metadata-cache.tex new file mode 100644 index 0000000..60186c0 --- /dev/null +++ b/metadata-cache.tex @@ -0,0 +1,51 @@ +\chapter{Metadata Cache} +\label{metadata-cache} + +\section{Directory Contents} + +The \t{profiles/metadata/cache} directory, if it exists, contains directories whose names are the +same as categories in the repository. Each subdirectory may optionally contain one file per package +version in that category, named \t{<package>-<version>}, in the format described below. + +The metadata cache may be incomplete or non-existent, and may contain additional bogus entries. + +\section{Cache File Format} + +Each cache file contains the textual values of various metadata keys, one per line, in the following +order. Other lines may be present following these; their meanings are not defined here. + +\begin{compactenum} +\item Build-time dependencies (\t{DEPEND}) +\item Run-time dependencies (\t{RDEPEND}) +\item Slot (\t{SLOT}) +\item Source tarball URIs (\t{SRC\_URI}) +\item \t{RESTRICT} +\item Package homepage (\t{HOMEPAGE}) +\item Package license (\t{LICENSE}) +\item Package description (\t{DESCRIPTION}) +\item Package keywords (\t{KEYWORDS}) +\item Inherited eclasses (\t{INHERITED}) +\item Use flags that this package respects (\t{IUSE}) +\item No longer used; this line is to be ignored. +\item Post dependencies (\t{PDEPEND}) +\item Old-style virtuals provided by this package (\t{PROVIDE}) +\item The ebuild API version to which this package conforms (\t{EAPI}) +\item Properties (\t{PROPERTIES}). In some EAPIs, may optionally be blank, regardless of ebuild + metadata; see table~\ref{tab:properties-table}. +\item Defined phases (\t{DEFINED\_PHASES}). In some EAPIs, may optionally be blank, regardless of + ebuild metadata; see table~\ref{tab:defined-phases-table}. +\item Blank lines to pad the file to 22 lines long +\end{compactenum} + +Future EAPIs may define new variables, remove existing variables, change the line number or +format used for a particular variable, add or reduce the total length of the file and so on. +Any future EAPI that uses this cache format will continue to place the EAPI value on +line 15 if such a concept makes sense for that EAPI, and will place a value that is clearly +not a supported EAPI on line 15 if it does not. + +% vim: set filetype=tex fileencoding=utf8 et tw=100 spell spelllang=en : + +%%% Local Variables: +%%% mode: latex +%%% TeX-master: "pms" +%%% End: |