summaryrefslogtreecommitdiffstats
path: root/Doc/using
Commit message (Collapse)AuthorAgeFilesLines
* [3.13] Doc/c-api/memory.rst: extend --without-pymalloc doc with ASan ↵Miss Islington (bot)2025-07-201-0/+3
| | | | | | | | | | | information (GH-136790) (#136799) Extends the documentation for disabling pymalloc with the `--without-pymalloc` flag regarding why it is worth to use it when enabling AddressSanitizer for Python build (which is done, e.g., in CPython's CI builds). (cherry picked from commit d19bb4471331ca2cb87b86e4c904bc9a2bafb044) Co-authored-by: Disconnect3d <dominik.b.czarnota@gmail.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.13] gh-115119: Recommend upstream libmpdec in build requirements ↵Victor Stinner2025-07-031-0/+3
| | | | | | | | | | | | (#136205) (#136245) gh-115119: Recommend upstream libmpdec in build requirements (#136205) (cherry picked from commit b2e498ac26ba4720fa8a6a466aa8416ab69754d7) Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com> Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
* [3.13] gh-135966: Modify iOS testbed to make app_packages a site directory ↵Russell Keith-Magee2025-06-271-3/+8
| | | | | | | (GH-135967) (#136013) The iOS testbed now treats the app_packages folder as a site folder. This ensures it is on the path, but also ensures any .pth files are processed on app startup. (cherry picked from commit b38810bab76c11ea09260a817b3354aebc2af580)
* [3.13] Use replacements to update versions in "Using Python on macOS" ↵Miss Islington (bot)2025-06-161-46/+47
| | | | | | | (GH-130400) (#135587) (cherry picked from commit 21bac3aecd03805ea74ca67a3a291a9eb347588f) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-131531: android.py enhancements to support cibuildwheel ↵Malcolm Smith2025-06-051-0/+9
| | | | | | | | | | | | | (GH-132870) (#135164) Modifies the environment handling and execution arguments of the Android management script to support the compilation of third-party binaries, and the use of the testbed to invoke third-party test code. (cherry picked from commit 2e1544fd2b0cd46ba93fc51e3cdd47f4781d7499) Co-authored-by: Malcolm Smith <smith@chaquo.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
* [3.13] GH-133231: Backport PYTHON_JIT documentation to 3.13 (GH-133539)Brandt Bucher2025-05-061-0/+8
|
* [3.13] gh-102136: Add -m to options that work with -i (GH-119271) (GH-119285)Miss Islington (bot)2025-04-081-3/+9
| | | | | (cherry picked from commit 172690227e771c2e8ab137815073e3a172c08dec) Co-authored-by: Melanie Arbor <hellomelaniec@gmail.com>
* [3.13] gh-131531: Add `android.py package` command (GH-131532) (#131960)Miss Islington (bot)2025-04-011-4/+4
| | | | | | | Adds a `package` entry point to the `android.py` build script to support creating an Android distribution artefact. (cherry picked from commit fe5c4c53e7bc6d780686013eaab17de2237b2176) Co-authored-by: Malcolm Smith <smith@chaquo.com>
* [3.13] Docs: fix shell command formatting (GH-131310) (#131443)Miss Islington (bot)2025-03-191-1/+1
| | | | | | | | Docs: fix shell command formatting (GH-131310) replace "zypper in" with "zypper install" to avoid incorrect highlighting (cherry picked from commit 267c06d6a8290aa299098b4fcd3f270001b01e72) Co-authored-by: partev <petrosyan@gmail.com>
* [3.13] gh-130940: Remove PyConfig.use_system_logger (#131129)Russell Keith-Magee2025-03-131-2/+0
| | | | | | | Removes ``PyConfig.use_system_logger``, resolving an ABI incompatibility introduced in 3.13.2. Changes the default behavior of iOS to *always* direct stdout/stderr to the system log.
* [3.13] gh-129712: Document the wheels tags corresponding to each universal ↵Miss Islington (bot)2025-02-221-8/+14
| | | | | | | | | SDK. (GH-130389) (#130449) Document the architectures supported by macOS universal SDK configuration flags, and add details on wheel tag naming. (cherry picked from commit 474c388740ca5f8060c074f517dd14c54409126f) Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
* [3.13] gh-59149: Setup documentation for IDLE on Linux and add section in ↵Miss Islington (bot)2025-02-122-0/+38
| | | | | | | | | Editors (GH-130003) (#130027) --------- (cherry picked from commit 555ee43d929ad4b917db2caee3f2c10a2636832c) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.13] gh-129438: Update ``--enable-experimental-jit`` section with install ↵Miss Islington (bot)2025-01-301-0/+4
| | | | | | | | | | | | requirements (GH-129450) (#129472) gh-129438: Update ``--enable-experimental-jit`` section with install requirements (GH-129450) Add a note to the `JIT` docs that building CPython with `JIT` requires Python 3.11 or newer. (cherry picked from commit 652f66ac386dad5992c6f7c494871907272503f8) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Brandt Bucher <brandtbucher@gmail.com>
* [3.13] gh-126172: Fix a misleading statement in PYTHON_BASIC_REPL ↵Miss Islington (bot)2025-01-231-1/+1
| | | | | | | | | | documentation (GH-127203) (#129152) gh-126172: Fix a misleading statement in PYTHON_BASIC_REPL documentation (GH-127203) Fix a misleading statement in PYTHON_BASIC_REPL documentation. (cherry picked from commit f18b2264929c56360c868d7ad77508035d751352) Co-authored-by: Michael Kashirin <88917554+mkashirin@users.noreply.github.com>
* [3.13] gh-126925: Modify how iOS test results are gathered (GH-127592) (#127754)Russell Keith-Magee2024-12-091-4/+49
| | | | | | | | Adds a `use_system_log` config item to enable stdout/stderr redirection for Apple platforms. This log streaming is then used by a new iOS test runner script, allowing the display of test suite output at runtime. The iOS test runner script can be used by any Python project, not just the CPython test suite. (cherry picked from commit 2041a95e68ebf6d13f867e214ada28affa830669)
* [3.13] gh-116510: Fix a Crash Due to Shared Immortal Interned Strings ↵Miss Islington (bot)2024-11-121-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | (gh-124865) (gh-125709) (GH-125204) * gh-116510: Fix a Crash Due to Shared Immortal Interned Strings (gh-124865) Fix a crash caused by immortal interned strings being shared between sub-interpreters that use basic single-phase init. In that case, the string can be used by an interpreter that outlives the interpreter that created and interned it. For interpreters that share obmalloc state, also share the interned dict with the main interpreter. This is an un-revert of gh-124646 that then addresses the Py_TRACE_REFS failures identified by gh-124785. (cherry picked from commit f2cb39947093feda3ff85b8dc820922cc5e5f954) Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com> * [3.13] gh-125286: Share the Main Refchain With Legacy Interpreters (gh-125709) They used to be shared, before 3.12. Returning to sharing them resolves a failure on Py_TRACE_REFS builds. --------- Co-authored-by: Eric Snow <ericsnowcurrently@gmail.com>
* Update documentation links to Microsoft's documentation pages (GH-126379)Miss Islington (bot)2024-11-111-7/+7
| | | | | (cherry picked from commit 6e25eb15410f781f632d536d555f38879432522c) Co-authored-by: 谭九鼎 <109224573@qq.com>
* [3.13] gh-126647: `Doc/using/configure.rst`: Add an entry for ↵Miss Islington (bot)2024-11-101-0/+13
| | | | | | | | | | | | | | | | | | ``--enable-experimental-jit`` option (GH-126648) (#126655) gh-126647: `Doc/using/configure.rst`: Add an entry for ``--enable-experimental-jit`` option (GH-126648) Add an entry for the ``--enable-experimental-jit`` option in ``Doc/using/configure.rst``. This was added as an experimental option in CPython 3.13. Possible values for it: * `no` - don't build the JIT. * `yes` - build the JIT. * `yes-off` - build the JIT but disable it by default. * `interpreter` - don't build the JIT but enable tier 2 interpreter instead. (cherry picked from commit f435de6765e0327995850d719534be38c9b5ec49) Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] gh-125766: Docs: minor rewording of installation on Linux section ↵Miss Islington (bot)2024-10-211-4/+4
| | | | | | | (GH-125793) (cherry picked from commit d67bf2d89ab57f94608d7d2cf949dc4a8749485d) Co-authored-by: partev <petrosyan@gmail.com>
* [3.13] Doc: Fix typos (GH-125728) (#125773)Miss Islington (bot)2024-10-211-2/+2
| | | | | (cherry picked from commit ded105a62b9d78717f8dc64652e3903190b585dd) Co-authored-by: ember91 <31469580+ember91@users.noreply.github.com>
* [3.13] gh-112088: aclocal version is updated to 1.16.5 in docs (GH-125457) ↵Miss Islington (bot)2024-10-141-2/+2
| | | | | | | | (#125459) gh-112088: aclocal version is updated to 1.16.5 in docs (GH-125457) (cherry picked from commit 45df264f3ffbc0893cbfd257131d3abe21043786) Co-authored-by: Mikhail Efimov <efimov.mikhail@gmail.com>
* [3.13] gh-124720: Update "Using Python on a Mac" document (GH-124721) (#124775)Miss Islington (bot)2024-09-3010-110/+361
| | | | | | | | | gh-124720: Update "Using Python on a Mac" document (GH-124721) Update "Using Python on a Mac" section of the "Python Setup and Usage" document and include information on installing free-threading support. (cherry picked from commit 4b83c03ce964af7fb204144db9adaa524c113a82) Co-authored-by: Ned Deily <nad@python.org>
* [3.13] Docs: Update and proofread `library/venv.rst` (GH-124121) (#124644)Miss Islington (bot)2024-09-271-121/+0
| | | | | | | | Docs: Update and proofread `library/venv.rst` (GH-124121) (cherry picked from commit 23e812b84ae688a56a1011ed69a0d178c70e35ea) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.13] GH-103484: Fix permanently redirects reported by linkcheck ↵Miss Islington (bot)2024-09-242-3/+3
| | | | | | | | | | | (GH-124144) (#124151) GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) Fix redirects reported by linkcheck, update docs conf.py checks. (cherry picked from commit 0a32c6959c265d21d7c43fe8e4aefc8c0983e85e) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.13] gh-116622: Complete Android documentation (GH-124259) (#124395)Miss Islington (bot)2024-09-243-1/+68
| | | | | | | | | gh-116622: Complete Android documentation (GH-124259) (cherry picked from commit e80dd3035fb805716bc49f9e7e9cab5f83614661) Co-authored-by: Malcolm Smith <smith@chaquo.com> Co-authored-by: Russell Keith-Magee <russell@keith-magee.com> Co-authored-by: T. Wouters <thomas@python.org> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.13] gh-123275: Support `-Xgil=1` and `PYTHON_GIL=1` on non-free-threaded ↵Miss Islington (bot)2024-09-061-4/+3
| | | | | | | | builds (gh-123276) (gh-123753) gh-123275: Support `-Xgil=1` and `PYTHON_GIL=1` on non-free-threaded builds (gh-123276) (cherry picked from commit 84ad264ce602fb263a46a4536377bdc830eea81e) Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
* [3.13] Fix typos in docs, error messages and comments (#122502) (#122606)Alex Waygood2024-09-021-1/+1
| | | | | | | | Fix typos in docs, error messages and comments (#122502) (cherry-picked from commit 46f5a4f9e1781ad8d60eb53bbaf6cd8534a286cd) Signed-off-by: jianghuyiyuan <shuangcui@live.com> Co-authored-by: jianghuyiyuan <shuangcui@live.com>
* [3.13] gh-123492: Remove unnecessary `:func:` parentheses (gh-123493) (#123513)Wei-Hsiang (Matt) Wang2024-08-302-3/+3
|
* [3.13] GH-109975: Copyedit 3.13 What's New: Release Highlights (GH-122958) ↵Miss Islington (bot)2024-08-132-3/+3
| | | | | | | | | (#122971) GH-109975: Copyedit 3.13 What's New: Release Highlights (GH-122958) (cherry picked from commit db6f5e193315a3bbfa7b0b6644203bae3f76b638) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] Doc: cmdline.rst: Include -P and -R in usage (GH-122590) (#122783)Miss Islington (bot)2024-08-071-1/+1
| | | | | | | | | Doc: cmdline.rst: Include -P and -R in usage (GH-122590) * ``-P``: safe path (https://docs.python.org/3/using/cmdline.htmlGH-cmdoption-P) * ``-R``: hash randomization (https://docs.python.org/3/using/cmdline.htmlGH-cmdoption-R) (cherry picked from commit c25898d51e4ec84319b7113d5bf453c6e6519d9c) Co-authored-by: Wim Jeantine-Glenn <hey@wimglenn.com>
* [3.13] gh-121957: Emit audit events for `python -i` and `python -m asyncio` ↵Miss Islington (bot)2024-07-221-0/+9
| | | | | | | | | (GH-121958) (GH-122115) Relatedly, emit the `cpython.run_startup` event from the Python version of `PYTHONSTARTUP` handling. (cherry picked from commit dc93d1125f594ac7aece98558eaf33d09c348519) Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* [3.13] Docs: spelling and grammar fixes (GH-122084) (#122106)Miss Islington (bot)2024-07-221-1/+1
| | | | | | | | | | | Docs: spelling and grammar fixes (GH-122084) Corrected some grammar and spelling issues in documentation. (cherry picked from commit bc264eac3ad14dab748e33b3d714c2674872791f) Co-authored-by: Ville Skyttä <ville.skytta@iki.fi> Co-authored-by: Russell Keith-Magee <russell@keith-magee.com> Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
* [3.13] gh-120522: Apply App Store compliance patch during installation ↵Miss Islington (bot)2024-07-223-0/+51
| | | | | | | | | | (GH-121947) (#122105) gh-120522: Apply App Store compliance patch during installation (GH-121947) Adds a --with-app-store-compliance configuration option that patches out code known to be an issue with App Store review processes. This option is applied automatically on iOS, and optionally on macOS. (cherry picked from commit 728432c8043edc07bb8a24b180a70778fcd35878) Co-authored-by: Russell Keith-Magee <russell@keith-magee.com>
* [3.13] gh-121905: Consistently use "floating-point" instead of "floating ↵Serhiy Storchaka2024-07-191-2/+2
| | | | | point" (GH-121907) (GH-122012) (cherry picked from commit 1a0c7b9ba48a2dffb70bb0c7327abae1d3e87356)
* [3.13] gh-120522: Revert "Add a `--with-app-store-compliance` configure ↵Miss Islington (bot)2024-07-163-51/+0
| | | | | | | | | option to patch out problematic code" (GH-121844) (#121845) This reverts commit 0dfb437a32f9b9a8a0ae61d8c43c47417651f44e prior to the release of 3.13.0b4 to allow for additional review time. (cherry picked from commit f27593a87c344f3774ca73644a11cbd5614007ef) Co-authored-by: Ned Deily <nad@python.org>
* [3.13] gh-120831: Increase the default minimum supported iOS version to 13.0 ↵Miss Islington (bot)2024-07-161-0/+11
| | | | | | | | | | | | (GH-121250) (#121833) gh-120831: Increase the default minimum supported iOS version to 13.0 (GH-121250) Increases the default minimum iOS version to 13.0. (cherry picked from commit 7e91e0dcfe2faab1e1a4630e6f745aa30ca87b3d) Co-authored-by: Russell Keith-Magee <russell@keith-magee.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* [3.13] Docs: fix typo and duplicate word in configure.rst (GH-121410) (#121532)Miss Islington (bot)2024-07-091-2/+2
| | | | | (cherry picked from commit 9ba2a4638d7b620c939face7642b2f53a9fadc4b) Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.13] gh-120522: Add a `--with-app-store-compliance` configure option to ↵Miss Islington (bot)2024-06-303-0/+51
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | patch out problematic code (GH-120984) (#121173) gh-120522: Add a `--with-app-store-compliance` configure option to patch out problematic code (GH-120984) * Add --app-store-compliance configuration option. * Added blurb. * Correct tab-vs-spaces formatting issue. * Correct source file name in docs. * Correct source code reference in Mac docs * Only apply the patch forward, and ensure the working directory is correct. * Make patching reslient to multiple builds. * Documentation fixes found during review * Documentation and configure.ac syntax improvements * Regenerate configure script. * Silence the patch echo output. --------- (cherry picked from commit 48cd104b0cf05dad8958efa9cb9666c029ef9201) Co-authored-by: Russell Keith-Magee <russell@keith-magee.com> Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com> Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com> Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
* [3.13] gh-121101: Document -Wall option (an alias for -Walways) (GH-121102) ↵Miss Islington (bot)2024-06-291-0/+2
| | | | | | | | (#121146) gh-121101: Document -Wall option (an alias for -Walways) (GH-121102) (cherry picked from commit 0a1e8ff9c15675fdc4d07fa6c59f83808bf00798) Co-authored-by: Wim Jeantine-Glenn <jump@wimglenn.com>
* [3.13] docs: fix a few typos identified by codespell (GH-119516) (#119570)Miss Islington (bot)2024-05-261-2/+2
| | | | Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.13] Docs: Add central references to free-threading-related options ↵Miss Islington (bot)2024-05-212-3/+4
| | | | | | | | (GH-119017) (#119367) Docs: Add central references to free-threading-related options (GH-119017) (cherry picked from commit 9fa206aaeccc979a4bd03852ba38c045294a3d6f) Co-authored-by: Brett Simmers <swtaarrs@users.noreply.github.com>
* gh-118518: Rename `PYTHONPERFJITSUPPORT` and `-X perfjit` with underscores ↵Hugo van Kemenade2024-05-071-5/+5
| | | | (#118693)
* gh-115119: Default to --with-system-libmpdec=yes (#118539)Erlend E. Aasland2024-05-061-2/+9
| | | Co-authored-by: Zachary Ware <zachary.ware@gmail.com>
* gh-111201: A new Python REPL (GH-111567)Pablo Galindo Salgado2024-05-051-0/+10
| | | | | | | Co-authored-by: Łukasz Langa <lukasz@langa.pl> Co-authored-by: Marta Gómez Macías <mgmacias@google.com> Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* gh-118518: Allow perf to work without frame pointers (#112254)Pablo Galindo Salgado2024-05-051-0/+24
|
* gh-117225: Document colour use in `doctest` (#118268)Hugo van Kemenade2024-05-011-2/+10
|
* gh-115119: Detect _decimal dependencies using pkg-config (#115406)Erlend E. Aasland2024-04-291-0/+13
| | | pkg-config is supported for libmpdec 4.0.0 and newer.
* gh-117804: Document how to suppress PGO unprofiled source warnings (#117859)Erlend E. Aasland2024-04-151-0/+9
|
* Docs: add link roles with Sphinx extlinks (#117850)Hugo van Kemenade2024-04-152-3/+3
| | | Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* gh-115664: Reorganize versionadded directives for -X options (GH-116304)Serhiy Storchaka2024-04-151-34/+45
| | | | Add the versionadded directives just under the description of the corresponding option.