1
=== modified file 'doc/buildout.txt'
2
--- doc/buildout.txt	2009-07-31 20:13:12 +0000
3
+++ doc/buildout.txt	2010-07-31 21:05:33 +0000
4
@@ -302,6 +302,8 @@
5
302
        develop = .
302
        develop = .
6
303
                  lazr_uri_branch
303
                  lazr_uri_branch
7
304
304
8
305
    See `Developing a Dependent Library In Parallel`_ for more on this.
9
306
10
305
    The other basic key in the ``[buildout]`` section that we'll highlight here
307
    The other basic key in the ``[buildout]`` section that we'll highlight here
11
306
    is ``parts``.  This key identifies the other sections in buildout.cfg that
308
    is ``parts``.  This key identifies the other sections in buildout.cfg that
12
307
    will be processed.  A section that is not identified in the ``[buildout]``
309
    will be processed.  A section that is not identified in the ``[buildout]``
13
@@ -581,6 +583,51 @@
14
581
583
15
582
.. _`the egg_info command`: http://peak.telecommunity.com/DevCenter/setuptools#tagging-and-daily-build-or-snapshot-releases
584
.. _`the egg_info command`: http://peak.telecommunity.com/DevCenter/setuptools#tagging-and-daily-build-or-snapshot-releases
16
583
585
17
586
Developing a Dependent Library In Parallel
18
587
==========================================
19
588
20
589
Sometimes you need to iterate on change to a library used by Launchpad
21
590
that is managed by buildout as an egg. You could just edit what it is in
22
591
the ``eggs`` directory, but it is harder to produce a patch while doing
23
592
this. You could instead grab a branch of the libarary and produce an egg
24
593
everytime you make a change and make buildout use the new egg, but this is
25
594
slow.
26
595
27
596
buildout defaults to only using the current directory as code that will
28
597
be used without creating a distribution. We can arrange for it to use other
29
598
paths as well, so we can use a checkout of any code we like, with changes
30
599
being picked up instantly without us having to create a distribution.
31
600
32
601
To do this add the extra paths to the ``develop`` key in the ``[buildout]``
33
602
section of ``buildout.cfg"::
34
603
35
604
    [buildout]
36
605
    develop = .
37
606
              path/to/branch
38
607
39
608
and re-run ``make``.
40
609
41
610
Now any changes you make in that path will be picked up, and you are free
42
611
to make the changes you need and test them in the Launchpad environment.
43
612
44
613
Once you are finished you can produce a distribution as above for inclusion
45
614
in to Launchpad, as well as sending your patch upstream. At that point you
46
615
are free to revert the configuration to only develop Launchpad. You should
47
616
not submit your branch with this change in the configuration as it will
48
617
not work for others.
49
618
50
619
Be aware that you may have to change the version for the package in
51
620
``versions.cfg`` if there is a difference between the version in the
52
621
``eggs`` directory and the one in the ``setup.py`` that you pointed to
53
622
in the ``develop`` key.
54
623
55
624
One thing to be wary of is that setuptools treats "develop eggs" created
56
625
by this process with the same precedence as system packages. That means
57
626
that if the version in the ``setup.py`` at the path that you put in the
58
627
``develop`` key is the same as the version installed system wide, setuptools
59
628
may pick the wrong one. If that happens then increase the version in
60
629
setup.py and setuptools will take it.
61
630
62
584
=====================
631
=====================
63
585
Possible Future Goals
632
Possible Future Goals
64
586
=====================
633
=====================
Status:	Merged
Approved by:	Jonathan Lange on 2010-08-02
Approved revision:	no longer in the source branch.
Merged at revision:	11276
Proposed branch:	lp:~james-w/launchpad/buildout-doc
Merge into:	lp:launchpad
Diff against target:	64 lines (+47/-0) 1 file modified doc/buildout.txt (+47/-0)
To merge this branch:	bzr merge lp:~james-w/launchpad/buildout-doc
Related bugs:	Link a bug report
Reviewer	Review Type	Date Requested	Status
Jonathan Lange (community)		2010-07-31	Approve on 2010-08-02
Review via email: mp+31465@code.launchpad.net