---
name: "gbp-import-orig"
section: "1"
platform: "linux"
package: "git-buildpackage"
version: "0.9.38"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/gbp-import-orig"
---

# gbp-import-orig(1)

Import an upstream source from tarball, or git tag and tarball, into a git repository

## NAME

gbp-import-orig - Import an upstream source from tarball, or git tag and tarball, into a git repository

## SYNOPSIS

FC**gbp import-orig**F\[0\]  \[FC**--version**F\[0\]\] \[FC**--help**F\[0\]\] \[FC**--verbose**F\[0\]\] \[FC**--color=**F\[0\]\[auto\|on\|off\]\] \[FC**--color-scheme=**F\[0\] *COLOR\_SCHEME*\] \[FC**--upstream-version=**F\[0\] *version*\] \[FC**--\[no-\]merge**F\[0\]\] \[FC**--merge-mode=**F\[0\] *\[auto\|merge\|replace\]*\] \[FC**--upstream-branch=**F\[0\] *branch\_name*\] \[FC**--debian-branch=**F\[0\] *branch\_name*\] \[FC**--upstream-vcs-tag=**F\[0\] *tag-format*\] \[FC**--\[no-\]sign-tags**F\[0\]\] \[FC**--keyid=**F\[0\] *gpg-keyid*\] \[FC**--upstream-tag=**F\[0\] *tag-format*\] \[FC**--filter=**F\[0\] *pattern*\]... \[FC**--component=**F\[0\] *component*\]... \[FC**--\[no-\]pristine-tar**F\[0\]\] \[FC**--\[no-\]filter-pristine-tar**F\[0\]\] \[FC**--\[no-\]symlink-orig**F\[0\]\] \[FC**--postimport=cmd**F\[0\]\] \[FC**--postunpack=cmd**F\[0\]\] \[FC**--\[no-\]interactive**F\[0\]\] \[FC**--\[no-\]rollback**F\[0\]\] \[FC**--upstream-signatures=**F\[0\]\[auto\|on\|off\]\] *filename* \| *url* \| FC**--uscan**F\[0\]

## DESCRIPTION

**gbp import-orig** imports upstream sources into a Git repository optionally linking to upstream's git history. It can import from three sources:

- 1\.

  *filename*: A file in the local file system. Gzip, bzip2, lzma and xz compressed tar archives, zip archives and already unpacked source trees are supported.

- 2\.

  *url*: The tarball is downloaded from a *http* or *https* *url*. This needs the python3-request package installed.

- 3\.

  FC**--uscan**F\[0\]: The latest upstream or specified version is fetched via **uscan** relying on FC*debian/watch*F\[0\].

If the tarballs name is already of the form *package-name\_version.orig.tar.gz*, the version information is determined from the tarball's filename, otherwise it can be given on the command line via FC**--upstream-version**F\[0\]. If the source package name or version can't be determined, **gbp import-orig** will prompt for it unless FC**--no-interactive**F\[0\] is given.

