Skip to content

update Makefile documentation #160

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

update Makefile documentation #160

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,10 @@
## program will usually tell you what to do.
##
## Once you have prepared your environment for running docker, you can
## 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
Copy link
Member

Choose a reason for hiding this comment

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

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 html

or 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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perhaps it would be better to include a whole section of docu-comment for different OSes?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, I guess.

## present is synonymous with 'make html'. I.e., the website build is
## tested by rendering all HTML content. Note that USERID and GROUPID
## must be set to 0 or docker will not be able to process these files.
##
## The website is built in the build/ directory by first copying there
## all .md and .Rmd files from the root directory and a list of
Expand Down