Skip to content

gh-106259: add minimal help target to Makefile #106260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vstinner merged 17 commits into from
Mar 7, 2024
Merged

gh-106259: add minimal help target to Makefile #106260

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
e68994a
add minimal help target
smontanaro Jun 30, 2023
88a1fcc
+comment
smontanaro Jun 30, 2023
246b3fc
Merge branch 'main' into make-help
erlend-aasland Jan 12, 2024
85d1e08
move distclean to follow clean, tweak wording slightly
smontanaro Feb 12, 2024
2d276a7
slight expansion of Main Makefile targets section
smontanaro Feb 12, 2024
1fbbdd6
Expand a bit on the bullet list...
smontanaro Feb 13, 2024
e487a7b
Apply suggestions from code review
smontanaro Feb 14, 2024
ad277c4
More edits
smontanaro Feb 15, 2024
4f9aa52
link to Generated Files section
smontanaro Feb 16, 2024
b90e200
group by function
smontanaro Feb 16, 2024
a9021fb
more detail about git clean
smontanaro Feb 16, 2024
6cd8563
simplify note of "all" target and give grep command for all targets
smontanaro Feb 17, 2024
dce3980
Update Makefile.pre.in
smontanaro Feb 18, 2024
62e3d55
Apply suggestions from code review
smontanaro Feb 18, 2024
ec07aa5
incorporate Victor's recent suggestions with minor changes
smontanaro Feb 18, 2024
54119d1
silence the grep command to keep it from infecting the target list
smontanaro Feb 18, 2024
93013f1
Apply suggestions from code review
smontanaro Feb 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Apply suggestions from code review 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
  • Loading branch information
@smontanaro @hugovk
smontanaro and hugovk authored Feb 24, 2024
commit 93013f1eef23ec2773f35a85e9119108cb02ec71
12 changes: 6 additions & 6 deletions Doc/using/configure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -997,15 +997,15 @@ first one defined in the Makefile. By tradition (including in the
CPython project) this is usually the ``all`` target. The
``configure`` script expands an ``autoconf`` variable,
``@DEF_MAKE_ALL_RULE@`` to describe precisely which targets ``make
all`` will build. The three choices are
all`` will build. The three choices are:

* ``profile-opt`` (configured with ``--enable-optimizations``)
* ``build_wasm`` (configured with ``--with-emscripten-target``)
* ``build_all`` (configured without explicitly using either of the others)

Depending on the most recent source file changes, Make will rebuild
any targets (object files and executables) deemed out-of-date,
including running ``configure`` again if necessary, Source/target
including running ``configure`` again if necessary. Source/target
dependencies are many and maintained manually however, so Make
sometimes doesn't have all the information necessary to correctly
detect all targets which need to be rebuilt. Depending on which
Expand All @@ -1027,7 +1027,7 @@ e.g., ``macosx-14.3-arm64-3.12`` or ``linux-x86_64-3.13``.
make profile-opt
^^^^^^^^^^^^^^^^

Build Python using Profile Guided Optimization (PGO). You can use the
Build Python using profile-guided optimization (PGO). You can use the
configure :option:`--enable-optimizations` option to make this the
default target of the ``make`` command (``make all`` or just
``make``).
Expand Down Expand Up @@ -1060,8 +1060,8 @@ make test
Build the ``all`` target and run the Python test suite with the
``--fast-ci`` option. Variables:

* ``TESTOPTS``: additional regrtest command line options.
* ``TESTPYTHONOPTS``: additional Python command line options.
* ``TESTOPTS``: additional regrtest command-line options.
* ``TESTPYTHONOPTS``: additional Python command-line options.
* ``TESTTIMEOUT``: timeout in seconds (default: 10 minutes).


Expand All @@ -1076,7 +1076,7 @@ make regen-all
^^^^^^^^^^^^^^

Regenerate (almost) all generated files. These include (but are not
limited to) bytecode cases, parser generator files, and SBOM file.
limited to) bytecode cases, and parser generator file.
``make regen-stdlib-module-names`` and ``autoconf`` must be run
separately for the remaining `generated files <#generated-files>`_.

Expand Down
2 changes: 1 addition & 1 deletion Makefile.pre.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -649,7 +649,7 @@ all: @DEF_MAKE_ALL_RULE@
# Provide quick help for common Makefile targets.
.PHONY: help
help:
@echo "Run 'make' to build the python executable and extension modules"
@echo "Run 'make' to build the Python executable and extension modules"
@echo ""
@echo "or 'make <target>' where <target> is one of:"
@echo " test run the test suite"
Expand Down