Merge pull request #40 from LinuxJedi/simplify-docker

lealem47 · web-flow · commit 3f898ba80c61 · 2022-05-05T11:50:36.000-07:00
Docker builds are now templated
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -129,39 +129,20 @@ The `src` directory contains the source Markdown documentation that will be comp
 
 The build process is quite complex with several required dependencies, particularly for the manuals that require Doxygen. Therefore a Docker based build has been created which will do all the hard work automatically without you having to install any dependencies (apart from Docker itself).
 
-For every manual an entry needs to be added into the `Dockerfile` and `Makefile` at the root of this directory tree.
-
-#### Dockerfile
-
-A new entry needs to be added as below (modified for the project name / directories / files):
-
-```
-# Build wolfBoot PDF
-FROM builder AS wolfboot-stage1
-WORKDIR /src/wolfssl/wolfBoot
-RUN make pdf
-
-# Build wolfBoot HTML
-FROM builder AS wolfboot-stage2
-WORKDIR /src/wolfssl/wolfBoot
-RUN make html
-
-# Build wolfBoot HTML and PDF
-FROM scratch AS wolfboot
-COPY --from=wolfboot-stage1 /src/wolfssl/wolfBoot/wolfBoot-Manual.pdf wolfboot.pdf
-COPY --from=wolfboot-stage2 /src/wolfssl/wolfBoot/html wolfboot-html
-```
-
-The final `wolfboot.pdf` and `wolfboot-html` will be what is created in the `build` directory in the root of this directory tree at the end of the build.
+For every manual an entry needs to be added into the `Makefile` at the root of this directory tree.
 
 #### Makefile
 
-An entry also needs to be added to the `Makefile` at the root of this directory tree with the following contents (adjusted for the target at the third step of your Dockerfile entry):
+An entry needs to be added to the `Makefile` at the root of this directory tree with the following contents (adjusted for the target at the third step of your Dockerfile entry):
 
 ```
 .PHONY: wolfboot
+wolfboot: MANPATH=wolfBoot
+wolfboot: PDFFILE=wolfBoot-Manual.pdf
 wolfboot: build
-	@$(DOCKER_CMD) --target=wolfboot
+	@$(DOCKER_CMD)
 ```
 
+The `MANPATH` should be set to the subdirectory name the manual is in. `PDFFILE` should be set to the PDF filename generated by the manual's Makefile.
+
 You will also need to add an entry to the `all` line for your project.
diff --git a/Dockerfile b/Dockerfile
@@ -20,143 +20,23 @@ RUN cd doxybook2 && cmake . && make install
 WORKDIR /src/wolfssl
 COPY . .
 
-# Get the wolfSSL Doxygen
-FROM builder as wolfssl-stage1
-WORKDIR /src/wolfssl/wolfSSL
-# Cache getting wolfSSL source for Doxygen docs
-RUN git clone --depth 1 https://github.com/wolfSSL/wolfssl
-
 # Build wolfSSL PDF
-FROM wolfssl-stage1 AS wolfssl-stage2
-WORKDIR /src/wolfssl/wolfSSL
+FROM builder AS wolfssl-stage1
+ARG MANPATH
+ARG PDFFILE
+WORKDIR /src/wolfssl/${MANPATH}
 RUN make pdf
 
 # Build wolfSSL HTML
-FROM wolfssl-stage1 AS wolfssl-stage3
-WORKDIR /src/wolfssl/wolfSSL
+FROM wolfssl-stage1 AS wolfssl-stage2
+ARG MANPATH
+ARG PDFFILE
+WORKDIR /src/wolfssl/${MANPATH}
 RUN make html
 
 # Build both wolfSSL HTML and PDF
