devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Document how to add a new file or a new directory

Open vstinner opened this issue 8 years ago • 3 comments

The issue title seems trivial, but in practice there are many traps. See for example: https://github.com/python/cpython/pull/2851/files Adding a new test directory requires to modify Makefile.pre.in and PCbuild/lib.pyproj.

vstinner avatar Jul 24 '17 21:07 vstinner

Adding new C files can also be trickier than it seems at first glance, as even though forgetting that will give you immediate build failures, you still need to know where to make the modifications for both autotools and MSVC in order to get pre-merge CI to pass.

ncoghlan avatar Jul 25 '17 01:07 ncoghlan

I'm not sure where you'd put this info in the current dev guide though - we don't really cover the build process right now beyond what's in https://devguide.python.org/setup/#compiling-for-debugging

It may make sense to expand https://devguide.python.org/setup/#troubleshooting-the-build into a new top level section on the build process, akin to the sections on changing the grammar or working on the compiler.

ncoghlan avatar Jul 25 '17 01:07 ncoghlan

If I add a new file in a place that requires additional steps, do I get any error? I think I would first try, then get an error, and then go look for a solution, so it makes sense to document this in the troubleshooting section.

ezio-melotti avatar Sep 05 '17 19:09 ezio-melotti