aboutsummaryrefslogtreecommitdiff
path: root/docs/manpages/git-buildpackage.sgml
blob: a221f906121766233f063f57bcdf37c4332b5dcb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
<refentry id="gbp.man.git.buildpackage">
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2006</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    <refentrytitle>git-buildpackage</refentrytitle>
    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&git-buildpackage;</refname>
    <refpurpose>Build Debian packages from a Git repository</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      &git-buildpackage;
      <arg><option>--git-ignore-new</option></arg>
      <arg><option>--git-tag</option></arg>
      <arg><option>--git-verbose</option></arg>
      <arg><option>--upstream-branch=<replaceable>branch_name</replaceable></option></arg>
      <arg><option>--debian-branch=<replaceable>branch_name</replaceable></option></arg>
      <arg><option>--git-builder=<replaceable>BUILD_CMD</replaceable></option></arg>
      <arg><option>--git-cleaner=<replaceable>CLEAN_CMD</replaceable></option></arg>
      <arg><option>--git-sign-tags</option></arg>
      <arg><option>--git-keyid</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>
    <para>
    &git-buildpackage; is used to build Debian source and .deb packages from a GIT repository.
    </para>
    <para>
        &git-buildpackage; will, in order:
   </para>
    <itemizedlist>
        <listitem><para>Verify that it is being executed from the
            proper location.</para>
        </listitem>
	<listitem><para>Verify that the reopository doesn't contain any
	uncommitted source changes.</para>
	</listitem>
        <listitem><para>Verify that it is being executed from the
        correct branch.</para>
        </listitem>
        <listitem><para>Build an orig.tar.gz if it doesn't exist.</para>
        </listitem>
        <listitem><para>Call <application>debuild</application> (1)
            (or the application specified via --git-builder)
            with arguments instructing it to ignore Git meta-data in
            the diff.gz, passing along all arguments given to
            &git-buildpackage; that don't start with --git-.
          </para>
        </listitem>
    </itemizedlist>
  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <variablelist>
      <varlistentry>
        <term><option>--git-ignore-new</option>
        </term>
        <listitem>
	  <para>Build the .diff.gz and debian package although there are
	  uncommitted changes in the source tree.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-tag</option>
        </term>
        <listitem>
          <para>Add a git tag after a successfull build.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-builder=<replaceable>BUILD_CMD</replaceable></option></term>
        <listitem>
          <para>Use <replaceable>BUILD_CMD</replaceable> instead of <command>debuild</command></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-cleaner=<replaceable>CLEAN_CMD</replaceable></option></term>
        <listitem>
          <para>Use <replaceable>CLEAN_CMD</replaceable> instead of <command>debuild clean</command></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-verbose</option>
        </term>
        <listitem>
          <para>Verbose execution</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-upstream-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
	  <para>Branch to build the orig.tar.gz from. Default is <replaceable>upstream</replaceable></para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--git-debian-branch</option>=<replaceable>branch_name</replaceable>
        </term>
        <listitem>
	  <para>If you're not on this branch when invoking &git-buildpackage;
	  it will fail. Default is <replaceable>master</replaceable>.  This
	  option will be ignored when using <option>--git-ignore-new</option>.
	  </para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
      &man.git.config-files;
      <para>All options in the config files are specified without the 'git-' prefix.</para>
  <refsect1>
    <title>SEE ALSO</title>

    <para>git-import-dsc (1), git-import-orig (1), debuild (1), git (1)</para>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>&dhusername; &dhemail;</para>

  </refsect1>
</refentry>