aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Danny van Dyk <dvandyk@exherbo.org> 2006-08-12 20:46:09 +0000
committerAvatar Danny van Dyk <dvandyk@exherbo.org> 2006-08-12 20:46:09 +0000
commit29c68cdf0c4be9a75a5600b8e30e9e018f75c8aa (patch)
tree813f48556a2a41c9fb8cd1254a983c2dd3babc66
parentfc8698f50181d98a06cad43a6338e50ca32fa81a (diff)
downloadpaludis-29c68cdf0c4be9a75a5600b8e30e9e018f75c8aa.tar.gz
paludis-29c68cdf0c4be9a75a5600b8e30e9e018f75c8aa.tar.xz
Update configuration files documentation for CRAN repositories.
-rw-r--r--doc/doc_configuration_files.doxygen21
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/doc_configuration_files.doxygen b/doc/doc_configuration_files.doxygen
index ab594fb..a174ad1 100644
--- a/doc/doc_configuration_files.doxygen
+++ b/doc/doc_configuration_files.doxygen
@@ -209,6 +209,27 @@ The following keys are available for <code>format = nothing</code>:
- <code>location</code> (mandatory).
- <code>sync</code> (default: empty), as per <code>format = portage</code>.
- <code>sync_exclude</code> (default: empty), idem.
+
+\subsection ConfigurationFilesRepositoriesCRAN CRAN Format Repositories
+
+The following keys are available for <code>format = cran</code>:
+
+- <code>buildroot</code> (default: <code>/var/tmp/paludis</code>), which controls
+ the temporary directory used by Paludis for compiling software.
+- <code>distdir</code> (default: <code>${location}/distfiles</code>), which
+ controls where downloaded files are saved.
+- <code>library</code> (mandatory), which should be set to <code>${ROOT}/usr/${libdir}/R/library</code>, unless
+you know what you do.
+- <code>location</code> (mandatory), which points to the location of the CRAN tree.
+- <code>sync</code> (default: empty), as per <code>format = portage</code>.
+
+\subsection ConfigurationFilesRepositoriesCRANInstalled CRAN Installed Format Repositories
+
+The following keys are available for <code>format = cran_installed</code>:
+
+- <code>location</code> (mandator>, which should be set to <code>${ROOT}/usr/${libdir}/R/library</code>, unless
+you know what you do. This must point to the same directory as <code>library</code> for <code>format = cran</code>.
+
*/