You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Sometimes it is necessary to override one or more package versions in order to fix a bug.
14
+
Plone includes a few hundred Python packages.
15
+
Sometimes you will need to override one or more package versions to fix a bug.
16
16
17
17
18
-
## with Cookieplone
18
+
## Cookieplone
19
19
20
20
Use the following instructions if you installed Plone with Cookieplone or `cookiecutter-plone-starter`.
21
21
22
+
22
23
### Override a core Plone package
23
24
24
-
Add a version override to {file}`mx.ini`.
25
+
Add a version override to the file {file}`mx.ini`.
25
26
This example uses `plone.api`.
26
27
27
28
```
@@ -37,24 +38,28 @@ For an explanation of why Plone uses `mxdev`, see {ref}`manage-backend-python-pa
37
38
38
39
Stop the backend with {kbd}`ctrl-c`.
39
40
40
-
To actually download and install the new package version, run:
41
+
To actually download and install the new package version, run the following command.
41
42
42
43
```shell
43
44
make backend-build
44
45
```
45
46
46
47
```{note}
47
-
If you installed Plone using `cookiecutter-plone-starter`, run `make build-backend` instead.`
48
+
If you installed Plone using `cookiecutter-plone-starter`, run `make build-backend` instead.
48
49
```
49
50
50
51
Now restart the backend.
51
52
53
+
```{seealso}
54
+
{doc}`run-plone`
55
+
```
56
+
52
57
53
58
### Install a core Plone package from source
54
59
55
-
`mxdev` can also be used to install core Plone packages from a source control system such as GitHub.
60
+
You can also use `mxdev` to install core Plone packages from a source control system such as GitHub.
56
61
57
-
Add the Plone package you want to check out in {file}`mx.ini`.
62
+
Add the Plone package you want to check out in the file {file}`mx.ini`.
58
63
This example uses `plone.restapi`.
59
64
60
65
```cfg
@@ -66,7 +71,7 @@ extras = test
66
71
67
72
Stop the backend with {kbd}`ctrl-c`.
68
73
69
-
To actually download and install the new package version, run:
74
+
To actually download and install the new package version, run the following command.
70
75
71
76
```shell
72
77
make backend-build
@@ -78,14 +83,18 @@ If you installed Plone using `cookiecutter-plone-starter`, run `make build-backe
78
83
79
84
Now restart the backend.
80
85
86
+
```{seealso}
87
+
{doc}`run-plone`
88
+
```
89
+
81
90
82
-
## with Buildout
91
+
## Buildout
83
92
84
93
Use the following instructions if you installed Plone with Buildout.
85
94
86
95
### Override a core Plone package
87
96
88
-
Update {file}`buildout.cfg`.
97
+
Update the file {file}`buildout.cfg`.
89
98
This example uses `plone.api`.
90
99
91
100
```cfg
@@ -111,20 +120,24 @@ plone.api = 2.0.0a3
111
120
The version pins specified in the `[versions]` section will take precedence over the pins inherited from `https://dist.plone.org/release/6-latest/versions.cfg`.
112
121
```
113
122
114
-
To actually download and install the new package version, run:
123
+
To actually download and install the new package version, run the following command.
115
124
116
125
```shell
117
126
bin/buildout
118
127
```
119
128
120
129
Then restart your instance.
121
130
131
+
```{seealso}
132
+
{doc}`run-plone`
133
+
```
134
+
122
135
123
136
### Install a core Plone package from source
124
137
125
138
A core Plone package can be installed from a source control system such as GitHub.
126
139
127
-
Update {file}`buildout.cfg`.
140
+
Update the file {file}`buildout.cfg`.
128
141
This example uses `plone.restapi`.
129
142
130
143
```cfg
@@ -156,12 +169,18 @@ plone.restapi =
156
169
Setting an empty version ensures that the copy of `plone.restapi` from source control will be used, instead of the version pin inherited from https://dist.plone.org/release/6-latest/versions.cfg.
157
170
```
158
171
159
-
To actually download and install the new add-on, run:
172
+
To actually download and install the new add-on, run the following command.
160
173
161
174
```shell
162
175
bin/buildout
163
176
```
164
177
178
+
Then restart your instance.
179
+
180
+
```{seealso}
181
+
{doc}`run-plone`
182
+
```
183
+
165
184
```{seealso}
166
185
This approach uses the [`mr.developer`](https://pypi.org/project/mr.developer/) Buildout extension.
0 commit comments