-FROM scratch AS wolfssl
-COPY --from=wolfssl-stage2 /src/wolfssl/wolfSSL/wolfssl.pdf wolfssl.pdf
-COPY --from=wolfssl-stage3 /src/wolfssl/wolfSSL/html wolfssl-html
-
-# Build wolfSSH PDF
-FROM builder AS wolfssh-stage1
-WORKDIR /src/wolfssl/wolfSSH
-RUN make pdf
-
-# Build wolfSSH HTML
-FROM builder AS wolfssh-stage2
-WORKDIR /src/wolfssl/wolfSSH
-RUN make html
-
-# Build wolfSSH HTML and PDF
-FROM scratch AS wolfssh
-COPY --from=wolfssh-stage1 /src/wolfssl/wolfSSH/wolfSSH-Manual.pdf wolfssh.pdf
-COPY --from=wolfssh-stage2 /src/wolfssl/wolfSSH/html wolfssh-html
-
-# Build wolfBoot PDF
-FROM builder AS wolfboot-stage1
-WORKDIR /src/wolfssl/wolfBoot
-RUN make pdf
-
-# Build wolfBoot HTML
-FROM builder AS wolfboot-stage2
-WORKDIR /src/wolfssl/wolfBoot
-RUN make html
-
-# Build wolfBoot HTML and PDF
-FROM scratch AS wolfboot
-COPY --from=wolfboot-stage1 /src/wolfssl/wolfBoot/wolfBoot-Manual.pdf wolfboot.pdf
-COPY --from=wolfboot-stage2 /src/wolfssl/wolfBoot/html wolfboot-html
-
-# Build wolfCLU PDF
-FROM builder AS wolfclu-stage1
-WORKDIR /src/wolfssl/wolfCLU
-RUN make pdf
-
-# Build wolfCLU HTML
-FROM builder AS wolfclu-stage2
-WORKDIR /src/wolfssl/wolfCLU
-RUN make html
-
-# Build wolfCLU HTML and PDF
-FROM scratch AS wolfclu
-COPY --from=wolfclu-stage1 /src/wolfssl/wolfCLU/wolfCLU_Manual.pdf wolfclu.pdf
-COPY --from=wolfclu-stage2 /src/wolfssl/wolfCLU/html wolfboot-html
-
-# Build wolfCrypt JNI PDF
-FROM builder AS wolfcrypt-jni-stage1
-WORKDIR /src/wolfssl/wolfCrypt-JNI
-RUN make pdf
-
-# Build wolfCrypt JNI HTML
-FROM builder AS wolfcrypt-jni-stage2
-WORKDIR /src/wolfssl/wolfCrypt-JNI
-RUN make html
-
-# Build wolfCrypt JNI HTML and PDF
-FROM scratch AS wolfcrypt-jni
-COPY --from=wolfcrypt-jni-stage1 /src/wolfssl/wolfCrypt-JNI/wolfCrypt-JNI-JCE-Manual.pdf wolfcryp-jni.pdf
-COPY --from=wolfcrypt-jni-stage2 /src/wolfssl/wolfCrypt-JNI/html wolfcrypt-jni-html
-
-# Build wolfMQTT PDF
-FROM builder AS wolfmqtt-stage1
-WORKDIR /src/wolfssl/wolfMQTT
-RUN make pdf
-
-# Build wolfMQTT HTML
-FROM builder AS wolfmqtt-stage2
-WORKDIR /src/wolfssl/wolfMQTT
-RUN make html
-
-# Build wolfMQTT HTML and PDF
-FROM scratch AS wolfmqtt
-COPY --from=wolfmqtt-stage1 /src/wolfssl/wolfMQTT/wolfMQTT-Manual.pdf wolfmqtt.pdf
-COPY --from=wolfmqtt-stage2 /src/wolfssl/wolfMQTT/html wolfmqtt-html
-
-# Build wolfSentry PDF
-FROM builder AS wolfsentry-stage1
-WORKDIR /src/wolfssl/wolfSentry
-RUN make pdf
-
-# Build wolfSentry HTML
-FROM builder AS wolfsentry-stage2
-WORKDIR /src/wolfssl/wolfSentry
-RUN make html
-
-# Build wolfSentry HTML and PDF
-FROM scratch AS wolfsentry
-COPY --from=wolfsentry-stage1 /src/wolfssl/wolfSentry/wolfsentry.pdf wolfsentry.pdf
-COPY --from=wolfsentry-stage2 /src/wolfssl/wolfSentry/html wolfsentry-html
-
-# Build wolfSSL-JNI PDF
-FROM builder AS wolfssl-jni-stage1
-WORKDIR /src/wolfssl/wolfSSL-JNI
-RUN make pdf
-
-# Build wolfSSL-JNI HTML
-FROM builder AS wolfssl-jni-stage2
-WORKDIR /src/wolfssl/wolfSSL-JNI
-RUN make html
-
-# Build wolfSentry HTML and PDF
-FROM scratch AS wolfssl-jni
-COPY --from=wolfssl-jni-stage1 /src/wolfssl/wolfSSL-JNI/wolfSSL-JNI-JSSE-Manual.pdf wolfssl-jni.pdf
-COPY --from=wolfssl-jni-stage2 /src/wolfssl/wolfSSL-JNI/html wolfssl-jni-html
-
-# Build wolfTPM PDF
-FROM builder AS wolftpm-stage1
-WORKDIR /src/wolfssl/wolfTPM
-RUN make pdf
-
-# Build wolfTPM HTML
-FROM builder AS wolftpm-stage2
-WORKDIR /src/wolfssl/wolfTPM
-RUN make html
-
-# Build wolfTPM HTML and PDF
-FROM scratch AS wolftpm
-COPY --from=wolftpm-stage1 /src/wolfssl/wolfTPM/wolfTPM-Manual.pdf wolftpm.pdf
-COPY --from=wolftpm-stage2 /src/wolfssl/wolfTPM/html wolftpm-html
+FROM scratch AS manual
+ARG MANPATH
+ARG PDFFILE
+COPY --from=wolfssl-stage1 /src/wolfssl/${MANPATH}/${PDFFILE} ${PDFFILE}
+COPY --from=wolfssl-stage2 /src/wolfssl/${MANPATH}/html ${MANPATH}-html
diff --git a/Makefile b/Makefile
@@ -1,45 +1,63 @@
-DOCKER_CMD=DOCKER_BUILDKIT=1 docker build -t doc_build --output=build -f Dockerfile .
+DOCKER_CMD=DOCKER_BUILDKIT=1 docker build -t doc_build --build-arg MANPATH=$(MANPATH) --build-arg PDFFILE=$(PDFFILE) --target=manual --output=build -f Dockerfile .
 
 all: wolfssl wolfssh wolfboot wolfclu wolfcrypt-jni wolfmqtt wolfsentry wolfssl-jni wolftpm
 
 build:
 	@mkdir -p build
 
 .PHONY: wolfssl
