Skip to content

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

Merged
vstinner merged 17 commits intopython:mainfrom
smontanaro:make-help
Mar 7, 2024
Merged

gh-106259: add minimal help target to Makefile#106260
vstinner merged 17 commits intopython:mainfrom
smontanaro:make-help

Conversation

@smontanaro
Copy link
Copy Markdown
Contributor

@smontanaro smontanaro commented Jun 30, 2023 •
edited by bedevere-bot
Loading

Partially adding a help target, but partially just getting familiar @CAM-Gerlach's git new alias.

@bedevere-bot bedevere-bot mentioned this pull request Jun 30, 2023
Closed
merwok
merwok reviewed Jul 1, 2023
View reviewed changes
Comment thread Makefile.pre.in Outdated
@vstinner
Copy link
Copy Markdown
Member

vstinner commented Jul 2, 2023

What about putting the documentation there instead? https://docs.python.org/dev/using/configure.html#python-build-system

@smontanaro
Copy link
Copy Markdown
Contributor Author

smontanaro commented Jul 2, 2023

My intent was to put more elaborate target documentation somewhere. Haven't started writing anything yet. Thanks for the suggested destination.

@itamaro itamaro added the build The build process and cross-build label Jul 10, 2023
@smontanaro
Copy link
Copy Markdown
Contributor Author

smontanaro commented Feb 12, 2024

What about putting the documentation there instead? https://docs.python.org/dev/using/configure.html#python-build-system

I will look into that as well. Having a "make help" command you can execute when you just need a quick reminder is often helpful. And, it's always right at your fingertips.

@merwok merwok changed the title gh-106259: add minimal help target gh-106259: add minimal help target to Makefile Feb 12, 2024
@smontanaro
Copy link
Copy Markdown
Contributor Author

smontanaro commented Feb 13, 2024

I made a quick, crude pass at expanding the makefile targets in Doc/using/configure.rst. Some descriptions are essentially unchanged. Other bits I actually expanded on in a hopefully useful way. This still needs more work, but I'm done typing for today, so I'll leave it for now. Feel free to suggest further edits.

hugovk
hugovk reviewed Feb 13, 2024
View reviewed changes
Comment thread Doc/using/configure.rst Outdated
Comment thread Doc/using/configure.rst Outdated
smontanaro and others added 2 commits February 14, 2024 07:47
@smontanaro @hugovk
Apply suggestions from code review
e487a7b 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@smontanaro
More edits
ad277c4
vstinner
vstinner reviewed Feb 15, 2024
View reviewed changes
Comment thread Doc/using/configure.rst Outdated
Comment thread Makefile.pre.in Outdated
Comment thread Makefile.pre.in Outdated
vstinner
vstinner reviewed Feb 18, 2024
View reviewed changes
Comment thread Makefile.pre.in Outdated
Comment thread Makefile.pre.in Outdated
vstinner
vstinner reviewed Feb 18, 2024
View reviewed changes
Comment thread Doc/using/configure.rst Outdated
smontanaro and others added 2 commits February 18, 2024 11:24
@smontanaro @vstinner
Update Makefile.pre.in
dce3980 
Co-authored-by: Victor Stinner <vstinner@python.org>
@smontanaro @vstinner
Apply suggestions from code review
62e3d55 
Co-authored-by: Victor Stinner <vstinner@python.org>
vstinner
vstinner reviewed Feb 18, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall, the change LGTM. I just have some minor remarks.

cc @erlend-aasland @corona10: Do you want to review these changes?

Comment thread Makefile.pre.in Outdated
@smontanaro
Copy link
Copy Markdown
Contributor Author

smontanaro commented Feb 24, 2024

Any further comments on this @vstinner or @erlend-aasland, or can we push this to completion?

@erlend-aasland
Copy link
Copy Markdown
Contributor

erlend-aasland commented Feb 24, 2024

I'll let @hugovk, @vstinner and @merwok decide and land, since they've been following up this PR :)

@erlend-aasland erlend-aasland removed their request for review February 24, 2024 20:23
hugovk
hugovk reviewed Feb 24, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Some small bits and pieces:

Comment thread Makefile.pre.in Outdated
Comment thread Doc/using/configure.rst Outdated
Comment thread Doc/using/configure.rst Outdated
Comment thread Doc/using/configure.rst Outdated
Comment thread Doc/using/configure.rst Outdated
Comment thread Doc/using/configure.rst Outdated
@smontanaro @hugovk
Apply suggestions from code review
93013f1 
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
vstinner
vstinner approved these changes Mar 6, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

I would prefer to sort targets in make list-targets but it's a minor issue.

@smontanaro
Copy link
Copy Markdown
Contributor Author

smontanaro commented Mar 7, 2024

Thanks. Can someone merge?

@vstinner vstinner merged commit d9ccde2 into python:main Mar 7, 2024
@vstinner
Copy link
Copy Markdown
Member

vstinner commented Mar 7, 2024

Merged, thanks @smontanaro!

adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 25, 2024
@smontanaro @erlend-aasland
@hugovk @vstinner @adorilson
pythongh-106259: Add minimal help target to Makefile (python#106260)
fb3d535 
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
@smontanaro @erlend-aasland
@hugovk @vstinner @diegorusso
pythongh-106259: Add minimal help target to Makefile (python#106260)
00fc623 
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@merwok merwok merwok left review comments

@vstinner vstinner vstinner approved these changes

@hugovk hugovk hugovk approved these changes

@corona10 corona10 Awaiting requested review from corona10 corona10 is a code owner

Assignees

No one assigned

Labels

build The build process and cross-build skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@smontanaro @vstinner @erlend-aasland @merwok @hugovk @itamaro @bedevere-bot