Skip to content

Commit 562dc61

Browse files
committed
gh-108494: Document how to add a project in PCbuild/readme.txt (GH-110077)
(cherry picked from commit 6387b53) Co-authored-by: Victor Stinner <[email protected]>
1 parent 8296b53 commit 562dc61

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

PCbuild/readme.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -293,3 +293,31 @@ project, with some projects overriding certain specific values. The GUI
293293
doesn't always reflect the correct settings and may confuse the user
294294
with false information, especially for settings that automatically adapt
295295
for different configurations.
296+
297+
Add a new project
298+
-----------------
299+
300+
For example, add a new _testclinic_limited project to build a new
301+
_testclinic_limited extension, the file Modules/_testclinic_limited.c:
302+
303+
* In PCbuild/, copy _testclinic.vcxproj to _testclinic_limited.vcxproj,
304+
replace RootNamespace value with `_testclinic_limited`, replace
305+
`_asyncio.c` with `_testclinic_limited.c`.
306+
* Open Visual Studio, open PCbuild\pcbuild.sln solution, add the
307+
PCbuild\_testclinic_limited.vcxproj project to the solution ("add existing
308+
project).
309+
* Add a dependency on the python project to the new _testclinic_limited
310+
project.
311+
* Save and exit Visual Studio.
312+
* Add `;_testclinic_limited` to `<TestModules Include="...">` in
313+
PCbuild\pcbuild.proj.
314+
* Update "exts" in Tools\msi\lib\lib_files.wxs file or in
315+
Tools\msi\test\test_files.wxs file (for tests).
316+
* PC\layout\main.py needs updating if you add a test-only extension whose name
317+
doesn't start with "_test".
318+
* Add the extension to PCbuild\readme.txt (this file).
319+
* Build Python from scratch (clean the solution) to check that the new project
320+
is built successfully.
321+
* Ensure the new .vcxproj and .vcxproj.filters files are added to your commit,
322+
as well as the changes to pcbuild.sln, pcbuild.proj and any other modified
323+
files.

0 commit comments

Comments
 (0)