+wolfssl: MANPATH=wolfSSL
+wolfssl: PDFFILE=wolfssl.pdf
 wolfssl: build
-	@$(DOCKER_CMD) --target=wolfssl
+	@$(DOCKER_CMD)
 
 .PHONY: wolfssh
+wolfssh: MANPATH=wolfSSH
+wolfssh: PDFFILE=wolfSSH-Manual.pdf
 wolfssh: build
-	@$(DOCKER_CMD) --target=wolfssh
+	@$(DOCKER_CMD)
 
 .PHONY: wolfboot
+wolfboot: MANPATH=wolfBoot
+wolfboot: PDFFILE=wolfBoot-Manual.pdf
 wolfboot: build
-	@$(DOCKER_CMD) --target=wolfboot
+	@$(DOCKER_CMD)
 
 .PHONY: wolfclu
+wolfclu: MANPATH=wolfCLU
+wolfclu: PDFFILE=wolfCLU_Manual.pdf
 wolfclu: build
-	@$(DOCKER_CMD) --target=wolfclu
+	@$(DOCKER_CMD)
 
 .PHONY: wolfcrypt-jni
+wolfcrypt-jni: MANPATH=wolfCrypt-JNI
+wolfcrypt-jni: PDFFILE=wolfCrypt-JNI-JCE-Manual.pdf
 wolfcrypt-jni: build
-	@$(DOCKER_CMD) --target=wolfcrypt-jni
+	@$(DOCKER_CMD)
 
 .PHONY: wolfmqtt
+wolfmqtt: MANPATH=wolfMQTT
+wolfmqtt: PDFFILE=/wolfMQTT-Manual.pdf
 wolfmqtt: build
-	@$(DOCKER_CMD) --target=wolfmqtt
+	@$(DOCKER_CMD)
 
 .PHONY: wolfsentry
+wolfsentry: MANPATH=wolfSentry
+wolfsentry: PDFFILE=wolfsentry.pdf
 wolfsentry: build
-	@$(DOCKER_CMD) --target=wolfsentry
+	@$(DOCKER_CMD)
 
 .PHONY: wolfssl-jni
-wolfssl: build
-	@$(DOCKER_CMD) --target=wolfssl-jni
+wolfssl-jni: MANPATH=wolfSSL-JNI
+wolfssl-jni: PDFFILE=wolfSSL-JNI-JSSE-Manual.pdf
+wolfssl-jni: build
+	@$(DOCKER_CMD)
 
 .PHONY: wolftpm
+wolftpm: MANPATH=wolfTPM
+wolftpm: PDFFILE=wolfTPM-Manual.pdf
 wolftpm: build
-	@$(DOCKER_CMD) --target=wolftpm
+	@$(DOCKER_CMD)
 
 clean:
 	rm -rf build
