Links to source code should now point to hg repo

[SilentGhost]

BPO	11435
Nosy	@birkenfeld, @benjaminp, @ned-deily, @ezio-melotti, @merwok, @ericsnowcurrently
Files	docs_sourcename.diff docs-source-link-3.2.diff

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2011-08-31.14:42:10.680>
created_at = <Date 2011-03-07.17:31:31.132>
labels = ['docs']
title = 'Links to source code should now point to hg repo'
updated_at = <Date 2011-08-31.14:42:10.679>
user = 'https://bugs.python.org/SilentGhost'

bugs.python.org fields:

activity = <Date 2011-08-31.14:42:10.679>
actor = 'eric.araujo'
assignee = 'docs@python'
closed = True
closed_date = <Date 2011-08-31.14:42:10.680>
closer = 'eric.araujo'
components = ['Documentation']
creation = <Date 2011-03-07.17:31:31.132>
creator = 'SilentGhost'
dependencies = []
files = ['21033', '22620']
hgrepos = []
issue_num = 11435
keywords = ['patch']
message_count = 24.0
messages = ['130268', '130269', '130270', '130276', '130287', '130289', '130290', '130303', '130376', '130435', '130441', '130528', '130556', '130565', '130566', '130568', '138384', '140116', '140790', '140791', '140840', '140850', '140942', '143258']
nosy_count = 9.0
nosy_names = ['georg.brandl', 'benjamin.peterson', 'ned.deily', 'ezio.melotti', 'eric.araujo', 'SilentGhost', 'docs@python', 'python-dev', 'eric.snow']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue11435'
versions = ['Python 2.7', 'Python 3.2', 'Python 3.3']

[SilentGhost]

With the conversion to mercurial source links in documentation should now point to hg.python.org
Here is the patch.

[ned-deily]

Good point. However, making the change won't help the already generated versions of the 3.2 html doc, like those included with installers or any older URL references elsewhere to the svn source. Perhaps some URL rewrite rules should be added to the web server to redirect "source code" URLs from svn.python.org to hg.python.org style?

[ezio-melotti]

IIUC those svn links will keep working for some time, but if/when the svn repo and/or viewvc will be removed an URL rewrite rule should be fix the problem.
The patch seems OK to me.

[pitrou]

I've put the redirection in place.

[ned-deily]

Antoine, great! How about also for the other "active" branches now in hg:
release{32,31,27,26,25-maint} ?

[pitrou]

Antoine, great! How about also for the other "active" branches now in hg:
release{32,31,27,26,25-maint} ?

Is there any such reference in the docs?

[ned-deily]

Right: no comprehensive links like in the 3.2+ versions. I just see a few miscellaneous links elsewhere in the source. But there are undoubtedly plenty of links elsewhere out in the wild. So this is probably out-of-scope for this issue but should be dealt with elsewhere as part of a long-term migration plan for svn.python.org. I'll bring it up on python-dev.

[SilentGhost]

I've put the redirection in place.
So, it's not possible to access http://svn.python.org/view/python/branches/py3k/ at all now?

[pitrou]

So, it's not possible to access http://svn.python.org/view/python
/branches/py3k/ at all now?

Hmm, apparently no. Is it important?

[ezio-melotti]

The svn repos and viewvc won't disappear soon because they are used for other things (e.g. the tracker). I think it's better to avoid redirects until svn and/or viewvc are definitely gone.

[pitrou]

The svn repos and viewvc won't disappear soon because they are used
for other things (e.g. the tracker). I think it's better to avoid
redirects until svn and/or viewvc are definitely gone.

The redirect is only for the py3k branch, something nobody should use
anymore.

[ezio-melotti]

This can be closed.

[SilentGhost]

This issue is not about the redirects. It is about links in documentation. The redirect is great for the links in the wild, the online documentation, however, could and should use proper links without any redirects.

Georg, or whoever is maintainer of Doc/tools/sphinxext/pyspecific.py, could you please have a look at the patch.

[python-dev]

New changeset 3c1e779002d3 by Ezio Melotti in branch '3.2':
bpo-11435: Update the links generated by the source directive to use hg.python.org.
http://hg.python.org/cpython/rev/3c1e779002d3

[python-dev]

New changeset 5f220e98eddc by Ezio Melotti in branch 'default':
bpo-11435: Merge with 3.2
http://hg.python.org/cpython/rev/5f220e98eddc

[ezio-melotti]

Now it's fixed in 3.2 and 3.3. Thanks for the patch!

[merwok]

The 2.7 docs link to the Subversion repo. Can I update them?

[merwok]

Patch to fix links in the 3.2 docs.

[python-dev]

New changeset 79d2682c4fc5 by Ezio Melotti in branch '3.2':
bpo-11435: link to the correct branch.
http://hg.python.org/cpython/rev/79d2682c4fc5

New changeset 3028b5ab92c0 by Ezio Melotti in branch 'default':
bpo-11435: dummy merge with 3.2.
http://hg.python.org/cpython/rev/3028b5ab92c0

[ezio-melotti]

I fixed the URL in 3.2.

The 2.7 docs link to the Subversion repo. Can I update them?

2.7 doesn't have the source directive, do you want to replace all the svn links manually?
If so, either reopen this issue or create a new one.

[merwok]

Thanks for the commit, I intended to do it these days.

For 2.7, I was indeed talking about updated all manual links. sed is my friend :)

[merwok]

Georg or Benjamin: The PEP/documents/scripts used for releases should also mention/edit the version in Doc/tools/sphinxext/pyspecific.py.

[birkenfeld]

Done (in rev e32f140a020b).

[merwok]

After getting Georg’s greenlight on python-dev, I have adapted the source reST role for 2.7 and updated all links.