← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/en/user-guide/version_info.txt

  • Committer: John Arbash Meinel
  • Date: 2007-12-10 16:46:00 UTC
  • mto: (3112.1.1 bzr_access)
  • mto: This revision was merged to the branch mainline in revision 3165.
  • Revision ID: john@arbash-meinel.com-20071210164600-xcvl9fto3gn5aqtj
Change the indentation to 4 spaces according to Bazaar style guidelines.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/en/user-guide/version_info.txt
 
1
Exporting version information
 
2
=============================
 
3
 
 
4
Overview
 
5
--------
 
6
 
 
7
This document describes ways of using ``bzr version-info`` as part of a
 
8
build process to embed version information into a final project.
 
9
 
 
10
 
 
11
Python project
 
12
--------------
 
13
 
 
14
TODO: Figure out how to attach into ``setup.py``
 
15
 
 
16
 
 
17
If using a Makefile to build your project, you can generate the version
 
18
information file as simply as::
 
19
 
 
20
  library/_version.py:
 
21
        bzr version-info --format=python > library/_version.py
 
22
 
 
23
This generates a file which contains 3 dictionaries:
 
24
 
 
25
  * `version_info`: A dictionary containing the basic information about the
 
26
    current state.
 
27
 
 
28
  * `revisions`: A dictionary listing all of the revisions in the
 
29
    history of the tree, along with the commit times and commit
 
30
    message.  This defaults to being empty unless ``--all`` or
 
31
    ``--include-history`` is supplied. This is useful if you want to
 
32
    track what bug fixes, etc, might be included in the released
 
33
    version. But for many projects it is more information than needed.
 
34
 
 
35
  * `file_revisions`: A dictionary listing the last-modified revision
 
36
    for all files in the project. This can be used similarly to how
 
37
    ``$Id$`` keywords are used in CVS-controlled files. The last
 
38
    modified date can be determined by looking in the ``revisions``
 
39
    map. This is also empty by default, and enabled only by ``--all``
 
40
    or ``--include-file-revisions``.
 
41
 
 
42
Check clean
 
43
-----------
 
44
 
 
45
Most information about the contents of the project can be cheaply
 
46
determined by just reading the revision entry. However, it can be useful
 
47
to know if the working tree was completely up-to-date when it was
 
48
packaged, or if there was a local modification. By supplying either
 
49
``--all`` or ``--check-clean``, ``bzr`` will inspect the working tree, and
 
50
set the ``clean`` flag in ``version_info``, as well as set entries in
 
51
``file_revisions`` as ``modified`` where appropriate.
 
52
 
 
53
.. 
 
54
   vim: tw=74 ft=rst spell spelllang=en_us