Running CMake should not leave unclean git trace #551
Merged
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
apeforest
approved these changes
Aug 1, 2019
|
@apeforest After this is merged, I will file a pull request to MXNet to upgrade 3rdparty/dmlc-core submodule. No change in MXNet codebase will be necessary. |
hcho3
force-pushed
the
clean_build_config
branch
from
0bd5de2
to
8618090
Compare
larroy
approved these changes
Aug 1, 2019
|
@larroy GNU Make uses |
|
@hcho3 thanks for informing. i haven't face this issue (yet) as i have been using gnu make thus far... |
|
@hcho3 Thanks for fixing this! It's been so annoying. :) |
ChaiBapchya
approved these changes
Aug 2, 2019
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.
Currently, running a build with CMake will overwrite the pre-existing header
include/dmlc/build_config.h, leaving a dirty git trace. The reason for this behavior is described in #432 (review)Unclean git trace is inconvenient. For example, let's say you are working with the XGBoost project contains dmlc-core as a Git submodule. At the root of the XGBoost directory, you run
to switch to
feature_branch. This won't work, because thedmlc-coresubmodule had been modified by the last run of CMake. You'd then have to manually clean out dmlc-core by runningRelated: apache/mxnet#15575
Fix: CMake should create a brand new header that's not under version control. The header under version control is now called
include/dmlc/build_config_default.h, and CMake will generateinclude/dmlc/build_config.h. The generated headerinclude/dmlc/build_config.his also registered in.gitignore, so running CMake will not leave dirty git trace.Detail: CMakeLists.txt will define the symbol
DMLC_CORE_USE_CMAKEto indicate that dmlc-core is being built with CMake, not GNU Make. This symbol won't appear when the user opts for GNU Make.cc @larroy @apeforest