mkmf: Add the extra option --with-verbose to enable verbose mode.
#7863
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
junaruga
commented
May 25, 2023
nobu
reviewed
May 26, 2023
nobu
reviewed
May 26, 2023
This commit is to add an extra option to enable verbose mode (V=1) in the generated `Makefile` at runtime of the Ruby to print compiler command lines by the commands below when building native extensions. It's possible to enable the verbose mode by setting the environment variable `MAKEFLAGS="V=1"`[1] implemented in GNU make. However, I wanted to make a consistent user-interface not depending on the specific make's implementation. ``` $ ruby /path/to/extconf.rb -- --with-verbose ``` You can also add the extra option via rake-compiler gem. ``` $ rake compiler -- --with-verbose ``` If the extra option is not given, the value of the `RbConfig::CONFIG["MKMF_VERBOSE"]` enabled by the configure option below is used. ``` $ ./configure --enable-mkmf-verbose ``` For the unit tests, updated the following files. * The `test/mkmf/test_configuration.rb` was created to test the cases with the `configuration` method and this implementation. * Updated the `TestMkmf#assert_separately` to set the extra arguments in `test/mkmf/base.rb`. Updated tests using the `assert_separately`. * Added tests for `MakeMakefile#with_config` in the `test/mkmf/test_config.rb`. [1] https://www.gnu.org/software/make/manual/html_node/Variables_002fRecursion.html Fixes [Bug #19695] Co-authored-by: Nobuyoshi Nakada <nobu@ruby-lang.org>
junaruga
force-pushed
the
wip/mkmf-verbose-runtime
branch
from
c89ac67
to
49ea4bb
Compare
junaruga
commented
May 26, 2023
| def assert_separately(args, src, *rest, **options) | ||
| super(args + ["-r#{__FILE__}"], "extend TestMkmf::Base; setup\nEND{teardown}\n#{src}", *rest, **options) | ||
| def assert_separately(args, extra_args, src, *rest, **options) | ||
| super(args + ["-r#{__FILE__}"] + %w[- --] + extra_args, |
There was a problem hiding this comment.
In this part, I wanted to write args + %w[-r#{__FILE__} - --] + extra_args. However, I saw the #{__FILE__} was not converted to the value. So, the ["-r#{__FILE__}"] + %w[- --] is a bit compromised way.
$ ruby -v
ruby 3.3.0dev (2023-05-25T12:45:21Z wip/mkmf-verbose-r.. cbeba2ed16) [x86_64-linux]
$ which irb
~/.local/ruby-cbeba2ed16/bin/irb
$ irb
irb(main):001:0> %w[-r#{__FILE__} - --]
=> ["-r\#{__FILE__}", "-", "--"]
irb(main):002:0> %[-r#{__FILE__} - --]
=> "-r(irb) - --"
|
I rebased, fixing the review items. Thanks for that. I squashed the 3 commits to 1 commit. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Ruby ticket is https://bugs.ruby-lang.org/issues/19695.
This PR is to add the new extra argument
--with-verboseto themkmf.rb, and the PR has 3 commits.--with-verboseto enable verbose mode.MakeMakefile#with_config.mkmf: Add the extra option
--with-verboseto enable verbose mode.The first commit is the main one of the feature.
This commit is to add an extra option to enable verbose mode (V=1) in the generated
Makefileat runtime of the Ruby to print compiler command lines by the commands below when building native extensions. It's possible to enable the verbose mode by setting the environment variableMAKEFLAGS="V=1"[1] implemented in GNU make. However, I wanted to make a consistent user-interface not depending on the specific make's implementation.You can also add the extra option via rake-compiler gem.
If the extra option is not given, the value of the
RbConfig::CONFIG["MKMF_VERBOSE"]enabled by the configure option below is used.[1] https://www.gnu.org/software/make/manual/html_node/Variables_002fRecursion.html
Co-authored-by: Nobuyoshi Nakada nobu@ruby-lang.org
mkmf: Add tests for
MakeMakefile#with_config.This second commit is to test the
MakeMakefile#with_configthat is used in the main commit. As I couldn't find the test of thewith_config, I created it.mkmf: Add tests to test the verbose mode in MakeMakefile#configuration.
The third commit is the tests to test the use cases of the first commit.