1 |
commit: f997e53273fd214aa16536024c4e2be0dd60db72 |
2 |
Author: Brian Dolbec <dolsen <AT> gentoo <DOT> org> |
3 |
AuthorDate: Sat Mar 11 07:55:50 2017 +0000 |
4 |
Commit: Brian Dolbec <dolsen <AT> gentoo <DOT> org> |
5 |
CommitDate: Wed Nov 22 01:16:22 2017 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/catalyst.git/commit/?id=f997e532 |
7 |
|
8 |
doc/cataylst-config.5.txt: Update for the new variables |
9 |
|
10 |
doc/catalyst-config.5.txt | 56 +++++++++++++++++++++++++++++++++++++++++------ |
11 |
1 file changed, 49 insertions(+), 7 deletions(-) |
12 |
|
13 |
diff --git a/doc/catalyst-config.5.txt b/doc/catalyst-config.5.txt |
14 |
index f778a804..5c5ad293 100644 |
15 |
--- a/doc/catalyst-config.5.txt |
16 |
+++ b/doc/catalyst-config.5.txt |
17 |
@@ -24,12 +24,23 @@ and empty lines are interpreted as comments. For example: |
18 |
|
19 |
--------------------------------- |
20 |
# /etc/catalyst/catalyst.conf |
21 |
+ |
22 |
digests="auto" |
23 |
contents="auto" |
24 |
-distdir="/usr/portage/distfiles" |
25 |
envscript="/etc/catalyst/catalystrc" |
26 |
options="autoresume bindist kerncache pkgcache seedcache snapcache" |
27 |
+ |
28 |
+# source repo settings |
29 |
+distdir="/usr/portage/distfiles" |
30 |
portdir="/usr/portage" |
31 |
+ |
32 |
+# target repo info |
33 |
+repo_basedir="/usr" |
34 |
+repo_name="portage" |
35 |
+target_distdir="/usr/portage/distfiles" |
36 |
+target_pkgdir="/usr/portage/packages" |
37 |
+ |
38 |
+# other catalyst settings |
39 |
sharedir="/usr/share/catalyst" |
40 |
snapshot_cache="/var/tmp/catalyst/snapshot_cache" |
41 |
storedir="/var/tmp/catalyst" |
42 |
@@ -72,10 +83,6 @@ Do `isoinfo -f -i FILE`. 'isoinfo-f' is the only option not chosen |
43 |
by the automatic algorithm. |
44 |
-- |
45 |
|
46 |
-*distdir*:: |
47 |
-Distfiles location. `/usr/portage/distfiles` should work for most |
48 |
-default installations. |
49 |
- |
50 |
*envscript*:: |
51 |
Environment script location, which allows users to set options such as |
52 |
HTTP proxies, `MAKEOPTS`, `GENTOO_MIRRORS`, or any other environment |
53 |
@@ -140,9 +147,44 @@ break your cache. The cache is unlinked before any empty or rm |
54 |
processing. |
55 |
-- |
56 |
|
57 |
+Repository settings |
58 |
+~~~~~~~~~~~~~~~~~~~ |
59 |
+ |
60 |
+*distdir*:: |
61 |
+Source distfiles location used in generation of the stages. This is usually the |
62 |
+hosts distfiles location. `/usr/portage/distfiles` should work for most |
63 |
+default installations, but it should be set to match your hosts configuration. |
64 |
+ |
65 |
*portdir*:: |
66 |
-Portage tree location. `/usr/portage/` should work for most default |
67 |
-installations. |
68 |
+Source Gentoo tree location (primary repo). `/usr/portage/` should work for most |
69 |
+default installations. |
70 |
+ |
71 |
+*repo_basedir*:: |
72 |
+The target repository directory to contain the rimary repo (gentoo repo) and |
73 |
+any overlays. `/usr` is the historical location. But that is in the process of |
74 |
+changing. `/var/gentoo/repos` is an option. |
75 |
+ |
76 |
+*repo_name*:: |
77 |
+The name of the main repository (ie: gentoo). This has had a directory name |
78 |
+of `portage` in the past. But it has an internal name of `gentoo`, which is |
79 |
+what its directory name should be. This name is used in the snapshot name |
80 |
+generated and also the directory name of the repository created with the |
81 |
+snapshot target. The new general rule is that the directory name and its |
82 |
+internal repo_name value should be the same. |
83 |
+ |
84 |
+*target_distdir*:: |
85 |
+This is the target distfiles directory location for the stage being created. |
86 |
+This is important because this value will be stored in the stage's make.conf |
87 |
+and will become the default location used if it is not edited by users. |
88 |
+The default location is `/usr/portage/distfiles`. |
89 |
+ |
90 |
+*target_pkgdir*:: |
91 |
+This is the target packages directory for storing binpkgs in the stage being |
92 |
+built. This location is stored in the make.conf of the stage being built. |
93 |
+The default location for this has typically been `/usr/portage/packages` |
94 |
+ |
95 |
+Other settings |
96 |
+~~~~~~~~~~~~~~ |
97 |
|
98 |
*sharedir*:: |
99 |
Catalyst runtime script location. `/usr/share/catalyst` should work for |