# `gbp.scripts.export_orig` module documentation

Part of `gbp.scripts`

Create orig tarballs from git

Function | prepare_upstream_tarballs | No summary
Function | pristine_tar_prepare_orig_tree | Make sure the upstream tree exists
Function | pristine_tar_build_origs | Build orig tarball using pristine-tar
Function | pristine_tar_verify_origs | Verify orig tarballs using prstine tar
Function | maybe_pristine_tar_commit | Undocumented
Function | git_archive_get_upstream_tree | Determine the upstream tree from the given options
Function | git_archive_build_origs | Build orig tarball(s) using git-archive
Function | guess_comp_type | Guess compression type to use for the to be built upstream tarball
Function | build_parser | Undocumented
Function | parse_args | Undocumented
Function | main | Undocumented

def prepare_upstream_tarballs(repo, source, options, tarball_dir, output_dir):

Make sure we have the needed upstream tarballs. The default order is:

- look in tarball_dir and if found symlink to it
- create tarball using pristine-tar
- create tarball using git-archive

  Afterwards

- create pristine-tar commmits if pristine-tar-commit is in use
- verify tarball checksums if pristine-tar is in use

def pristine_tar_prepare_orig_tree(repo, source, options):

Make sure the upstream tree exists

In case of component tarballs we need to recreate a tree for the main tarball without the component subdirs.

def pristine_tar_build_origs(repo, source, output_dir, options):

Build orig tarball using pristine-tar

Returns | `True` if tarball was build, `False` otherwise

def pristine_tar_verify_origs(repo, source, options, output_dir, orig_files):

Verify orig tarballs using prstine tar

Returns | `True` if tarball was build, `False` otherwise

def maybe_pristine_tar_commit(repo, source, options, output_dir, orig_files):
Undocumented
def git_archive_get_upstream_tree(repo, source, options):

Determine the upstream tree from the given options

for a git archive export

def git_archive_build_origs(repo, source, output_dir, options):

Build orig tarball(s) using git-archive

Parameters | source | the source of the package we're acting on (type: `DebianSource`)
| output_dir | where to put the tarball (type: `Str`)
| options | the parsed options (type: `dict` of options)

def guess_comp_type(comp_type, source, repo, tarball_dir):

Guess compression type to use for the to be built upstream tarball

We prefer pristine-tar over everything else since this is what's carried around with the repo and might be more reliable than what a user has in tarball_dir.

def build_parser(name):
Undocumented
def parse_args(argv, prefix):
Undocumented
def main(argv):
Undocumented