This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Move devguide into cpython repo
Type: Stage:
Components: Devguide Versions:
process
Status: closed Resolution: rejected
Dependencies: Superseder:
Assigned To: Nosy List: barry, brett.cannon, eli.bendersky, eric.snow, ezio.melotti, ncoghlan, sandro.tosi
Priority: normal Keywords:

Created on 2011-08-13 05:51 by eric.snow, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (7)
msg142009 - (view) Author: Eric Snow (eric.snow) * (Python committer) Date: 2011-08-13 05:51
The idea of moving the devguide into the cpython repo, presumably under Doc/, was mentioned in a thread on python-dev[1] (related to issue 12652).  Does anyone have any objections?

I'm guessing that Brett made a separate repo (A) for simplicity and (B) because the mercurial cutover hadn't happened yet.

As a bonus, if the devguide were in the cpython repo then most of the objections to moving the test.support docs under the devguide go away.

[1] http://mail.python.org/pipermail/python-dev/2011-July/112656.html
msg142010 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2011-08-13 05:58
I'm +0 about it.

See also #12409.
msg142011 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2011-08-13 06:18
Actually if we move the devguide to Doc/ we will have to maintain a copy for each branch -- that's the real reason why it's in a separate repo.

So I think it's better to leave the devguide in a separate repo, and keep using it to document things that are not strictly dependent on specific Python releases.
msg142012 - (view) Author: Eric Snow (eric.snow) * (Python committer) Date: 2011-08-13 06:23
I suppose it doesn't have to be in Doc/.
msg142013 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2011-08-13 06:31
The possible options I see are:
  1) move it in Doc/ or some other dir -- but we will have
     to maintain it in all the branches;
  2) keep it only in the default branch -- but we will have
     to remove it from the old branch when we cut a release;
  3) make a separate branch for the devguide -- I'm not sure
     this makes even sense and/or if it solves anything;

Also if it's not in Doc/, where would the test.support doc go?
msg142014 - (view) Author: Nick Coghlan (ncoghlan) * (Python committer) Date: 2011-08-13 07:00
I'd say the main reason the dev guide is in a separate repo is the historical one (i.e. Brett was working on it as a separate repo prior to the hg migration and we never merged it).

However, the version independent nature of the material is the main argument against merging it into the Docs tree - it's a document about the development community around CPython, not a document about CPython itself.

Personally, I'm happy with the resolution in the python-dev thread - tagging the test.support docs to keep them out of indices and search results, while leaving the dev guide in a separate version independent repo.
msg142035 - (view) Author: Eric Snow (eric.snow) * (Python committer) Date: 2011-08-13 19:48
That's fine.  The discussion had moved away from the devguide, so I figured it would be worth following up.  You guys have made some good points.
History
Date User Action Args
2022-04-11 14:57:20adminsetgithub: 56956
2011-08-13 19:48:49eric.snowsetstatus: open -> closed
resolution: rejected
messages: + msg142035
2011-08-13 07:00:39ncoghlansetmessages: + msg142014
2011-08-13 06:31:35ezio.melottisetmessages: + msg142013
2011-08-13 06:23:05eric.snowsetmessages: + msg142012
title: Move devguide into /Docs of cpython repo -> Move devguide into cpython repo
2011-08-13 06:18:48ezio.melottisetmessages: + msg142011
2011-08-13 05:58:34ezio.melottisetnosy: + sandro.tosi, ezio.melotti
messages: + msg142010
components: + Devguide
2011-08-13 05:51:31eric.snowcreate