| 315 |
dpurdie |
1 |
#-------------------------------------------------------------------------------
|
|
|
2 |
# Documentation
|
|
|
3 |
#
|
|
|
4 |
|
|
|
5 |
=pod
|
|
|
6 |
|
| 361 |
dpurdie |
7 |
=for htmltoc CORE::
|
|
|
8 |
|
| 315 |
dpurdie |
9 |
=head1 NAME
|
|
|
10 |
|
|
|
11 |
Package Storage Archives used by JATS
|
|
|
12 |
|
|
|
13 |
=head1 SYNOPSIS
|
|
|
14 |
|
|
|
15 |
Package archives are repositories for Packages that have been built by JATS.
|
|
|
16 |
There are six types of package archive, as shown below together with the
|
|
|
17 |
search order.
|
|
|
18 |
|
|
|
19 |
=over
|
|
|
20 |
|
| 361 |
dpurdie |
21 |
=item 1
|
| 315 |
dpurdie |
22 |
|
| 361 |
dpurdie |
23 |
L<sandbox_archive> (User current sandbox)
|
| 315 |
dpurdie |
24 |
|
| 361 |
dpurdie |
25 |
=item 2
|
| 315 |
dpurdie |
26 |
|
| 361 |
dpurdie |
27 |
L<local dpkg_archive|local_dpkg_archive> (User local store)
|
| 315 |
dpurdie |
28 |
|
| 361 |
dpurdie |
29 |
=item 3
|
| 315 |
dpurdie |
30 |
|
| 361 |
dpurdie |
31 |
L<dpkg_archive_cache> (Machine local cache)
|
| 315 |
dpurdie |
32 |
|
| 361 |
dpurdie |
33 |
=item 4
|
|
|
34 |
|
|
|
35 |
L<dpkg_archive> (Site repository)
|
|
|
36 |
|
|
|
37 |
=item 5
|
|
|
38 |
|
|
|
39 |
L<deploy_archive> (Site repository)
|
|
|
40 |
|
|
|
41 |
=item 6
|
|
|
42 |
|
|
|
43 |
L<dpkg_archive_store> (Global repository)
|
|
|
44 |
|
| 315 |
dpurdie |
45 |
=back
|
|
|
46 |
|
|
|
47 |
These are detailed in the following sections.
|
|
|
48 |
|
| 361 |
dpurdie |
49 |
=over 4
|
| 315 |
dpurdie |
50 |
|
| 361 |
dpurdie |
51 |
=item dpkg_archive
|
|
|
52 |
|
|
|
53 |
dpkg_archive is the common package repository. This is on a shared network drive
|
| 315 |
dpurdie |
54 |
and as such affects the build speed. JATS supports three mechanisms to supplement
|
|
|
55 |
dpkg_archive, as described below.
|
|
|
56 |
|
| 361 |
dpurdie |
57 |
This archive is mandatory. Its location if specified by the EnvVar L<GBE_DPKG>.
|
| 315 |
dpurdie |
58 |
|
| 361 |
dpurdie |
59 |
=item deploy archive
|
| 315 |
dpurdie |
60 |
|
| 361 |
dpurdie |
61 |
deploy_archive is the common package repository for deployable packages and
|
| 315 |
dpurdie |
62 |
is similar to dpkg_archive.
|
|
|
63 |
|
| 361 |
dpurdie |
64 |
This archive is optional. Its location if specified by the EnvVar L<GBE_DPLY>.
|
| 315 |
dpurdie |
65 |
|
| 361 |
dpurdie |
66 |
=for htmlclass Note
|
| 315 |
dpurdie |
67 |
|
| 361 |
dpurdie |
68 |
Note: Use of the deploy_archive has been deprecated. It is now the same as
|
|
|
69 |
dpkg_archive.
|
| 315 |
dpurdie |
70 |
|
| 361 |
dpurdie |
71 |
=item sandbox archive
|
|
|
72 |
|
|
|
73 |
sandbox_archive is the common package repository for packages that are
|
|
|
74 |
being built within a jats 'L<Sandbox|TOOLS::jats_sandbox>'. It is used to store
|
|
|
75 |
the packages generated by all builds within a sandbox.
|
|
|
76 |
|
| 315 |
dpurdie |
77 |
This archive location will be determined automatically by JATS. It is only
|
|
|
78 |
used with the scope of a sandbox.
|
|
|
79 |
|
| 361 |
dpurdie |
80 |
=item local dpkg_archive
|
| 315 |
dpurdie |
81 |
|
|
|
82 |
JATS supports a package archive that is local to a project or suite of build
|
| 361 |
dpurdie |
83 |
sandboxes. This is the archive used by the L<install|TOOLS::jats/"item_install"> command.
|
| 315 |
dpurdie |
84 |
|
|
|
85 |
The user does not have to do anything to access this archive. The archive is
|
|
|
86 |
located by the JATS wrapper script by scanning up the directory tree for a
|
|
|
87 |
directory called "local_dpkg_archive". If it is found then it is used as the
|
|
|
88 |
preferred source for locating archives. This allows a component to be tested
|
|
|
89 |
with a "local" or "fixed" version of another package, before an official
|
|
|
90 |
release is made.
|
|
|
91 |
|
|
|
92 |
A local archive may be shared by members of a team by setting the environment
|
| 361 |
dpurdie |
93 |
variable L<GBE_DPKG_LOCAL> to the location of a shared drive.
|
| 315 |
dpurdie |
94 |
|
| 361 |
dpurdie |
95 |
=for htmlclass Note
|
| 315 |
dpurdie |
96 |
|
| 4003 |
dpurdie |
97 |
Note: This type of archive is being deprecated for normal development in favour
|
| 361 |
dpurdie |
98 |
of the 'L<Sandbox|TOOLS::jats_sandbox>' Archive.
|
| 315 |
dpurdie |
99 |
|
| 361 |
dpurdie |
100 |
=item dpkg_archive cache
|
|
|
101 |
|
| 315 |
dpurdie |
102 |
JATS supports a package caching mechanism to reduce network utilization. If
|
| 361 |
dpurdie |
103 |
the user specified L<GBE_DPKG_CACHE> exists then that archive is treated as a
|
| 315 |
dpurdie |
104 |
cache archive. The various JATS tools work together to maintain the cache.
|
|
|
105 |
|
|
|
106 |
This cache must be setup by the user.
|
|
|
107 |
|
| 361 |
dpurdie |
108 |
=item dpkg_archive store
|
| 315 |
dpurdie |
109 |
|
|
|
110 |
JATS supports a global, read-only, package distribution mechanism. If
|
| 361 |
dpurdie |
111 |
the user specified L<GBE_DPKG_STORE> exists then that archive is treated as a
|
| 315 |
dpurdie |
112 |
global store. The store archive will be searched after all other archives.
|
|
|
113 |
|
|
|
114 |
A global store may be used by members of a global team, in a situation in
|
|
|
115 |
which the store is rsync'ed from a central repository.
|
|
|
116 |
|
| 361 |
dpurdie |
117 |
=back
|