[ Main Table Of Contents | Table Of Contents | Keyword Index ]

teapot-glossary(n) 1.0 tpm "TEA Package Management"

NAME

teapot-glossary - Glossary of Terms

    TABLE OF CONTENTS
    DESCRIPTION
    Workflows
        Package developer
        Package user
    SEE ALSO
    KEYWORDS
    COPYRIGHT

DESCRIPTION

This document provides a central glossary of terms used throughout the documentation of the TEA package management, and their definitions.

repository

A repository is a collection of packages and their meta data. Repositories can be classified according to their

Internal structure: opaque vs. transparent.
Location (relative to a tool using it): local vs. remote.
Type of access: filesystem vs. network.
Type of use by a tool: archive vs. installation.

opaque repository

An opaque repository is repository whose internal structure is not disclosed to the users.

transparent repository

A transparent repository is repository whose internal structure is

publicly documented and acessible to users, and
specified such that a tcl shell can directly load packages which have been stored in the repository.

local repository

A local repository is a repository which is accessible to a tool through the filesystem of the host the tool is executed on. In other words, this is equivalent to a filesystem repository.

remote repository

A remote repository is a repository which is accessible to a tool through the network. In other words, this is equivalent to a network repository.

filesystem repository

See local repository.

network repository

See remote repository.

installation

installation repository

An installation is a repository where a person puts the packages which should be automatically used by the tcl shells that person has access to. The above implies that installations are transparent repositories, as otherwise a tcl shell has no documented way of accessing and loading the packages in the repository.

Installations are managed by the repository client. By default this application sets up a standard installation in the directory "~/.teapot/repository", however other installations can be accessed as well, by overriding the default through command line options. Take note that the client is restricted to the handling of local installations, as implied by the previous sentence.

archive

archive repository

An archive is a repository where a person or organization stores packages and their meta-data for distribution to and access by users of said packages,

The repository client retrieves the packages a user wishes to put into an installation from a set of archives configured beforehand.

teacup

client

repository client

The application for the management of installations, retrieving and installing the requested packages from archives.

teapot

server

demon

repository server

repository demon

The application for the export of opaque local repositories as network repositories.

admin-client

teapot-admin

The application for the administrative management of opaque local repositories.

Workflows

The system currently considers only two flows, for developers and users of packages.

Package developer

               (1)           (2)
+---------+    +--------+    +--------+    /------------\ 
| Develop | -> | Build  | -> | Upload | -> | Repository |
| Code    |    | TM/Zip |    | TM/Zip |    |            |
+---------+    +--------+    +--------+    \------------/

Step (1) is handled by teapot-pkggen, and step (2) by teastir. The repository is local and opaque.

Package user

                (3)            (4)             
/---------\    +----------+    +---------+    /--------------\    +--------+
| Archive | -> | Retrieve | -> | Unpack& | -> | Installation | -> | Run    |
|         |    | TM/Zip   |    | Install |    |              |    | Script |
\---------/    +----------+    +---------+    \--------------/    +--------+

Steps (3) and (4) are both handled by teacup . The installation repository is local and transparent.

KEYWORDS

TEA , TEAPOT , glossary , package management , terms