Adds some documentation specific to the make rule.
#1050
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
I learned the hard way that the `make` build rule does not work out of the box with just any makefile, unlike other rules in this repository. The single `make` example does *not* emphasize this, and it is important for the usability of the rule. These are the things I learned: - the `make( targets = [...])` invocation must at least execute an equivalent of `make install`, since all `out_*` params are relative to the *installation* directory, not the source directory. So if your default target does not install anything, or you have a `install` make target, but don't invoke it, bazel will be unable to find your build outputs. - The make file must either be able to recognize the `PREFIX=` env variable and use it, or have a different way of wiring the `$$INSTALLDIR$$` make variable through. - Finally, the `make install` recipe must ensure that it does not copy symlinks. This will bite you if you use `cp $SOURCE DEST` instead of `cp -L $SOURCE $DEST` since the former will create a bunch of symlinks pointing to the sandbox. Which, of course, is useless once the sandbox is removed. Using `-L` will ensure that the actual file contents are copied.
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.
I learned the hard way that the
makebuild rule does not work out of the box with just any makefile, unlike other rules in this repository.The single
makeexample does not emphasize this, and it is important for the usability of the rule.These are the things I learned:
make( targets = [...])invocation must at least execute an equivalent ofmake install, since allout_*params are relative to the installation directory, not to either the source or the buidkl directory. So if your default target does not install anything, or you have ainstallmake target, but don't invoke it, bazel will be unable to find your build outputs.PREFIX=env variable and use it, or have a different way of wiring the$$INSTALLDIR$$make variable through.make installrecipe must ensure that it does not copy symlinks. This will bite you if you usecp $SOURCE DESTinstead ofcp -L $SOURCE $DESTsince the former will create a bunch of symlinks pointing to the sandbox. Which, of course, is useless once the sandbox is removed. Using-Lwill ensure that the actual file contents arecopied.
Issue: #1049