summaryrefslogtreecommitdiffstats
path: root/Doc/using
Commit message (Collapse)AuthorAgeFilesLines
* gh-99289: Add COMPILEALL_OPTS to Makefile (#99291)Victor Stinner2022-11-141-0/+7
| | | | | | | | Add COMPILEALL_OPTS variable in Makefile to override compileall options (default: -j0) in "make install". Also merge the compileall commands into a single command building PYC files for the all optimization levels (0, 1, 2) at once. Co-authored-by: Gregory P. Smith <greg@krypto.org>
* Support comparing two sets of pystats (GH-98816)Michael Droettboom2022-11-041-1/+2
| | | | | | | | | | This adds support for comparing pystats collected from two different builds. - The `--json-output` can be used to load in a set of raw stats and output a JSON file. - Two of these JSON files can be provided on the next run, and then comparative results between the two are output.
* gh-98692: Enable treating shebang lines as executables in py.exe launcher ↵Steve Dower2022-10-311-1/+7
| | | | (GH-98732)
* gh-96143: Improve perf profiler docs (#96445)Erlend E. Aasland2022-10-271-7/+10
|
* docs: Change links to label refs (#98454)Stanley2022-10-261-2/+2
| | | Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* [doc] Refresh the venv introduction documentation, and correct the statement ↵Phil Elson2022-10-191-42/+0
| | | | | about VIRTUAL_ENV (GH-98350) Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* Docs: Fix backtick errors found by sphinx-lint (#97998)Hugo van Kemenade2022-10-073-9/+9
| | | Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
* Remove extra spaces in custom openSSL documentation. (#93568)Xiao Chen2022-10-071-10/+10
|
* gh-97754: Update doc for default location of per-user installs on Windows ↵Ben Faulhaber2022-10-041-3/+6
| | | | (GH-97756)
* gh-96959: Update more HTTP links (GH-97536)Serhiy Storchaka2022-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.
* gh-96512: Update int_max_str docs to say 3.11 (#96942)Gregory P. Smith2022-09-191-2/+2
| | | | It was unknown if it'd be before 3.11.0 when creating the original changes. It's in 3.11rc2, so 3.11 it is.
* gh-89536: Use ThinLTO policy if possible (gh-96766)Dong-hee Na2022-09-161-0/+3
|
* gh-95778: CVE-2020-10735: Prevent DoS by very large int() (#96499)Gregory P. Smith2022-09-021-0/+13
| | | | | | | | | | | | | | | | 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. 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#). Much of that text wound up in the Issue. Backports PRs already exist. See the issue for links.
* gh-96143: Add some comments and minor fixes missed in the original PR (#96433)Pablo Galindo Salgado2022-08-301-0/+2
| | | | | | | | | * gh-96132: Add some comments and minor fixes missed in the original PR * Update Doc/using/cmdline.rst Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com> Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
* gh-96143: Allow Linux perf profiler to see Python calls (GH-96123)Pablo Galindo Salgado2022-08-301-0/+13
| | | | | | | :warning: :warning: Note for reviewers, hackers and fellow systems/low-level/compiler engineers :warning: :warning: If you have a lot of experience with this kind of shenanigans and want to improve the **first** version, **please make a PR against my branch** or **reach out by email** or **suggest code changes directly on GitHub**. If you have any **refinements or optimizations** please, wait until the first version is merged before starting hacking or proposing those so we can keep this PR productive.
* gh-90536: Fix link syntax to LLVM-BOLT repository (gh-96141)Dong-hee Na2022-08-201-1/+1
|
* gh-90536: Add support for the BOLT post-link binary optimizer (gh-95908)Kevin Modzelewski2022-08-181-1/+20
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * Add support for the BOLT post-link binary optimizer Using [bolt](https://github.com/llvm/llvm-project/tree/main/bolt) provides a fairly large speedup without any code or functionality changes. It provides roughly a 1% speedup on pyperformance, and a 4% improvement on the Pyston web macrobenchmarks. It is gated behind an `--enable-bolt` configure arg because not all toolchains and environments are supported. It has been tested on a Linux x86_64 toolchain, using llvm-bolt built from the LLVM 14.0.6 sources (their binary distribution of this version did not include bolt). Compared to [a previous attempt](https://github.com/faster-cpython/ideas/issues/224), this commit uses bolt's preferred "instrumentation" approach, as well as adds some non-PIE flags which enable much better optimizations from bolt. The effects of this change are a bit more dependent on CPU microarchitecture than other changes, since it optimizes i-cache behavior which seems to be a bit more variable between architectures. The 1%/4% numbers were collected on an Intel Skylake CPU, and on an AMD Zen 3 CPU I got a slightly larger speedup (2%/4%), and on a c6i.xlarge EC2 instance I got a slightly lower speedup (1%/3%). The low speedup on pyperformance is not entirely unexpected, because BOLT improves i-cache behavior, and the benchmarks in the pyperformance suite are small and tend to fit in i-cache. This change uses the existing pgo profiling task (`python -m test --pgo`), though I was able to measure about a 1% macrobenchmark improvement by using the macrobenchmarks as the training task. I personally think that both the PGO and BOLT tasks should be updated to use macrobenchmarks, but for the sake of splitting up the work this PR uses the existing pgo task. * Simplify the build flags * Add a NEWS entry * Update Makefile.pre.in Co-authored-by: Dong-hee Na <donghee.na92@gmail.com> * Update configure.ac Co-authored-by: Dong-hee Na <donghee.na92@gmail.com> * Add myself to ACKS * Add docs * Other review comments * fix tab/space issue * Make it more clear that --enable-bolt is experimental * Add link to bolt's github page Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
* gh-95155: Update "Using Python on a Mac" documentation (GH-95284)Howie Zhao2022-08-061-3/+4
| | | Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* gh-93744: Remove configure --with-cxx-main option (#95651)Victor Stinner2022-08-051-19/+1
| | | | | | | | | | | | Remove the "configure --with-cxx-main" build option: it didn't work for many years. Remove the MAINCC variable from configure and Makefile. The MAINCC variable was added by the issue gh-42471: commit 0f48d98b740110a672b62d467af192ec160e56ba. Previously, --with-cxx-main was named --with-cxx. Keep CXX and LDCXXSHARED variables, even if they are no longer used by Python build system.
* Remove unnecessary text from documentation. (GH-95670)fluesvamp2022-08-041-1/+1
|
* gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS ↵Serhiy Storchaka2022-08-042-2/+2
| | | | | | | | | | (GH-95527) 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.
* gh-94399: Restore PATH search behaviour of py.exe launcher for ↵Steve Dower2022-08-031-0/+5
| | | | '/usr/bin/env' shebang lines (GH-95582)
* gh-92219: Clarify that some options to the installer may break the install ↵Steve Dower2022-08-011-5/+9
| | | | (GH-95548)
* gh-95415: Make availability directive consistent (GH-95416)Christian Heimes2022-07-291-1/+1
|
* gh-85454: Remove distutils documentation (#95239)Christian Heimes2022-07-252-6/+5
| | | | Most places now refer to setuptools or link to setuptools documentation. Some examples like zipapp need to be updated later.
* GH-95029: Describe Windows Store package isolation and redirection in more ↵Anthony Shaw2022-07-211-3/+31
| | | | detail (GH-95030)
* Docs: remove redundant "adverb-adjective" hyphens from compound modifiers ↵Ned Batchelder2022-07-051-2/+2
| | | | | (GH-94551) Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
* gh-93851: Fix all broken links in Doc/ (GH-93853)Oleg Iarygin2022-06-213-6/+8
|
* gh-90539: doc: Expand on what should not go into CFLAGS, LDFLAGS (#92754)Matthias Köppe2022-06-201-0/+18
|
* gh-90300: split --help output into separate options (#30331)Éric2022-06-011-1/+26
| | | | | | Make --help output shorter and add new help options. --help-env, --help-xoptions and --help-all command-line options are added to complement --help.
* gh-93103: Enhance PyConfig.parser_debug documentation (#93186)Victor Stinner2022-05-242-2/+10
| | | | Document that -d option and PYTHONDEBUG env var require a debug build of Python. Also mention them in the debug build documentation.
* gh-76773: Update docs mentioning no-longer-supported Windows versions & ↵CAM Gerlach2022-05-101-83/+51
| | | | features (GH-92529)
* gh-88750: Remove the PYTHONTHREADDEBUG env var support. (#92509)Gregory P. Smith2022-05-092-10/+0
| | | | Remove the `PYTHONTHREADDEBUG` env var support. Remove no-op dprintf() macro calls.
* Doc: Update py2app link. (#91585)Julien Palard2022-05-091-1/+1
| | | See: https://mail.python.org/archives/list/docs@python.org/thread/KDVFGNGGUGGPVRZT7WZYHHWXCRS2GEN7/
* gh-86019: Add table for Windows installer options (GH-91809)slateny2022-05-091-5/+18
|
* gh-57684: Add -P cmdline option and PYTHONSAFEPATH env var (#31542)Victor Stinner2022-05-051-1/+30
| | | | | | | | | | | | Add the -P command line option and the PYTHONSAFEPATH environment variable to not prepend a potentially unsafe path to sys.path. * Add sys.flags.safe_path flag. * Add PyConfig.safe_path member. * Programs/_bootstrap_python.c uses config.safe_path=0. * Update subprocess._optim_args_from_interpreter_flags() to handle the -P command line option. * Modules/getpath.py sets safe_path to 1 if a "._pth" file is present.
* gh-91998: 'WebAssemby' to 'WebAssembly' (#92040)vainaijr2022-05-021-2/+2
|
* gh-89479: Export _Py_GetSpecializationStats() internal function (#92011)Victor Stinner2022-04-281-1/+1
| | | | | | When Python is built with "./configure --enable-pystats" (if the Py_STATS macro is defined), the _Py_GetSpecializationStats() function must be exported, since it's used by the _opcode extension which is built as a shared library.
* gh-84461: Add --enable-wasm-pthreads and more file systems (GH-91820)Christian Heimes2022-04-231-0/+6
|
* gh-89373: _Py_Dealloc() checks tp_dealloc exception (#32357)Victor Stinner2022-04-211-0/+1
| | | | If Python is built in debug mode, _Py_Dealloc() now ensures that the tp_dealloc function leaves the current exception unchanged.
* gh-78607: Replace __ltrace__ with __lltrace__ (GH-91619)Dennis Sweeney2022-04-161-1/+1
|
* gh-91156: Fix `encoding="locale"` in UTF-8 mode (GH-70056)Inada Naoki2022-04-141-1/+1
|
* bpo-40280: Add --enable-wasm-dynamic-linking (GH-32253)Christian Heimes2022-04-041-3/+26
|
* Demonstrate `py --list` in the quickstart section of the Windows doc page ↵Christian Clauss2022-04-041-0/+6
| | | | (GH-29383)
* bpo-45847: Port _tkinter to PY_STDLIB_MOD (GH-31698)Erlend Egeberg Aasland2022-03-311-8/+0
| | | | | - Remove ``--with-tclk-*`` options from `configure` - Use pkg-config to detect `_tkinter` dependencies (Tcl/Tk, X11) - Manual override via environment variables `TCLTK_CFLAGS` and `TCLTK_LIBS`
* bpo-46566: Add new py.exe launcher implementation (GH-32062)Steve Dower2022-03-281-2/+61
|
* bpo-31582: Created a new documentation section describing sys.path ↵Russel Webber2022-03-231-22/+3
| | | | initialization (GH-31082)
* bpo-36557: Updated wording for using/windows (GH-31457)slateny2022-02-221-2/+2
|
* Optimize images by IMGbot (GH-21348)Manish Kumar ⛄2022-02-041-0/+0
| | | Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>
* bpo-44934: Add optional feature AppendPath to Windows MSI installer (GH-27889)bneuburg2022-01-181-3/+7
| | | The option must be enabled from the command line