Subversion Repositories DevTools

Rev

Rev 315 | Rev 4003 | Go to most recent revision | Show entire file | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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