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: Documentation archives should be available also in tar.xz format
Type: Stage: resolved
Components: Documentation Versions: Python 3.11, Python 3.10, Python 3.9
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: mdk Nosy List: Arfrever, eric.araujo, georg.brandl, iritkatriel, mdk, ned.deily, pletnes, terry.reedy
Priority: normal Keywords: easy

Created on 2014-02-23 08:05 by Arfrever, last changed 2022-04-11 14:57 by admin.

Messages (9)
msg211985 - (view) Author: Arfrever Frehtes Taifersar Arahesis (Arfrever) * (Python triager) Date: 2014-02-23 08:05
Source archives (e.g. in [1]) are available in tgz and tar.xz formats, but documentation archives (e.g. in [2]) are available only in tar.bz2 and zip formats.
I suggest that documentation archives be available also in tar.xz format.

[1] http://www.python.org/ftp/python/3.3.4/
[2] http://www.python.org/ftp/python/doc/3.3.4/
msg237711 - (view) Author: Mark Lawrence (BreamoreBoy) * Date: 2015-03-09 21:45
Do we need documentation archives in tar.xz format?
msg245519 - (view) Author: Paul Anton Letnes (pletnes) * Date: 2015-06-19 19:49
The format (xz vs bzip2) might not matter much, but I'd say consistency does. I'd make the formats identical just for the sake of standardization.

Where is this decided? In some (post)build script?
msg407589 - (view) Author: Irit Katriel (iritkatriel) * (Python committer) Date: 2021-12-03 14:10
Those archives seem to go only up to 3.9. Is this still relevant?
msg408423 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2021-12-13 03:38
Documentation downloads are still built and provided for each release (as linked to from https://www.python.org/doc/ and https://www.python.org/doc/versions/) as well as daily for the heads of each active bugfix and feature branch, in each case via the "Download these documents" link on the top page of the release/branch documentation set, for  example, https://docs.python.org/3/ -> https://docs.python.org/3/download.html. The downloadable doc formats are still .zip and .bz2 while cPython source archives are still .tgz and .xz formats. Julien Palard (@mdk) is the release team documentation expert.  Julien, what do you think?
msg408804 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2021-12-17 18:17
I don’t think that consistency or standardization really applies here, it’s not like there are tools that want to process both source and doc archives and are broken by the difference in formats.

It could be useful to review the formats used and decide if they are still the best choices (maybe zip for universality, tar + modern and well-supported compression for size), but consistency for consistency’s sake is needless churn.
msg408805 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2021-12-17 18:18
Oh to counter my own proposal: formats should not be removed without warnings, there are probably downstream tools that expect specific URL patterns and formats.  So adding something very modern to get the smallest size might be good, but not removing existing format without warning.
msg408812 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2021-12-17 20:23
https://docs.python.org/3/download.html says a) tar.bz2 can be read by the tar program, which I presume is true also of tar.xz.  So there is no issue of *needing* two separate programs.  It also claims "The .tar.bz2 archives provide the best compression and fastest download times."  This only need be true, if it is, for the doc formats, as opposed to python code.  In the absence of at least 2 requests from *nix consumers of the archives, why even think of changing?
msg408813 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2021-12-17 20:39
tar is modular and depends on optional external programs to handle compression (tar itself does archival only).

gzip is still common, and xz has largely replaced bz2 these days.
I would expect it to be installed on most systems.

(For HTTP compression there are new competitors, brotli and zstd, but I haven’t seen these used to compress files.)
History
Date User Action Args
2022-04-11 14:57:59adminsetgithub: 64940
2021-12-17 20:39:48eric.araujosetmessages: + msg408813
2021-12-17 20:23:24terry.reedysetnosy: + terry.reedy
messages: + msg408812
2021-12-17 18:18:37eric.araujosetmessages: + msg408805
2021-12-17 18:17:13eric.araujosetnosy: + eric.araujo
messages: + msg408804
2021-12-13 03:38:05ned.deilysetstatus: pending -> open

assignee: mdk
components: + Documentation
versions: + Python 3.9, Python 3.10, Python 3.11, - Python 2.7, Python 3.4, Python 3.5
nosy: + ned.deily, mdk

messages: + msg408423
resolution: out of date ->
2021-12-12 19:00:24iritkatrielsetstatus: closed -> pending
2021-12-12 18:59:47iritkatrielsetstatus: open -> closed
resolution: out of date
stage: resolved
2021-12-03 14:10:48iritkatrielsetnosy: + iritkatriel
messages: + msg407589
2016-02-11 17:37:12BreamoreBoysetnosy: - BreamoreBoy
2016-02-11 17:26:15georg.brandlsetassignee: georg.brandl -> (no value)
2015-06-19 19:49:09pletnessetnosy: + pletnes
messages: + msg245519
2015-03-09 21:45:30BreamoreBoysetnosy: + BreamoreBoy

messages: + msg237711
versions: + Python 3.5, - Python 3.3
2014-02-25 20:15:39ned.deilysetassignee: georg.brandl
2014-02-23 08:05:20Arfrevercreate