The sources are placed on the upstream branch (default: *upstream*), tagged and merged onto the debian branch (default: *master*). This is either done using plain **git merge** or by creating a new tree that consists of the new upstream version plus the FC*debian/*F\[0\] directory. The later is used for source format 3.0 (quilt) packages since direct modifications of the upstream sources are not allowed in that format and so a 1:1 replacement of the upstream sources is almost always desired. It can be tweaked via the FC**--merge-mode**F\[0\].

When using the FC**--upstream-vcs-tag**F\[0\] option the tag matching the version of the imported release will be added as additinoal parent of the commit created for the imported tarball. This ties the upstream git commit history to the Debian packaging history and allows for e.g. easy cherry-picking of patches and comparison of upstream git and the upstream tarball.

In case of an error **gbp import-orig** will rollback (undo) all changes it has done to the repository (see the FC**--rollback**F\[0\] option).

Note that for projects using multiple tarballs the name of the additional components needs to be specified via the FC**--component**F\[0\] command line option or via FC*gbp.conf*F\[0\] (see below for details).

## OPTIONS

- FC**--version**F\[0\]

  Print version of the program, i.e. version of the git-buildpackage suite

- FC**-v**F\[0\], FC**--verbose**F\[0\]

  Verbose execution

- FC**-h**F\[0\], FC**--help**F\[0\]

  Print help and exit

- FC**--color=**F\[0\]\[auto\|on\|off\]

  Whether to use colored output.

- FC**--color-scheme=**F\[0\]*COLOR\_SCHEME*

  Colors to use in output (when color is enabled). The format for COLOR\_SCHEME is '\<debug\>:\<info\>:\<warning\>:\<error\>'. Numerical values and color names are accepted, empty fields imply the default color. For example, FC**--git-color-scheme=**F\[0\]FC'cyan:34::'F\[0\] would show debug messages in cyan, info messages in blue and other messages in default (i.e. warning and error messages in red).

- FC**--upstream-version**F\[0\]=*version*, FC**-u**F\[0\]*version*

  The upstream version number. With FC**--uscan**F\[0\], passed to uscan as FC**--download-version**F\[0\]

- FC**--\[no-\]merge**F\[0\]

  Merge the upstream branch to the Debian branch after import

- FC**--merge-mode=**F\[0\]*\[auto\|merge\|replace\]*

  How to fold the newly imported upstream source to the Debian packaging branch after import.

  *merge* does a Git **merge** leaving you on your own in case of merge conflict resolution.

  *replace* mode on the other hand makes the head of the Debian packaging branch identical to the newly imported tree but preserves the content of the FC*debian/*F\[0\] directory while keeping the current head as well as the newly imported tree as parents of the generated commit. This is similar to a FC**theirs**F\[0\] merge strategy while preserving FC*debian/*F\[0\].

  The default is *auto* which uses *replace* for 3.0 (quilt) packages and *merge* otherwise.

- FC**--upstream-branch**F\[0\]=*branch\_name*

  The branch in the Git repository the upstream sources are put onto. Default is *upstream*.

- FC**--debian-branch**F\[0\]=*branch\_name*

  The branch in the Git repository the Debian package is being developed on, default is *master*. After importing the new sources on the upstream branch, **gbp import-orig** will try to merge the new version onto this branch.

- FC**--upstream-vcs-tag**F\[0\]=*tag-format*

  Add *tag-format* as additional parent to the commit of the upstream tarball. Useful when upstream uses git and you want to link to its revision history. The *tag-format* can be a pattern similar to what FC**--upstream-tag**F\[0\] supports.

- FC**--\[no-\]sign-tags**F\[0\]

  GPG sign all created tags.

- FC**--keyid=**F\[0\]*gpg-keyid*

  Use this *keyid* for gpg signing tags.

- FC**--upstream-tag=**F\[0\]*tag-format*

  Use this tag format when tagging upstream versions, default is *upstream/%(version)s*.

- FC**--import-msg=**F\[0\]*msg-format*

  Use this format string for the commit message when importing upstream versions, default is *New upstream version %(version)s*.

- FC**--filter=**F\[0\]*pattern*

  Filter out files glob-matching *pattern*. This option can be given multiple times.

- FC**--component=**F\[0\]*COMPONENT*

  When importing the upstream tarball also look for an additional tarball with component name *COMPONENT*. E.g. in FC*hello-debhelper\_1.0.orig-foo.tar.gz*F\[0\] the component would be *foo*. The additional tarball is expected to be in the same directory than the upstream tarball and to use the same compression type. You also need to specify the components when using FC**--uscan**F\[0\].

  Using additional original tarballs is a feature of the 3.0 (quilt) source format. See the **dpkg-source** manpage for details. This is currently considered an experimental feature and might change incompatibly.

- FC**--\[no-\]pristine-tar**F\[0\]

  Generate **pristine-tar** delta file.

- FC**--\[no-\]filter-pristine-tar**F\[0\]

  If using a filter, also filter the files out of the tarball passed to **pristine-tar**.

- FC**--\[no-\]symlink-orig**F\[0\]

  Whether to create and keep a symlink from the upstream tarball to a Debian policy conformant upstream tarball name located in FC*../*F\[0\].

  This is a good idea if not using **pristine-tar** since it avoids creating a new tarball with a different md5sum.

- FC**--postimport=**F\[0\]*cmd*

  Run *cmd* after the import. The hook gets the following environment variables passed:

  - **GBP\_BRANCH**

    The name of the Debian packaging branch

  - **GBP\_TAG**

    The name of the just created upstream tag

  - **GBP\_UPSTREAM\_VERSION**

    The just imported upstream version

  - **GBP\_DEBIAN\_VERSION**

    The Debian version of the package with a Debian revision of '-1'

- FC**--postunpack=**F\[0\]*cmd*

  Run *cmd* after the import. This can be useful to e.g. convert or remove certain files prior to the import. The hook gets passed the following environment variables:

  - **GBP\_TMP\_DIR**

    The temporary directory the tarballs are unapcked into.

  - **GBP\_SOURCES\_DIR**

    The temporary directory where the unpacked sources are.

  - **GBP\_GIT\_DIR**

    The directory of the git repository where the tarball will be imported into.

- FC**--uscan**F\[0\]

  Use **uscan** to fetch new upstream version. The version can be specified with FC**--upstream-version**F\[0\]

- FC**--\[no-\]interactive**F\[0\]

  Run command interactively, i.e. ask package name and version if needed.

- FC**--\[no-\]rollback**F\[0\]

  Rollback changes in case of an error.

- FC**--upstream-signatures=**F\[0\]\[auto\|on\|off\]

  Whether upstream signatures should be imported as well (when using pristine-tar). *off* turns this off completely while *on* always tries to import a signature (which can be useful if you want to fail if e.g. **uscan** did not fetch a signature). The default *auto* means to import a signature file if present but do nothing otherwise.

## EXAMPLES

Download and import a new upstream version using the information from FC*debian/watch*F\[0\]

```
FC
      gbp import-orig --uscanF[0]
```

Fetch tarball from an URL

```
FC
      gbp import-orig https://debian.example.com/sid/upstream-tarball-0.1.tar.gzF[0]
```

Import a local tarball

```
FC
      gbp import-orig ../upstream-tarball-0.1.tar.gzF[0]
```

## CONFIGURATION FILES

Several FC*gbp.conf*F\[0\] files are parsed  to set defaults for the above command-line arguments. See the [**gbp.conf**(5)](/gbp.conf/5.md) manpage for details.

## SEE ALSO

[**gbp-buildpackage**(1)](/gbp-buildpackage/1.md), [**gbp-import-dsc**(1)](/gbp-import-dsc/1.md), [**gbp-import-dscs**(1)](/gbp-import-dscs/1.md), [**gbp-dch**(1)](/gbp-dch/1.md), [**gbp.conf**(5)](/gbp.conf/5.md), [**uscan**(1)](/uscan/1.md), [**debuild**(1)](/debuild/1.md), [**git**(1)](/git/1.md), [**pristine-tar**(1)](/pristine-tar/1.md),\
        The Git-Buildpackage Manual ⟨file:///usr/share/doc/git-buildpackage/manual-html/index.html⟩

## AUTHOR

Guido Günther \<FCagx@sigxcpu.orgF\[0\]\>