Small updates

.gitlab-ci.yml

@@ -54,7 +54,7 @@ variables:
 # - Build is where we build MFEM for multiple toolchains.
 # - Test is where we perform a first set of tests on MFEM build.
 # - Baseline_checks gathers baseline-type test suites execution
-# - Baseline_publish, only available on master, allows to commit baseline
+# - Baseline_publish, only available on master, allows to update baseline
 #   results
 # - Deallocate releases quartz resources
 stages:
@@ -153,8 +153,8 @@ stages:
     - cd ${BUILD_PATH}/mfem_${MFEM_USE_MPI}_${MFEM_DEBUG}
     - make test
 
-# Shared script for baseline and sample-run-baseline.
-# BASELINE_TEST is what differentiate between both.
+# Shared script for baseline and sample-run-baseline, the value of BASELINE_TEST
+# differentiates between the two tests.
 .baseline_script: &baseline_script |
   # locals
   _full_out=${BASELINE_TEST}.out
@@ -214,8 +214,8 @@ stages:
       - ${BASELINE_TEST}-diff.txt
     when: always
 
-# This job can only be manually triggers on a pipeline for master branch,
-# or if the pipeline was triggered with REBASELINE="YES"
+# This job can only be manually triggers on a pipeline for master branch, or if
+# the pipeline was triggered with REBASELINE="YES"
 .rebaseline_mfem:
   stage: baseline_publish
   rules:
@@ -229,6 +229,6 @@ stages:
     - echo "git push origin master"
   allow_failure: false
 
-# The list on jobs is in fact defined in other files.
+# The list on jobs is defined in machine-specific files.
 include:
   - local: .gitlab/quartz.yml

.gitlab/quartz.yml

@@ -51,7 +51,7 @@ deallocate_quartz:
       fi
   when: always
 
-#Build libs
+# Build external libraries (tpls)
 build_hypre_gcc_6_1_0_quartz:
   extends: [.build_hypre, .with_gcc_6_1_0, .on_quartz]
 
@@ -104,7 +104,8 @@ build_mfem_opt_par_gcc_6_1_0_quartz:
     MFEM_USE_MPI: "YES"
   needs: [build_hypre_gcc_6_1_0_quartz, build_parmetis_gcc_6_1_0_quartz, allocate_quartz]
 
-## Tests
+### Tests
+
 # Sanity check
 sanitycheck_mfem_debug_ser_gcc_4_9_3_quartz:
   extends: [.sanitycheck_mfem, .with_gcc_4_9_3, .on_quartz]

CHANGELOG

@@ -169,9 +169,10 @@ Miscellaneous
 
 - Added unit tests for time integrators.
 
-- Added a Gitlab pipeline in order to automate PR testing on Linux clusters and
-  supercomputing systems at Lawrence Livermore National Lab (LLNL). This can be
-  triggered only by LLNL developers, see the updated CONTRIBUTING.md.
+- Added a Gitlab pipeline that automates PR testing on supercomputing systems
+  and Linux clusters at Lawrence Livermore National Lab (LLNL). This can be
+  triggered only by LLNL developers, see .gitlab-ci.yml, the .gitlab file and
+  the updated CONTRIBUTING.md.
 
 Version 4.0, released on May 24, 2019
 =====================================

CONTRIBUTING.md

@@ -20,9 +20,9 @@ HPC performance improvements; etc.
 Use a pull request (PR) toward the `mfem:master` branch to propose your
 contribution. If you are planning significant code changes, or have any
 questions, you can also open an [issue](https://github.com/mfem/mfem/issues)
-before issuing a PR. In addition to technical contributions, we also interested in your results and [simulation
-images](http://mfem.org/gallery/), which you can share via a pull request in
-[mfem/web](https://github.com/mfem/web).
+before issuing a PR. In addition to technical contributions, we also interested
+in your results and [simulation images](http://mfem.org/gallery/), which you
+can share via a pull request in [mfem/web](https://github.com/mfem/web).
 
 See the [Quick Summary](#quick-summary) section for the main highlights of our
 GitHub workflow. For more details, consult the following sections and refer
@@ -61,8 +61,10 @@ Origin](#developers-certificate-of-origin-11) at the end of this file.*
   to check the items off the [Pull Request Checklist](#pull-request-checklist).
 - When your contribution is fully working and ready to be reviewed, add
   the `ready-for-review` label.
-- PRs are treated similarly to journal submission with an "editor" assigning two reviewers to evaluate the changes.
-- The reviewers have 3 weeks to evaluate the PR and work with the author to implement improvements and fix issues.
+- PRs are treated similarly to journal submission with an "editor" assigning two
+  reviewers to evaluate the changes.
+- The reviewers have 3 weeks to evaluate the PR and work with the author to
+  implement improvements and fix issues.
 - After approval, MFEM developers merge the PR manually in the [mfem:next branch](#masternext-workflow).
 - After a week of testing in `mfem:next`, the original PR is merged in `mfem:master`.
 - We use [milestones](https://github.com/mfem/mfem/milestones) to coordinate the
@@ -105,7 +107,7 @@ Origin](#developers-certificate-of-origin-11) at the end of this file.*
   │   ├── nurbs
   │   ├── performance
   │   ├── tools
-  │   └── toysp
+  │   └── toys
   └── tests
       ├── scripts
       ├── unit
@@ -198,7 +200,8 @@ will allow us to reach you directly with project announcements.
 
 - Before you can start, you need a GitHub account, here are a few suggestions:
   + Create the account at: github.com/join.
-  + For easy identification, please add your name and maybe a picture of you at: https://github.com/settings/profile.
+  + For easy identification, please add your name and maybe a picture of you at:
+    https://github.com/settings/profile.
   + To receive notification, set a primary email at: https://github.com/settings/emails.
   + For password-less pull/push over SSH, add your SSH keys at: https://github.com/settings/keys.
 
@@ -496,9 +499,9 @@ MFEM uses a `master`/`next`-branch workflow as described below:
 - [ ] Create the release tarball and push to `mfem/releases`.
 - [ ] Recreate the `next` branch as described in previous section.
 - [ ] Update and push documentation  to `mfem/doxygen`.
-- [ ] Update URL shorlinks:
+- [ ] Update URL shortlinks:
     - [ ] Create a shortlink at [https://goo.gl/](https://goo.gl/) for the release tarball, e.g. http://mfem.github.io/releases/mfem-3.1.tgz.
-    - [ ] (LLNL only) Add and commit the new shorlink in the `links` and `links-mfem` files of the internal `mfem/downloads` repo.
+    - [ ] (LLNL only) Add and commit the new shortlink in the `links` and `links-mfem` files of the internal `mfem/downloads` repo.
     - [ ] Add the new shortlinks to the MFEM packages in `spack`, `homebrew/science`, `VisIt`, etc.
 - [ ] Update website in `mfem/web` repo:
     - Update version and shortlinks in `src/index.md` and `src/download.md`.