From 2eaa9ee0b719c66b8e4e97970b0b93bba859caed Mon Sep 17 00:00:00 2001
From: Brady Bonnette <BradyBonnette@users.noreply.github.com>
Date: Wed, 6 Sep 2023 12:46:59 -0400
Subject: [PATCH] Fixes mdbook (#379)

There was a problem with compiling and installing mdbook and
mdbook-variables in the main TCDI plrust repo. These changes address the
issue it was having, albeit a temporary band-aid until the author fixes
the library proper.
---
 .github/workflows/docs.yml |  3 +--
 doc/README.md              | 10 +++-------
 plrust/build               |  2 +-
 3 files changed, 5 insertions(+), 10 deletions(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index 8a5fac59..373b0cbd 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -18,8 +18,7 @@ jobs:
         echo "PATH=$HOME/.cargo/bin:$PATH" >> $GITHUB_ENV
     - name: Install mdbook and other preprocessors
       run: |
-        cargo install mdbook --version 0.4.32
-        cargo install mdbook-variables --version 0.2.1
+        cargo install --locked mdbook-variables mdbook
     - name: Deploy GitHub Pages
       run: |
         # This assumes your book is in the root of your repository.
diff --git a/doc/README.md b/doc/README.md
index 04850461..6289242d 100644
--- a/doc/README.md
+++ b/doc/README.md
@@ -2,17 +2,13 @@
 
 The book is built [using `mdbook`](https://rust-lang.github.io/mdBook/index.html).
 
-Install mdbook -- exact version is required since (at the time of this writing) there were some compatibility issues.
+To install everything you need, run the following:
 
 ```bash
-cargo install mdbook --version 0.4.32
+cargo install --locked mdbook-variables mdbook
 ```
 
-Install mdbook-variables preprocessor -- exact version is required since (at the time of this writing) there were some compatibility issues.
-
-```bash
-cargo install mdbook-variables --version 0.2.1
-```
+Note that at the time of this writing, you may see a warning message similar to: `Warning: The variables plugin was built against version 0.4.32 of mdbook, but we're being called from version 0.4.34`. This is a known issue from the mdbook-variables author. See here: https://gitlab.com/tglman/mdbook-variables/-/issues/3
 
 Serve the book locally and open your default browser.
 
diff --git a/plrust/build b/plrust/build
index c966a0fe..4c4811f3 100755
--- a/plrust/build
+++ b/plrust/build
@@ -28,7 +28,7 @@ if [ `uname` == "Darwin" ]; then
    else
       echo unsupported macos build platform: $(uname -m)
       exit 1
-   fi 
+   fi
 
 else
    if [ `uname -m` == "x86_64" ]; then