From 4749355f35f0102fe692a81af58ab4294f3100a5 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lo=C3=AFc=20Est=C3=A8ve?= <loic.esteve@ymail.com>
Date: Thu, 29 Jun 2017 11:40:24 +0200
Subject: [PATCH] CIRCLE tweak comments in build_doc.sh

---
 build_tools/circle/build_doc.sh | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/build_tools/circle/build_doc.sh b/build_tools/circle/build_doc.sh
index 29e06a2d66..fb8e7da5b6 100755
--- a/build_tools/circle/build_doc.sh
+++ b/build_tools/circle/build_doc.sh
@@ -74,8 +74,9 @@ fi
 
 if [[ "$CIRCLE_BRANCH" =~ ^master$|^[0-9]+\.[0-9]+\.X$ && -z "$CI_PULL_REQUEST" ]]
 then
-    # nonstopmode is used to not wait for CI timeout in case of an error
-    # PDF linked into HTML
+    # dist generates the pdf doc and adds the pdf to the website
+    # nonstopmode is used to prevent CI timeout when the LaTeX
+    # compilation fails
     MAKE_TARGET="dist LATEXMKOPTS=-interaction=nonstopmode"
 elif [[ "$build_type" =~ ^QUICK ]]
 then
-- 
GitLab