1 |
-----BEGIN PGP SIGNED MESSAGE----- |
2 |
Hash: SHA1 |
3 |
|
4 |
The worms... the worms they are everywhere.... why did you open the can? |
5 |
|
6 |
Scroll down |
7 |
|
8 |
On 04/12/2013 02:21 PM, W. Trevor King wrote: |
9 |
> From: "W. Trevor King" <wking@×××××××.us> |
10 |
> |
11 |
> This mostly translates the inline comments from files/catalyst.conf |
12 |
> into asciidoc. While it's nice to have that as stand-alone |
13 |
> documentation, it also makes it easier to refer to longer descriptions |
14 |
> of any tricky issues. This gives us a place to distill the collected |
15 |
> wisdom of current users for the benefit of others. |
16 |
> --- |
17 |
> doc/catalyst-config.5.txt | 188 ++++++++++++++++++++++++++++++++++++++++++++++ |
18 |
> doc/catalyst-spec.5.txt | 2 +- |
19 |
> doc/catalyst.1.txt | 1 + |
20 |
> files/.gitignore | 1 + |
21 |
> 4 files changed, 191 insertions(+), 1 deletion(-) |
22 |
> create mode 100644 doc/catalyst-config.5.txt |
23 |
> |
24 |
> diff --git a/doc/catalyst-config.5.txt b/doc/catalyst-config.5.txt |
25 |
> new file mode 100644 |
26 |
> index 0000000..944f392 |
27 |
> --- /dev/null |
28 |
> +++ b/doc/catalyst-config.5.txt |
29 |
> @@ -0,0 +1,188 @@ |
30 |
> +CATALYST-CONFIG(5) |
31 |
> +================ |
32 |
> +:man source: catalyst {catalystversion} |
33 |
> +:man manual: catalyst {catalystversion} |
34 |
> + |
35 |
> + |
36 |
> +NAME |
37 |
> +---- |
38 |
> +catalyst-config - Catalyst configuration files |
39 |
> + |
40 |
> + |
41 |
> +SYNOPSIS |
42 |
> +-------- |
43 |
> +*catalyst* ['OPTIONS'] *-c* 'FILE' |
44 |
> + |
45 |
> + |
46 |
> +DESCRIPTION |
47 |
> +----------- |
48 |
> + |
49 |
> +*catalyst(1)* reads the configuration file given with `-c` or |
50 |
> +`--config` on the command line. The file contains keyword-argument |
51 |
> +pairs using a POSIX Shell variable syntax. Lines starting with `#` |
52 |
> +and empty lines are interpreted as comments. For example: |
53 |
> + |
54 |
> +--------------------------------- |
55 |
> +# /etc/catalyst/catalyst.conf |
56 |
> +digests="md5 sha1 sha512 whirlpool" |
57 |
> +contents="auto" |
58 |
> +distdir="/usr/portage/distfiles" |
59 |
> +envscript="/etc/catalyst/catalystrc" |
60 |
> +options="autoresume bindist kerncache pkgcache seedcache snapcache" |
61 |
> +portdir="/usr/portage" |
62 |
> +sharedir="/usr/lib/catalyst" |
63 |
> +snapshot_cache="/var/tmp/catalyst/snapshot_cache" |
64 |
> +storedir="/var/tmp/catalyst" |
65 |
> +--------------------------------- |
66 |
> + |
67 |
> +The possible keywords and their meanings are as follows: |
68 |
> + |
69 |
> +Basic configuration |
70 |
> +~~~~~~~~~~~~~~~~~~~ |
71 |
> + |
72 |
> +*digests*:: |
73 |
> +Create a `.DIGESTS` file containing the hash output from any of the |
74 |
> +supported options below. Adding them all may take a long time. |
75 |
> +(example: `md5 sha1 sha512 whirlpool`). See the *SUPPORTED HASHES* |
76 |
> +section for a list of supported hashes. |
77 |
> + |
78 |
> +*contents*:: |
79 |
> +Create a `.CONTENTS` file listing the contents of the file. If this |
80 |
> +variable is empty, no `.CONTENTS` will be generated at all. Supported |
81 |
> +values: |
82 |
> ++ |
83 |
> +-- |
84 |
> +auto:: |
85 |
> +Strongly recommended |
86 |
> + |
87 |
> +tar-tv:: |
88 |
> +Do `tar tvf FILE` |
89 |
> + |
90 |
> +tar-tvz:: |
91 |
> +Do `tar tvzf FILE` |
92 |
> + |
93 |
> +tar-tvy:: |
94 |
> +Do `tar tvyf FILE` |
95 |
> + |
96 |
> +isoinfo-l:: |
97 |
> +Do `isoinfo -l -i FILE` |
98 |
> + |
99 |
> +isoinfo-f:: |
100 |
> +Do `isoinfo -f -i FILE`. 'isoinfo-f' is the only option not chosen |
101 |
> +by the automatic algorithm. |
102 |
> +-- |
103 |
> + |
104 |
> +*distdir*:: |
105 |
> +Distfiles location. `/usr/portage/distfiles` should work for most |
106 |
> +default installations. |
107 |
> + |
108 |
> +*envscript*:: |
109 |
> +Environment script location, which allows users to set options such as |
110 |
> +HTTP proxies, `MAKEOPTS`, `GENTOO_MIRRORS`, or any other environment |
111 |
> +variables needed for building. The envscript file sets environment |
112 |
> +variables using POSIX shell notation: |
113 |
> ++ |
114 |
> +--------------------------------- |
115 |
> +export FOO="bar" |
116 |
> +--------------------------------- |
117 |
> + |
118 |
> +*hash_function*:: |
119 |
> +Internal hash function catalyst should use for things like autoresume, |
120 |
> +seedcache, etc. The default and fastest is `crc32`. You should not |
121 |
> +ever need to change this unless your OS does not support it. See the |
122 |
> +*SUPPORTED HASHES* section for a list of supported hashes. |
123 |
> + |
124 |
> +**options*:: |
125 |
> +Set different build-time options (example: `autoresume bindist |
126 |
> +kerncache pkgcache seedcache snapcache`). Supported values: |
127 |
> ++ |
128 |
> +-- |
129 |
> +autoresume:: |
130 |
> +Attempt to resume a failed build. Clear the autoresume flags with the |
131 |
> +`-a` option to the catalyst command line. `-p` will clear the |
132 |
> +autoresume flags as well as your pkgcache and kerncache. |
133 |
> + |
134 |
> +bindist:: |
135 |
> +Enable the `bindist` `USE` flag. This is recommended if you will be |
136 |
> +redistributing builds, but see the package specific definitions for |
137 |
> +details. |
138 |
> + |
139 |
> +ccache:: |
140 |
> +Enable build time ccache support. |
141 |
Warning, ccache has been known to cause random build failures and bugs |
142 |
reported with ccache enabled may be closed invalid. |
143 |
> + |
144 |
> +distcc:: |
145 |
> +Enable distcc support for building. You have to set distcc_hosts in |
146 |
> +your spec file. |
147 |
> + |
148 |
> +icecream:: |
149 |
> +Enable icecream compiler cluster support for building. |
150 |
> + |
151 |
> +kerncache:: |
152 |
> +Keep a `tbz2` of your built kernel and modules. This is useful if |
153 |
> +your build dies during `livecd-stage2`. |
154 |
kerncache keeps a full dir of everything like seedcache does. |
155 |
> + |
156 |
> +pkgcache:: |
157 |
> +Keep a ``tbz2`` of every built package. This is useful if your build |
158 |
> +dies prematurely. |
159 |
Might be easier to just say this enables the binpkg feature of portage... |
160 |
|
161 |
|
162 |
- -ZC |
163 |
> + |
164 |
> +seedcache:: |
165 |
> +Use the build output of a previous target if it exists to speed up the |
166 |
> +creation of a new stage. This avoids unpacking the seed tarball. |
167 |
> + |
168 |
> +snapcache:: |
169 |
> +Cache the snapshot so that it can be bind-mounted into the chroot. |
170 |
> +WARNING: moving parts of the portage tree from within fsscript *will* |
171 |
> +break your cache. The cache is unlinked before any empty or rm |
172 |
> +processing, though. |
173 |
- -, though |
174 |
> +-- |
175 |
> + |
176 |
> +*portdir*:: |
177 |
> +Portage tree location. `/usr/portage/` should work for most default |
178 |
> +installations. |
179 |
> + |
180 |
> +*sharedir*:: |
181 |
> +Catalyst runtime script location. `/usr/lib/catalyst` should work for |
182 |
> +most default installations. If you are running catalyst from a Git |
183 |
> +checkout, you should change this to point to your checkout directory. |
184 |
> + |
185 |
> +*storedir*:: |
186 |
> +Location for built seeds, temporary files, and caches. |
187 |
mention the default location |
188 |
> + |
189 |
> +*port_logdir*:: |
190 |
> +Location for build logs (example: `/var/tmp/catalyst/tmp`). This dir |
191 |
> +will be automatically cleaned of all logs over 30 days old. If left |
192 |
> +undefined the logs will remain in the build directory as usual and get |
193 |
> +cleaned every time a stage build is restarted. |
194 |
> + |
195 |
> +*var_tmpfs_portage*:: |
196 |
> +Set the size of a `/var/tmp/portage` tmpfs in gigabytes (example: |
197 |
> +`16`). If set, this mounts a tmpfs for `/var/tmp/portage` so building |
198 |
> +takes place in RAM. This feature requires a pretty large tmpfs |
199 |
> +({open,libre}office needs ~8GB to build). WARNING: If you use too |
200 |
> +much RAM everything will fail horribly and it is not our fault. |
201 |
> + |
202 |
> + |
203 |
> +SUPPORTED HASHES |
204 |
> +---------------- |
205 |
> +Supported hashes: adler32, crc32, crc32b, gost, haval128, haval160, |
206 |
> +haval192, haval224, haval256, md2, md4, md5, ripemd128, ripemd160, |
207 |
> +ripemd256, ripemd320, sha1, sha224, sha256, sha384, sha512, snefru128, |
208 |
> +snefru256, tiger, tiger128, tiger160, whirlpool. |
209 |
> + |
210 |
> + |
211 |
> +FILES |
212 |
> +----- |
213 |
> +An example configuration file can be found at |
214 |
> +`/etc/catalyst/catalyst.conf`. |
215 |
> + |
216 |
> + |
217 |
> +BUGS |
218 |
> +---- |
219 |
> +An up-to-date list of Catalyst bugs can always be found listed on the Gentoo |
220 |
> +Linux bug-tracking system at `http://bugs.gentoo.org`. |
221 |
> + |
222 |
> + |
223 |
> +SEE ALSO |
224 |
> +-------- |
225 |
> +*catalyst(1)* |
226 |
> +*catalyst-config(5)* |
227 |
> diff --git a/doc/catalyst-spec.5.txt b/doc/catalyst-spec.5.txt |
228 |
> index 4a6e06c..b3e2bf5 100644 |
229 |
> --- a/doc/catalyst-spec.5.txt |
230 |
> +++ b/doc/catalyst-spec.5.txt |
231 |
> @@ -496,7 +496,6 @@ specific options for the game. This is not used on the release media. |
232 |
> FILES |
233 |
> ----- |
234 |
> Example specfiles can be found in '/usr/share/doc/catalyst-{catalystversion}/examples'. |
235 |
> -An example configuration file can be found at '/etc/catalyst/catalyst.conf'. |
236 |
> |
237 |
> |
238 |
> SUPPORTED ARCHITECTURES |
239 |
> @@ -516,3 +515,4 @@ Linux bug-tracking system at 'http://bugs.gentoo.org'. |
240 |
> SEE ALSO |
241 |
> -------- |
242 |
> *catalyst(1)* |
243 |
> +*catalyst-config(5)* |
244 |
> diff --git a/doc/catalyst.1.txt b/doc/catalyst.1.txt |
245 |
> index 4d51eb0..09dc119 100644 |
246 |
> --- a/doc/catalyst.1.txt |
247 |
> +++ b/doc/catalyst.1.txt |
248 |
> @@ -136,6 +136,7 @@ AUTHORS |
249 |
> SEE ALSO |
250 |
> -------- |
251 |
> *catalyst-spec(5)* |
252 |
> +*catalyst-config(5)* |
253 |
> |
254 |
> Also, a more in-depth examination of Catalyst options and procedures can be found |
255 |
> linked from the *catalyst* project page, which is located at |
256 |
> diff --git a/files/.gitignore b/files/.gitignore |
257 |
> index 9dbf1f1..7773aeb 100644 |
258 |
> --- a/files/.gitignore |
259 |
> +++ b/files/.gitignore |
260 |
> @@ -1,4 +1,5 @@ |
261 |
> catalyst.1 |
262 |
> +catalyst-config.5 |
263 |
> catalyst-spec.5 |
264 |
> *.html |
265 |
> *.css |
266 |
> |
267 |
|
268 |
-----BEGIN PGP SIGNATURE----- |
269 |
Version: GnuPG v2.0.19 (GNU/Linux) |
270 |
Comment: Using GnuPG with Thunderbird - http://www.enigmail.net/ |
271 |
|
272 |
iQIcBAEBAgAGBQJRaFaoAAoJEKXdFCfdEflKC2sP+wS1f4RlU0WAKBzocF1cJKh1 |
273 |
Xd4RaxOruDUkOPvtHNvMMmwgSaZD0iiYmGnUZEG5lYEfIIA9wlqGrYHzpL/Mtbvv |
274 |
iKTYNPtZycfVvtSE2UEC9BhPQe3+VzjqrB4Rs1utdAfCvgYjRTNiOutcHyyr1kWz |
275 |
G1su+g2dMX7FFb29gfm0kRoYBdwi8XSep62QLoAvEMGRPkM10jo3sFIqb4RWDG1r |
276 |
XajCEgNFxvrAy7HV1HOLgFg8Oq7N60aJAZQLc353EMHzmCT0K7t+/2Bg8Rl1AH5j |
277 |
Gnwj1lol5tvfu76MHDTZeykZFln53S9BoewM0RlHqIT1sfIywwxLl/kh/z5z44K8 |
278 |
at1NvnLAllE/tiR99ovaeTUlMPTigoLuuIOqH5gPAdVETQ3cQEhskSWYlc7wKZcs |
279 |
SU28aa1xcUwdhPaNhplyNaf+VHp8PJPkHUeeItafFGw8Hn7J2angrS5ouOPjRBHh |
280 |
MG6usDIjRxhJGgCrV28dXksYxCSocmFEO6npuZe8rGkP6k7uLt3di/wt5lsQWdCq |
281 |
gNtaiYKrnb1u6oWwZJHZdNF9jU9pjoQjBRYkkbn/3N9ItrxUHO+5+Yz1FFV3q7Bs |
282 |
B+NuxstRLC1imrsz9nHsp0XMkk9p+Un6xUIRvOP8LRRrmdUvwFooClH6vyPasG7C |
283 |
WnvzbEV0y+xr02Lmdpv7 |
284 |
=Ly6k |
285 |
-----END PGP SIGNATURE----- |