From c64259b0d582d08972258f10747e179f6880e6a1 Mon Sep 17 00:00:00 2001
From: "Michael Bradley, Jr" <michaelsbradleyjr@gmail.com>
Date: Tue, 5 Jul 2022 19:46:46 -0500
Subject: [PATCH] ci: more comments added to `.github/workflows/ci.yml`

---
 .github/workflows/ci.yml | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
index 1d13dfa0..46b7a5aa 100644
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@@ -1,3 +1,6 @@
+# Adapted from:
+# https://github.com/status-im/nimbus-eth2/blob/stable/.github/workflows/ci.yml
+
 name: CI
 on:
   push:
@@ -131,6 +134,8 @@ jobs:
           EOF
             chmod 755 external/bin/gcc external/bin/g++
             echo "$(pwd)/external/bin" >> ${GITHUB_PATH}
+            # --passC:'-m32 -mno-adx' is redundant but harmless, and can be
+            # helpful when reviewing build output with increased verbosity
             NIMFLAGS="${NIMFLAGS} $(quote "--passC:'-m32 -mno-adx' -d:LeopardCmakeFlags='-DCMAKE_BUILD_TYPE=Release -DCMAKE_C_COMPILER=$(pwd)/external/bin/gcc -DCMAKE_CXX_COMPILER=$(pwd)/external/bin/g++'")"
             echo "NIMFLAGS=${NIMFLAGS}" >> $GITHUB_ENV
           fi
@@ -148,6 +153,7 @@ jobs:
           # Enable OpenMP on macOS
           if [[ '${{ runner.os }}' == 'macOS' ]]; then
             libomp_lib_dir="$(brew --prefix)/opt/libomp/lib"
+            # See https://github.com/actions/virtual-environments/pull/5819
             llvm_dir="$(ls -d $(brew --prefix)/opt/llvm* | tail -1)"
             llvm_bin_dir="${llvm_dir}/bin"
             llvm_lib_dir="${llvm_dir}/lib"