pristine-tar

Langue: en

Version: 2009-01-22 (ubuntu - 07/07/09)

Section: 1 (Commandes utilisateur)

NAME

pristine-tar - regenerate pristine tarballs

SYNOPSIS

pristine-tar [-vdk] gentar delta tarball

pristine-tar [-vdk] gendelta tarball delta

pristine-tar [-vdk] [-m message] commit tarball [upstream]

pristine-tar [-vdk] checkout tarball

DESCRIPTION

pristine-tar can regenerate a pristine upstream tarball using only a small binary delta file and a revision control checkout of the upstream branch.

The delta file is designed to be checked into revision control along-side the upstream branch, thus allowing Debian packages to be built entirely using sources in revision control, without the need to keep copies of upstream tarballs.

pristine-tar supports compressed tarballs, calling out to pristine-gz(1) and pristine-bz2(1) to produce the pristine gzip and bzip2 files.

COMMANDS

pristine-tar gendelta
This takes the specified upstream tarball, and generates a small binary delta file that can later be used by pristine-tar gentar to recreate the tarball.

If the delta filename is ``-'', it is written to standard output.

pristine-tar gentar
This takes the specified delta file, and the files in the current directory, which must have identical content to those in the upstream tarball, and uses these to regenerate the pristine upstream tarball.

If the delta filename is ``-'', it is read from standard input.

pristine-tar commit
pristine-tar commit generates a pristine-tar delta file for the specified tarball, and commits it to version control. The pristine-tar checkout command can later be used to recreate the original tarball based only on the information stored in version control.

For pristine-tar checkout to work, you also need to store the precise contents of the tarball in version control. To specify in which tag (or branch or other treeish object) it's stored, use the upstream parameter. This defaults to ``refs/heads/upstream'', or if there's no such branch, any branch matching ``upstream''. The name of the tree it points to will be recorded for later use by pristine-tar checkout.

The delta files are stored in a branch named ``pristine-tar'', with filenames corresponding to the input tarball, with ``.delta'' appended. This branch is created or updated as needed to add each new delta.

pristine-tar checkout
This regenerates a copy of the specified tarball using information previously saved to revision control by pristine-tar commit.

OPTIONS

-v
--verbose
Verbose mode, show each command that is run.
-d
--debug
Debug mode.
-k
--keep
Don't clean up the temporary directory on exit.
-m message
--message=message
Use this option to specify a custom commit message to pristine-tar commit.

LIMITATIONS

Only tarballs, gzipped tarballs, and bzip2ed tarballs are currently supported.

It could fail on certain spectacularly strange files. If it fails, it will fail during creation of the delta, since the delta is tested to make sure it reproduces the pristine tarball.

Currently only the git revision control system is supported by the ``checkout'' and ``commit'' commands. It's ok if the working copy is not clean or has uncommitted changes, or has changes staged in the index; none of that will be touched by ``checkout'' or ``commit''.

AUTHOR

Joey Hess <joeyh@debian.org>

Licensed under the GPL, version 2 or above.