Skip to content

Commit fdde772

Browse files
authored
README.md and Dockerfile tweaks (#9)
* docs(README.md): Explicitly mention which R binary to use * refactor: Update default CMD to `bash` * Previously inherited a default `CMD ["R"]` which put users in the non-instrumented R-release * refactor: Don't use deprecated MAINTAINER * Previously docker would emit following warning: `WARN: MaintainerDeprecated: Maintainer instruction is deprecated in favor of using label` * "supposed" to instead use `org.opencontainers.image.authors` which is a freeform string: + https://docs.docker.com/reference/build-checks/maintainer-deprecated/ + https://github.com/opencontainers/image-spec/blob/main/annotations.md#pre-defined-annotation-keys * refactor: Use "ENV key=value" * Previously docker would warn: `LegacyKeyValueFormat: "ENV key=value" should be used instead of legacy "ENV key value" format`
1 parent 0d6c135 commit fdde772

File tree

2 files changed

+9
-4
lines changed

2 files changed

+9
-4
lines changed

Dockerfile

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
FROM r-base:latest
55

66
## This handle reaches Carl and Dirk
7-
MAINTAINER "Carl Boettiger and Dirk Eddelbuettel" [email protected]
7+
LABEL org.opencontainers.image.authors="Carl Boettiger and Dirk Eddelbuettel <[email protected]>"
8+
89

910
## Remain current
1011
RUN apt-get update -qq \
@@ -106,12 +107,12 @@ RUN echo 'options("repos"="http://cloud.r-project.org")' >> /usr/local/lib/R/etc
106107

107108
## More verbose UBSAN/SAN output (cf #3) -- this is still somewhat speculative
108109
## Entry copied from Prof Ripley's setup described at http://www.stats.ox.ac.uk/pub/bdr/memtests/README.txt
109-
ENV ASAN_OPTIONS 'alloc_dealloc_mismatch=0:detect_leaks=0:detect_odr_violation=0'
110+
ENV ASAN_OPTIONS='alloc_dealloc_mismatch=0:detect_leaks=0:detect_odr_violation=0'
110111

111112
RUN cd /usr/local/bin \
112113
&& mv R Rdevel \
113114
&& mv Rscript Rscriptdevel \
114115
&& ln -s Rdevel RD \
115116
&& ln -s Rscriptdevel RDscript
116117

117-
118+
CMD ["bash"]

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ and to
99
[Using the Undefined Behaviour Sanitizer](http://cran.r-project.org/doc/manuals/r-devel/R-exts.html#Using-Undefined-Behaviour-Sanitizer).
1010

1111
Both require a particularly instrumented binary of R. This repository
12-
provides a Docker container with such a binary, based on the R-devel sources.
12+
provides a Docker container with such a binary, based on the R-devel sources:
13+
14+
* This particularly instrumented binary of `R` is available on the path as `Rdevel` and for convenience is also symbolically linked on the path as `RD`.
15+
* The particularly instrumented versions of `Rscript` on the path are `Rscriptdevel` with symbolic link `RDscript` for convenience.
16+
* The `R` and `Rscript` binaries in the path of this container are inherited from the `r-base/latest` container and are **not** particularly instrumented with sanitizer support.
1317

1418
## Rocker-Org
1519

0 commit comments

Comments
 (0)