Skip to content
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

Jump to bottom

Improve help for make command #33489

Merged
merged 1 commit into from
May 12, 2016
Merged

Improve help for make command #33489

merged 1 commit into from
May 12, 2016

Conversation

GuillaumeGomez
Copy link
Member

@hanna-kruppe
Copy link
Contributor

hanna-kruppe commented May 7, 2016 •
edited
Loading

Some similar information is in CONTRIBUTING.md in the "Useful targets" section. Perhaps these targets should be added there?

@GuillaumeGomez
Copy link
Member Author

I think the makefile's readme should be on its own. However the point here is just to open the debate. :)

@alexcrichton
Copy link
Member

Could this be merged in perhaps some other documentation? It'd be kinda unfortunate to have another top-level file dedicated to a system that's being phased out.

@GuillaumeGomez
Copy link
Member Author

@alexcrichton: Absolutely, where would you want to add it? Any file in mind? The one @rkruppe proposed doesn't seem to be a very good fit.

@alexcrichton
Copy link
Member

I believe we already have the header of Makefile.in, make help, and make tips lying around.

@steveklabnik
Copy link
Member

r? @alexcrichton

Since you care about where this is located, I'll let you take this one 😄

@GuillaumeGomez
Copy link
Member Author

Updated. So I extended make help and added a help message if you enter an invalid make rule.

@GuillaumeGomez GuillaumeGomez changed the title Add beginning of a "HOWTO" for make commands Improve help for make command May 10, 2016
alexcrichton
alexcrichton reviewed May 10, 2016
View reviewed changes
Makefile.in
@@ -257,3 +271,9 @@ ifneq ($(strip $(findstring TAGS.emacs,$(MAKECMDGOALS)) \
CFG_INFO := $(info cfg: including ctags rules)
include $(CFG_SRC_DIR)mk/ctags.mk
endif

.DEFAULT:
Copy link
Member

Choose a reason for hiding this comment

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

Does this break a bare make?

Copy link
Member Author

Choose a reason for hiding this comment

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

It starts as expected.

Copy link
Member

Choose a reason for hiding this comment

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

What does this end up doing? Is this just to translate make foo into a help message here?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, more than this. If you enter an invalid rules, this rule will be called.

@GuillaumeGomez
Copy link
Member Author

Updated.

@alexcrichton
Copy link
Member

@bors: r+ 0619eeb

@alexcrichton
Copy link
Member

@bors: rollup

GuillaumeGomez added a commit to GuillaumeGomez/rust that referenced this pull request May 11, 2016
@GuillaumeGomez
Rollup merge of rust-lang#33489 - GuillaumeGomez:howto, r=alexcrichton
3bb96ab 
Improve help for make command

r? @steveklabnik
@GuillaumeGomez GuillaumeGomez mentioned this pull request May 11, 2016
Merged
bors added a commit that referenced this pull request May 11, 2016
@bors
Auto merge of #33562 - GuillaumeGomez:rollup, r=steveklabnik
22ac88f 
Rollup of 3 pull requests

- Successful merges: #33401, #33489, #33558
- Failed merges: #33342, #33475, #33517
@bors bors merged commit 0619eeb into rust-lang:master May 12, 2016
@GuillaumeGomez GuillaumeGomez deleted the howto branch November 24, 2017 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@alexcrichton alexcrichton

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@GuillaumeGomez @hanna-kruppe @alexcrichton @steveklabnik @bors