Skip to content

Commit 3164bc6

Browse files
committed
point to read the docs
1 parent a471ca0 commit 3164bc6

File tree

1 file changed

+2
-137
lines changed

1 file changed

+2
-137
lines changed

README.rst

Lines changed: 2 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -1,141 +1,6 @@
1-
This is the development buildout for Plone 4.2.
2-
3-
Plone 4 now runs Zope 2.13, and uses Python 2.6, so make sure that
4-
you're using the correct version of Python to run the 'python2.6 bootstrap.py'
5-
command.
6-
7-
mr.developer
1+
Introduction
82
============
3+
This is the development buildout for Plone 4.2. If this is your first time here, please read ALL if the instructions at `readthedocs.org <http://readthedocs.org/docs/buildoutcoredev>`_ before getting started. It will save you time in the end, we promise!
94

10-
This buildout uses mr.developer to manage package development. See
11-
http://pypi.python.org/pypi/mr.developer for more information or run
12-
'bin/develop help' for a list of available commands.
13-
14-
The most common workflow to get all the latest updates is:
15-
16-
$ git pull
17-
$ bin/develop rb
18-
19-
This will get you the latest coredev configuration, checkout and update all
20-
packages via Subversion in src and run buildout to configure the whole thing.
21-
22-
From time to time you can check if some old cruft has accumulated:
23-
24-
$ bin/develop st
25-
26-
If this prints any lines with a question mark in front, you can cleanup by:
27-
28-
$ bin/develop purge
29-
30-
This will remove packages from src/ which are no longer needed, as they have
31-
been replaced by proper egg releases of these packages.
32-
33-
PLIP Implementation
34-
===================
35-
36-
Create a buildout configuration file for your plip in the 'plips' folder.
37-
Give it a descriptive name, starting with the plip number;
38-
'plip-1234-widget-frobbing.cfg' for example. This file will define the
39-
branches/trunks you're working with in your PLIP. It should look something
40-
like this:
41-
42-
In file plips/plip-1234-widget-frobbing.cfg...::
43-
44-
[buildout]
45-
extends = plipbase.cfg
46-
auto-checkout +=
47-
plone.somepackage
48-
plone.app.someotherpackage
49-
50-
[sources]
51-
plone.somepackage = git git://github.com/plone/plone.somepackage.git branch=plip-1234-widget-frobbing
52-
plone.app.someotherpackage = git git://github.com/plone/plone.app.somepackage.git branch=plip-1234-widget-frobbing
53-
54-
[instance]
55-
eggs +=
56-
plone.somepackage
57-
plone.app.someotherpackage
58-
zcml +=
59-
plone.somepackage
60-
plone.app.someotherpackage
61-
62-
Use the same naming convention when branching existing packages, and you
63-
should always be branching packages when working on PLIPs.
64-
65-
Common Issues
66-
=============
67-
68-
Issue
69-
-----
70-
71-
"ERROR: Can't update package '[Some package]', because it's dirty."
72-
73-
Fix
74-
---
75-
76-
mr.developer is complaining because a file has been changed/added, but not
77-
committed.
78-
79-
Use ``bin/develop update --force``. Adding ``*.pyc *~.nib *.egg-info
80-
.installed.cfg *.pt.py *.cpt.py *.zpt.py *.html.py *.egg`` to your subversion
81-
config's global-ignores has been suggested as a more permanent solution.
82-
83-
Issue
84-
-----
85-
86-
``ERROR: You are not in a path which has mr.developer installed (.mr.developer.cfg not found).``
87-
88-
When running any ``./bin/develop`` command.
89-
90-
Fix
91-
---
92-
93-
``ln -s plips/.mr.developer.cfg``
94-
95-
Issue
96-
------
97-
98-
"ImportError: No module named Zope2" when building using a PLIP cfg file.
99-
100-
Fix
101-
----
102-
103-
Appears to not actually be the case. Delete 'mkzopeinstance.py' from bin/ and
104-
rerun buildout to correct this if you're finding it irksome.
105-
106-
Issue
107-
------
108-
109-
can't open file '/Startup/run.py'
110-
111-
Fix
112-
----
113-
114-
Two possible fixes, you are using Python 2.4 by mistake, so use Python 2.5 or
115-
2.6 instead. Or, you may need to make sure you run 'bin/buildout …' after
116-
'bin/develop …'. Try removing parts/*, bin/*, .installed.cfg, then re-bootstrap
117-
and re-run buildout, develop, buildout.
118-
119-
Issue
120-
-----
121-
122-
Missing PIL.
123-
124-
Fix ---
125-
126-
pil.cfg is include within this buildout to aid in PIL installation. Run
127-
bin/buildout -c pil.cfg to install. This method does not work on Windows, so
128-
we're unable to run it by default.
129-
130-
131-
Issue
132-
-----
133-
134-
bin/develop status is showing that the Products.CMFActionIcons egg has been
135-
modified, but I haven't touched it. And this is preventing bin/develop up
136-
from updating all the eggs.
1375

138-
Fix
139-
---
1406

141-
Edit ~/.subversion/config and add eggtest*.egg to the list of global-ignores

0 commit comments

Comments
 (0)