summaryrefslogtreecommitdiffstats
path: root/Doc/using
Commit message (Collapse)AuthorAgeFilesLines
* [3.11] gh-117058: Update GUI and packaging recommendations for macOS. ↵Miss Islington (bot)2024-03-201-11/+25
| | | | | | (GH-117059) (#117082) Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
* [3.11] gh-90300: Fix cmdline.rst (GH-116721) (GH-116725)Miss Islington (bot)2024-03-131-5/+8
| | | | | | | * Fix the description of the "-b" option. * Add references to environment variables for "-s" and "-X dev" options. (cherry picked from commit 33662d4e01d73cd4f29a25efc2ef09288129023f) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-115664: Fix ordering of more versionadded and versionchanged ↵Serhiy Storchaka2024-03-071-26/+20
| | | | | | | | directives (GH-116298) (GH-116450) (GH-116452) (cherry picked from commit 1e75fe146857b5e6624bd3281675cf20cc356273) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> (cherry picked from commit 808a77612fb89b125d25efac2788522a100e8a6d)
* [3.11] Docs: update using/configure.rst (GH-116274) (#116277)Hugo van Kemenade2024-03-041-3/+11
|
* [3.11] gh-115872: Doc: remove obsolete reference to MSI packages (GH-115873) ↵Miss Islington (bot)2024-02-241-1/+1
| | | | | | (#115877) Co-authored-by: partev <petrosyan@gmail.com>
* [3.11] gh-115795: Doc: fix obsolete URL (GH-115749) (#115804)Miss Islington (bot)2024-02-221-1/+1
| | | | | | gh-115795: Doc: fix obsolete URL (GH-115749) (cherry picked from commit 7bc79371a62e8f45542cf5679ed35d0d29e94226) Co-authored-by: partev <petrosyan@gmail.com>
* [3.11] gh-115664: Fix chronological ordering of versionadded and ↵Brian Schubert2024-02-191-3/+3
| | | | | | versionchanged directives (GH-115676) (#115681) Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
* [3.11] Update "Using Python on a Mac" (GH-115024) (#115388)Miss Islington (bot)2024-02-131-46/+59
| | | | | | Update "Using Python on a Mac" (GH-115024) (cherry picked from commit 0a6e1a4119864bec0247b04a5c99fdd9799cd8eb) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.11] GH-92584: Move installation schemes overview to sysconfig docs ↵Adam Turner2024-01-111-2/+2
| | | | | | | | | | | | | | (GH-108018) (#110214) * Add new installation path functions subsection * Add content from install/index to sysconfig * Fix table * Update note about installers * Clean up the list of schemes, remove references to Distutils. (cherry picked from commit f16e81f368d08891e28dc1f038c1826ea80d7801)
* [3.11] gh-113664: Improve style of Big O notation (GH-113695) (GH-113910)Serhiy Storchaka2024-01-101-1/+1
| | | | Use cursive to make it looking like mathematic formulas. (cherry picked from commit a8629816c6c0e6770248a60529fd7c9ba08aad55)
* [3.11] gh-112999: Replace the outdated "deprecated" directives with ↵Serhiy Storchaka2023-12-121-3/+1
| | | | | "versionchanged" (GH-113000) (GH-113020) (cherry picked from commit fe9991bb672dd95fb9cd38b5a03180719ac4e722)
* [3.11] gh-101100: Fix sphinx warnings in `usage/cmdline.rst` (GH-110841) ↵Miss Islington (bot)2023-10-141-8/+9
| | | | | | (#110856) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] gh-110631: Fix reST indentation (GH-110724) (#110739)Ezio Melotti2023-10-111-12/+13
| | | | | | * Fix wrong indentation in the other dirs. * Fix more wrong indentation.. (cherry picked from commit 718391f475f2550d99dd794069ca76312f7f6aa6)
* [3.11] Docs: Avoid the deprecated ``.. cmdoption::`` directive (GH-110292) ↵Adam Turner2023-10-052-90/+90
| | | | | | (#110303) [3.11] Docs: Avoid the deprecated ``.. cmdoption::`` directive (GH-110292). (cherry picked from commit 77e9aae3837d9f0cf87461d023896f2c4aeb282f)
* [3.11] gh-109634: Use :samp: role (GH-109635) (GH-109778)Serhiy Storchaka2023-09-292-7/+7
| | | | | (cherry picked from commit 92af0cc580051fd1129c7a86af2cbadeb2aa36dc) Co-authored-by: Jacob Coffee <jacob@z7x.org>
* [3.11] gh-107298: Document PyMODINIT_FUNC macro (#109236) (#109948)Victor Stinner2023-09-271-1/+1
| | | | | | | | | | | gh-107298: Document PyMODINIT_FUNC macro (#109236) Document PyMODINIT_FUNC macro. Remove links to PyAPI_FUNC() and PyAPI_DATA() macros since they are not documented. These macros should only be used to define the Python C API. They should not be used outside Python code base. (cherry picked from commit d7a27e527d7e669d2e45cff80ad725978226477c)
* [3.11] gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) ↵Miss Islington (bot)2023-09-271-8/+8
| | | | | | | | (#109938) gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) (cherry picked from commit 3538930d87e6bdd2bfffa3f674a62cc91d359d31) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.11] gh-109474: Update two Unix packaging URLs (GH-109307) (#109478)Miss Islington (bot)2023-09-161-2/+2
| | | | | | | | | | gh-109474: Update two Unix packaging URLs (GH-109307) update packaging URLs fix a broken URL for fedora RPM packaging guide and fix a URL redirect for Slackware packaging guide. (cherry picked from commit 0b38ce440bd76b3d25b6d042ee9613841fb4a947) Co-authored-by: partev <petrosyan@gmail.com>
* [3.11] Fix misc doc typos (GH-108592) (#108613)Alex Waygood2023-08-291-2/+2
| | | | | (cherry picked from commit 88f1c5b) Co-authored-by: xzmeng <aumo@foxmail.com>
* [3.11] gh-107298: Fix some references in the C API documentation (GH-108072) ↵Serhiy Storchaka2023-08-171-2/+2
| | | | | (GH-108076) (cherry picked from commit f51f0466c07eabc6177c2f64f70c952dada050e8)
* [3.11] GH-92584: Remove reference to Distutils in ``cx_Freeze``'s ↵Adam Turner2023-08-161-5/+4
| | | | | | description (GH-108047) (#108061) Remove reference to Distutils in ``cx_Freeze``'s description. (cherry picked from commit 57fcf96e4f21b8955b3ae4b4d70e4b756949712f)
* [3.11] GH-92584: Redirect macOS package installation to the PPUG (GH-108044) ↵Miss Islington (bot)2023-08-161-6/+2
| | | | | | | | (#108059) GH-92584: Redirect macOS package installation to the PPUG (GH-108044) (cherry picked from commit 902864256cb261428ae9682ca0ffddd597e1f894) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] gh-106909: Use role :const: for referencing module constants ↵Serhiy Storchaka2023-07-211-2/+2
| | | | | (GH-106910) (GH-106957) (cherry picked from commit 4b9948617f91175783609769aa6160e5b49b9ccc)
* [3.11] gh-106892: Use roles :data: and :const: for referencing module ↵Serhiy Storchaka2023-07-211-1/+1
| | | | | variables (GH-106894) (GH-106955) (cherry picked from commit d036db728ea3d54509cbad06df74e2d9a31fbec8)
* [3.11] gh-106919: Use role :c:macro: for referencing the C "constants" ↵Serhiy Storchaka2023-07-211-4/+4
| | | | | (GH-106920) (GH-106952) (cherry picked from commit fcc816dbff7ca66c26f57a506e4d2330fe41d0ff)
* [3.11] GH-103484: Fix redirected permanently URLs (GH-104001) (#104088)Rafael Fontenelle2023-05-023-3/+3
| | | | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Oleg Iarygin <dralife@yandex.ru> Fix redirected permanently URLs (#104001)
* [3.11] Change 'dependant' to 'dependent' (GH-103745) (#103754)Miss Islington (bot)2023-04-241-1/+1
| | | | Co-authored-by: Christopher Chavez <chrischavez@gmx.us>
* GH-83893: Cross reference env. vars and -X command line options (GH-103414)Miss Islington (bot)2023-04-161-6/+12
| | | | | | (cherry picked from commit d65ed693a8a13a2a7f9b201bda1224d6ae5fcf0e) Co-authored-by: Furkan Onder <furkanonder@protonmail.com> Co-authored-by: Erlend E. Aasland
* gh-101100: Documenting --prefix and --exec-prefix. (GH-102695)Miss Islington (bot)2023-03-152-1/+17
| | | | | | (cherry picked from commit 61b9ff35cbda0cc59816951a17de073968fc25c6) Co-authored-by: Julien Palard <julien@palard.fr> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* [3.11] gh-102354: change python3 to python in docs examples (GH-102696) ↵Miss Islington (bot)2023-03-141-1/+1
| | | | | | | | (#102697) gh-102354: change python3 to python in docs examples (GH-102696) (cherry picked from commit 80abd62647b2a36947a11a6a8e395061be6f0c61) Co-authored-by: Paul Watson <paul.hermeneutic@gmail.com>
* gh-101467: Correct py.exe handling of prefix matches and cases when only one ↵Miss Islington (bot)2023-02-011-5/+30
| | | | | | | runtime is installed (GH-101468) (cherry picked from commit eda60916bc88f8af736790ffd52381e8bb83ae83) Co-authored-by: Steve Dower <steve.dower@python.org>
* Fix trivial typo in shebang example (GH-101385)Miss Islington (bot)2023-01-291-1/+1
| | | | | | The example was showing the current version, but should be pinned to 3.7 to match the example command. (cherry picked from commit 666c0840dcac9941fa41ec619fef8d45cd849a0b) Co-authored-by: socal-nerdtastic <37753609+socal-nerdtastic@users.noreply.github.com>
* gh-100247: Improve documentation for custom shebang commands in py.exe ↵Miss Islington (bot)2023-01-161-4/+5
| | | | | | | launcher (GH-101083) (cherry picked from commit 30753c37c6d00929af6afb5e0bc20bed4656d6b6) Co-authored-by: Steve Dower <steve.dower@python.org>
* gh-100247: Fix py.exe launcher not using entire shebang command for finding ↵Miss Islington (bot)2023-01-131-12/+27
| | | | | | | custom commands (GH-100944) (cherry picked from commit 468c3bf79890ef614764b4e7543608876c792794) Co-authored-by: Steve Dower <steve.dower@python.org>
* gh-98692: Enable treating shebang lines as executables in py.exe launcher ↵Miss Islington (bot)2022-10-311-1/+7
| | | | | | | (GH-98732) (cherry picked from commit 88297e2a8a75898228360ee369628a4a6111e2ee) Co-authored-by: Steve Dower <steve.dower@python.org>
* [3.11] Change links to label refs (GH-98454) (#98725)Stanley2022-10-261-2/+2
| | | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> (cherry picked from commit 268129a74f01adb7bb14cd71d1f38378e39d304d)
* [3.11] [doc] Refresh the venv introduction documentation, and correct the ↵Vinay Sajip2022-10-191-42/+0
| | | | | | st… (GH-98465) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Phil Elson <pelson.pub@gmail.com>
* [3.11] Docs: Fix backtick errors found by sphinx-lint (GH-97998) (#98371)C.A.M. Gerlach2022-10-173-9/+9
| | | | | | | | Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>. (cherry picked from commit fa2d43e5184f5eaf3391844ec2400342a1b2ead4) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] Remove extra spaces in custom openSSL documentation. (GH-93568) (#98007)Miss Islington (bot)2022-10-071-10/+10
| | | | | | | | Remove extra spaces in custom openSSL documentation. (GH-93568) (cherry picked from commit 4875433682ffec2694647ac43f1b21f5ad73fd25) Co-authored-by: Xiao Chen <chenxiao_7@163.com> Co-authored-by: Xiao Chen <chenxiao_7@163.com>
* gh-97754: Update doc for default location of per-user installs on Windows ↵Miss Islington (bot)2022-10-041-3/+6
| | | | | | | (GH-97756) (cherry picked from commit a120b9f25d037a1c794df731f8cc6a2898a9165e) Co-authored-by: Ben Faulhaber <111227622+faulhaberben@users.noreply.github.com>
* gh-96959: Update more HTTP links (GH-97536)Miss Islington (bot)2022-09-271-1/+1
| | | | | | | Use HTTPS for documents which are available by both HTTP and HTTPS links, but there is no redirection from HTTP to HTTPS or vice versa. (cherry picked from commit dd53b79de0ea98af6a11481217a961daef4e9774) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.11] gh-95778: CVE-2020-10735: Prevent DoS by very large int() (#96500)Gregory P. Smith2022-09-021-0/+12
| | | | | | | | | | | | | | | | | | Integer to and from text conversions via CPython's bignum `int` type is not safe against denial of service attacks due to malicious input. Very large input strings with hundred thousands of digits can consume several CPU seconds. This PR comes fresh from a pile of work done in our private PSRT security response team repo. This backports https://github.com/python/cpython/pull/96499 aka 511ca9452033ef95bc7d7fc404b8161068226002 Signed-off-by: Christian Heimes [Red Hat] <christian@python.org> Tons-of-polishing-up-by: Gregory P. Smith [Google] <greg@krypto.org> Reviews via the private PSRT repo via many others (see the NEWS entry in the PR). <!-- gh-issue-number: gh-95778 --> * Issue: gh-95778 <!-- /gh-issue-number --> I wrote up [a one pager for the release managers](https://docs.google.com/document/d/1KjuF_aXlzPUxTK4BMgezGJ2Pn7uevfX7g0_mvgHlL7Y/edit#).
* gh-95155: Update "Using Python on a Mac" documentation (GH-95284) (GH-95742)Miss Islington (bot)2022-08-061-3/+4
| | | | | | Co-authored-by: Łukasz Langa <lukasz@langa.pl> (cherry picked from commit d25ff1f61387edd65a91b3930b12bcf4d734e8a1) Co-authored-by: Howie Zhao <howiezhaohr@hotmail.com>
* [3.11] gh-91838: Use HTTPS links in docs for resources which redirect to ↵Serhiy Storchaka2022-08-042-2/+2
| | | | | | | | | | | | HTTPS (GH-95527) (GH-95643) If an HTTP link is redirected to a same looking HTTPS link, the latter can be used directly without changes in readability and behavior. It protects from a men-in-the-middle attack. This change does not affect Python examples.. (cherry picked from commit f79547a429d5c90af83a0da821e082cba20d4712) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* gh-94399: Restore PATH search behaviour of py.exe launcher for ↵Miss Islington (bot)2022-08-031-0/+5
| | | | | | | '/usr/bin/env' shebang lines (GH-95582) (cherry picked from commit 67840edb2851c6d4ca65d8389327d8a6dc06255a) Co-authored-by: Steve Dower <steve.dower@python.org>
* gh-92219: Clarify that some options to the installer may break the install ↵Miss Islington (bot)2022-08-021-5/+9
| | | | | | | (GH-95548) (cherry picked from commit d2c1a9c76c001b18c14e50779b0ee41ea4ccf0b3) Co-authored-by: Steve Dower <steve.dower@python.org>
* [3.11] gh-95415: Make availability directive consistent (GH-95416) (GH-95438)Christian Heimes2022-08-011-1/+1
| | | Co-authored-by: Christian Heimes <christian@python.org>
* GH-95029: Describe Windows Store package isolation and redirection in more ↵Miss Islington (bot)2022-07-211-3/+31
| | | | | | | detail (GH-95030) (cherry picked from commit b1924b10069fb797845284552fb9da931b1ffdb9) Co-authored-by: Anthony Shaw <anthony.p.shaw@gmail.com>
* Docs: remove redundant "adverb-adjective" hyphens from compound modifiers ↵Miss Islington (bot)2022-07-051-2/+2
| | | | | | | | (GH-94551) (GH-94557) Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021 (cherry picked from commit 3440d197a55800ecceea3e115e44b4262411359c) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* gh-93851: Fix all broken links in Doc/ (GH-93853) (GH-94076)Miss Islington (bot)2022-06-213-6/+8
| | | | | (cherry picked from commit f62ff97f31a775cc7956adeae32c14e7c85bdc15) Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>