Update GitLab CI script

Changes SHA detection to find the start of the MR and makes check_coding return non-zero when formatting changes needed

.gitlab-ci.yml

@@ -1,5 +1,13 @@
 before_script:
   - apt-get update -qq -y && apt-get install -y -qq clang-format git
+  # We must manually add the KiCad remote to ensure it is named sensibly
+  - git remote add product https://gitlab.com/kicad/code/kicad.git
+  - git fetch -n product
+  - git fetch -n origin
+  # Get the SHAs of the commits
+  - "TARGET_HEAD_SHA=$(git rev-parse product/${CI_MERGE_REQUEST_TARGET_BRANCH_NAME})"
+  - "SOURCE_HEAD_SHA=$(git rev-parse origin/${CI_MERGE_REQUEST_SOURCE_BRANCH_NAME})"
+  - "MERGE_BASE_SHA=$(git merge-base ${TARGET_HEAD_SHA} ${SOURCE_HEAD_SHA})"
 
 # The variable CI_COMMIT_BEFORE_SHA is not available in normal merge requests
 # so we must build the commit hash ourselves, see:
@@ -7,9 +15,7 @@ before_script:
 test_formatting:
   stage: test
   script:
-    - git fetch -n origin
+    - echo "Testing formatting from commit ${MERGE_BASE_SHA}"
-    - "TARGET_SHA=$(git rev-parse origin/$CI_MERGE_REQUEST_TARGET_BRANCH_NAME)"
+    - ./tools/check_coding.sh --diff --ci --commit ${MERGE_BASE_SHA}
-    - echo "Testing formatting from commit $TARGET_SHA"
-    - ./tools/check_coding.sh --diff --commit $TARGET_SHA
   only:
   - merge_requests

INSTALL.txt

@@ -3,55 +3,54 @@ KiCad installation
 
 The parts of KiCad
 ------------------
-KiCad consists of 3 packages:
+
+  KiCad consists of 3 components:
 
   kicad         - KiCad programs and core files.
   kicad-doc     - Documentation and interactive help (optional package).
   kicad-library - KiCad schematic, pcb & 3D-model libraries (optional package).
 
+  This repository contains the source code for the main KiCad programs. The documentation
+  and library sources are available at https://gitlab.com/kicad
+
 
 Installation from binary packages
 ---------------------------------
 
-   KiCad binary packages exist for Linux and Windows (XP, 2000).
+ Compiled KiCad binaries exist for Windows (7, 8.1, 10), Mac OS (10.12+) and several
+ Linux distributions (Fedora, Debian, Ubuntu, Arch). These are available from the
+ main KiCad website: https://kicad-pcb.org/download/
 
  Data files (schematic, boards, libraries) are compatible with all platforms.
 
-*.zip  - KiCad packages for Windows.
-*.tbz2 - KiCad for Linux.
-
 
 Installation from binary packages for Windows
 ---------------------------------------------
 
-The KiCad binary archive can be installed anywhere on the system that as long as the user
+  KiCad can be installed anywhere on the system as long as the user has write privileges.
-has write privileges.
+  Pre-made installers are available on the KiCad website: https://kicad-pcb.org/download/windows/
-
-You can create a shortcut to '${prefix}\bin\kicad.exe' where ${prefix} is the install path.
 
 
 Installation from binary packages for Linux
 -------------------------------------------
 
-KiCad can be installed in '/usr' or '/usr/local'.  You must have "root" access for installation.
+  KiCad comes packaged on many Linux platforms including Debian, Fedora, Ubuntu and Arch,
-
+  and is available in their respective package repositories. More information can be found on
-cd /
+  the platform's page at https://kicad-pcb.org/download/
-tar -xjf kicad-{version}.tbz2
-tar -xjf kicad-doc-{version}.tbz2
-tar -xjf kicad-library-{version}.tbz2
-
-The main program is '/usr/bin/kicad'.
 
 
-Linux and Windows KiCad install tree
+Linux install tree
 -------------------------------------
 
+  The default locations KiCad uses to install its components on Linux are:
+
   ${prefix}/bin                            - Binaries (executable files).
+  ${prefix}/lib/kicad                      - Shared libraries
   ${prefix}/share/doc/kicad/               - Various documentation.
   ${prefix}/share/doc/kicad/help           - Interactive help.
   ${prefix}/share/kicad/demos              - Sample schematics and printed boards.
-${prefix}/share/kicad/internat           - Dictionaries for interface localization.
+  ${prefix}/share/kicad/template           - Template projects and sheets.
-${prefix}/share/kicad/library            - Interface localization files.
+  ${prefix}/share/kicad/library            - Symbol libraries.
   ${prefix}/share/kicad/modules            - Module libraries for printed boards.
   ${prefix}/share/kicad/modules/packages3d - 3D component models (.wrl and .step format).
 
