← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to doc/version_info.txt

  • Committer: joe blow
  • Date: 2007-02-27 21:43:42 UTC
  • mto: (2293.1.5 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 2311.
  • Revision ID: joe@blow.com-20070227214342-ixfizya7jemgtady
Updated version_info.txt for grammar changes

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/version_info.txt
6
6
========
7
7
 
8
8
This document describes ways of using ``bzr version-info`` as part of a
9
 
build routine to embed version information into a final project.
 
9
build process to embed version information into a final project.
10
10
 
11
11
 
12
12
Python Project
23
23
 
24
24
This generates a file which contains 3 dictionaries:
25
25
 
26
 
  `version_info`: A dictionary containing the basic information about the
27
 
                  current state.
28
 
 
29
 
  revisions: A dictionary listing all of the revisions in the history of
30
 
             the tree, along with the commit times and commit message.
31
 
             This defaults to being empty unless ``--all`` or
32
 
             ``--include-history`` is supplied. This is useful if you
33
 
             want to track what bugfixes, etc, might be included in the
34
 
             released version. But for many projects it is more
35
 
             information than they need.
36
 
 
37
 
  `file_revisions`: A dictionary listing the last-modified revision for
38
 
                    all files in the project. This can be used similarly
39
 
                    to how ``$Id$`` keywords are used in CVS controlled
40
 
                    files. The last modified date can be determined by
41
 
                    looking in the ``revisions`` map. This is also empty by
42
 
                    default, and enabled only by ``--all`` or
43
 
                    ``--include-file-revisions``.
 
26
  * `version_info`: A dictionary containing the basic information about the
 
27
    current state.
 
28
 
 
29
  * `revisions`: A dictionary listing all of the revisions in the
 
30
    history of the tree, along with the commit times and commit
 
31
    message.  This defaults to being empty unless ``--all`` or
 
32
    ``--include-history`` is supplied. This is useful if you want to
 
33
    track what bug fixes, etc, might be included in the released
 
34
    version. But for many projects it is more information than needed.
 
35
 
 
36
  * `file_revisions`: A dictionary listing the last-modified revision
 
37
    for all files in the project. This can be used similarly to how
 
38
    ``$Id$`` keywords are used in CVS-controlled files. The last
 
39
    modified date can be determined by looking in the ``revisions``
 
40
    map. This is also empty by default, and enabled only by ``--all``
 
41
    or ``--include-file-revisions``.
44
42
 
45
43
Check Clean
46
44
===========