update Makefile documentation #160
Open
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
Documenting the fact that `USERID` and `GROUPID` need to be set to superuser for this to work.
| ## test the build by issuing 'make test', which at present is | ||
| ## synonymous with 'make html'. I.e., the website build is tested by | ||
| ## rendering all HTML content. | ||
| ## test the build by issuing 'USERID=0 GROUPID=0 make test', which at |
There was a problem hiding this comment.
Well, this is only true on MacOSX, and on Unix will actually cause the build to fail! Moreover, on Linux you instead have to set SUDO (to, in most cases, "sudo"), like so:
$ SUDO=sudo make htmlor otherwise the invocation of Docker will typically fail. (But setting SUDO on MacOSX will most likely cause the build to fail.)
One wishes Docker behaved the same on all systems, but because systems like MacOSX have to run Docker within a VM, whereas it runs natively on Linux, the behaviors are different in sometimes subtle ways.
There was a problem hiding this comment.
Perhaps it would be better to include a whole section of docu-comment for different OSes?
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.
Documenting the fact that
USERIDandGROUPIDneed to be set to superuser for this to work.