@@ -81,6 +80,7 @@ Warning:
   These paths are hardcoded into KiCad, if you put them somewhere else KiCad will not find
   them when a new project is created.
 
+
 Installation from source code
 -----------------------------
 
@@ -90,11 +90,9 @@ Some dependencies must be satisfied for the correct installation of KiCad:
 
   wxWidgets            >= 3.0.0           http://www.wxwidgets.org/
 
-CMake                >= 2.8.4           http://www.cmake.org/
+  CMake                >= 3.0.2           http://www.cmake.org/
 
-Boost C++ Libraries: >= 1.54            http://www.boost.org/
+  Boost C++ Libraries: >= 1.59            http://www.boost.org/
-    files used by kicad are autmatically downloaded and patched if needed
-    from boost site.
 
   OpenGL               >= 2.1
     Linux:   Mesa 3D Graphics Library     http://www.mesa3d.org/
@@ -102,7 +100,7 @@ OpenGL               >= 2.1
 
   Zlib Compression Library                http://www.zlib.net/
 
-cairo                                   http://cairographics.org/
+  cairo                >= 1.12            http://cairographics.org/
 
   GLEW                                    http://glew.sourceforge.net/
 
@@ -124,29 +122,13 @@ SWIG                 >= 3.0 (optional)  http://swig.org/
 
   libngspice           (optional)         http://ngspice.sourceforge.net/
 
+  One of:
     OCE                >= 0.16 (optional) https://github.com/tpaviot/oce
 
-In source-tree-build are mostly unwanted, so make a subdir called "build" and
+    OCC                >= 6.8.0 (optiona) https://www.opencascade.com/content/latest-release
-change to it.
 
-Call cmake with the path to KiCad. E.g., when your build-folder is "build"
+  Complete documentation for building from source can be found in the developer
-within source-tree, type "cmake ../".
+  documentation located in Documentation/development/compiling.md
-
-Now your system get checked if it is able compiling KiCad and cmake generates
-the Makefiles.
-
-   After calling cmake just type "make" and build begins.
-
-   It is easy to build only a specific binary such as pcbnew alone:
-    make pcbnew
-
-   After "make" type "make install" and install begins.
-
-   You may install to a temporary-root with
-    make install DESTDIR=<temproot>
-
-   If you want to uninstall KiCad again type "make uninstall" from within the
-build directory.
 
 
 Important parameters to cmake

tools/check_coding.sh

@@ -33,6 +33,7 @@ usage='usage: check_coding.sh [<options>] [--]
      --cached                   Re-format changes currently staged for commit (default)
      --amend                    Re-format changes made in the previous commit
      --commit <commit-rev>      Re-format changes made since commit-rev
+     --ci                       Run in CI mode to return non-zero when there are formatting errors
 '
 
 help="$usage"'
@@ -48,6 +49,7 @@ die() {
 }
 
 # Parse command-line arguments.
+ci=false
 diff=false
 mode='cached'
 
@@ -60,6 +62,7 @@ while test "$#" != 0; do
         format_ref_commit="$2"
         shift
         ;;
+    --ci) ci=true ;;
     --) shift ; break ;;
     -*) die "$usage" ;;
     *) break ;;
@@ -104,6 +107,14 @@ else
     format_command="git clang-format ${format_commit}"
 fi
 
+
+if [ "${ci}" = true ]; then
+    # In CI mode we want to set the return value based on modifications (1 = modifications
+    # needed, 0 = no modifications). We must capture the output to do this (since git clang-format
+    # will always return 0). By capturing the output, we break the terminal coloring, so we hide
+    # this inside a special CI mode.
+
+    format_results="$( \
     ${git_list_files} |
 
         # Filter sources with the formatting attribute set
@@ -115,3 +126,28 @@ ${git_list_files} |
 
         # Apply the formatting command
         xargs ${format_command}
+    )"
+
+    echo "$format_results"
+
+    # Read the results to see if modifications have been requested
+    if [[ $format_results == "no modified files to format" ]] \
+        || [[ $format_results == "clang-format did not modify any files" ]];
+    then
+        true
+    else
+        false
+    fi
+else
+    ${git_list_files} |
+
+        # Filter sources with the formatting attribute set
+        git check-attr ${format_attribute} --stdin |
+
+        # output only the file names
+        grep ": set$" |
+        cut -d: -f1 |
+
+        # Apply the formatting command
+        xargs ${format_command}
+fi