← Back to branch summary

~jelmer/bzr-builddeb/pristine-tar-refactor

« back to all changes in this revision

Viewing changes to doc/user_manual/configuration.rst

  • Committer: James Westby
  • Date: 2009-02-18 18:36:18 UTC
  • mto: This revision was merged to the branch mainline in revision 323.
  • Revision ID: jw+debian@jameswestby.net-20090218183618-0wuajt2nbtpcooag
Kill off export-upstream mode.

merge-upstream will be improved to merge the upstream branch, store it with
pristine-tar, and then produce the tarball as needed.

Using export-upstream for snapshots is now incorrect. You should use
"merge-upstream" every time instead, which will track if there is nothing
to do, and handle conflicts. You can autocommit the merge and build the
result if you like.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/user_manual/configuration.rst
90
90
.. _native mode: native.html
91
91
.. _split mode: split.html
92
92
 
93
 
Interaction with an upstream branch
94
 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
95
 
 
96
 
When the upstream source is in ``bazaar`` it is possible to have the
97
 
``.orig.tar.gz`` created by exporting the upstream branch. To do this set
98
 
the ``export-upstream`` option. This only works for normal and merge modes.
99
 
 
100
 
  * ``export-upstream = path``
101
 
 
102
 
    This option takes a path (remote or local) to a bzr branch that contains
103
 
    the upstream code. If this is set then the plugin will export the code
104
 
    from that branch to create the ``.orig.tar.gz``. This option only has no
105
 
    effect if ``native`` or ``split`` is set, and causes any ``orig-dir``
106
 
    setting to be ignored. See `export-upstream mode`.
107
 
 
108
 
  * ``export-upstream-revision = revision``
109
 
 
110
 
    This sets the revision that the upstream code will be branched at. It takes
111
 
    the same revision spec as the normal --revision parameter. Use it to
112
 
    associate an upstream version number with a particular revision of the
113
 
    upstream code. This has no effect if ``export-upstream`` is not set.
114
 
 
115
 
  * ``export-upstream-prepull = True``
116
 
 
117
 
    This allows for the case where you want to use a local mirror of the
118
 
    upstream source, but want to build automatically. It does a pull in the
119
 
    local branch before exporting it. It is your responsibility to setup
120
 
    the default pull location for the branch. It probably doesn't make too
121
 
    much sense to use this option with the ``export-upstream-revision`` one
122
 
    as this will change the tip, but then won't use it. However this is allowed.
123
 
    This option only has an effect if ``export-upstream`` is set. Also note
124
 
    that this option cannot be used when ``export-upstream`` is set to a 
125
 
    remote branch. [Not a command line option.]
126
 
 
127
 
  * ``export-upstream-stop-on-trivial-pull = True``
128
 
 
129
 
    This allows you to stop the build if the upstream pull doesn't pull any
130
 
    revisions. It is designed for automated builds where you don't want
131
 
    to bother building if there have been no changes. It has no effect unless
132
 
    the ``export-upstream-prepull`` option is true. [Not a command line
133
 
    option.]
134
 
 
135
 
.. _export-upstream mode: export_upstream.html
136
 
 
137
93
Builders
138
94
^^^^^^^^
139
95