Merge pull request #23 from neatudarius/tweaks-in-docs-for-alpha

Tweaks for alpha release
bemanproject · Jun 27, 2024 · f618810 · f618810
2 parents 2a60bc7 + ef6c4ec
commit f618810
Show file tree

Hide file tree

Showing 20 changed files with 357 additions and 161 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,3 @@
+*.bib -linguist-detectable
+*.tex -linguist-detectable
+papers/* linguist-documentation
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -1,67 +1,28 @@
 name: Test
-
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
-
+    branches: [main]
 jobs:
   build:
     name: ${{ matrix.config.name }}
     runs-on: ${{ matrix.config.os }}
-
     strategy:
       fail-fast: false
-
       matrix:
         config:
-        - {
-          name: "Ubuntu Clang 17",
-          os: ubuntu-24.04,
-          toolchain: "clang-17-toolchain.cmake",
-          clang_version: 17,
-          installed_clang_version: 14,
-          cmake_args: "-G \"Ninja Multi-Config\" -DCMAKE_CONFIGURATION_TYPES=\"RelWithDebInfo;Asan\" "
-          }
-
-        - {
-          name: "Ubuntu Clang 18",
-          os: ubuntu-24.04,
-          toolchain: "clang-18-toolchain.cmake",
-          clang_version: 18,
-          installed_clang_version: 14,
-          cmake_args: "-G \"Ninja Multi-Config\" -DCMAKE_CONFIGURATION_TYPES=\"RelWithDebInfo;Asan\" "
-          }
-
-        - {
-            name: "Ubuntu GCC 13",
-            os: ubuntu-24.04,
-            toolchain: "gcc-13-toolchain.cmake",
-            clang_version: 17,
-            installed_clang_version: 14,
-            cmake_args: "-G \"Ninja Multi-Config\" -DCMAKE_CONFIGURATION_TYPES=\"RelWithDebInfo;Asan\" "
-          }
-
-        - {
-            name: "Ubuntu GCC 14",
-            os: ubuntu-24.04,
-            toolchain: "gcc-14-toolchain.cmake",
-            clang_version: 17,
-            installed_clang_version: 14,
-            cmake_args: "-G \"Ninja Multi-Config\" -DCMAKE_CONFIGURATION_TYPES=\"RelWithDebInfo;Asan\" "
-          }
-
+          - {name: "Ubuntu Clang 17", os: ubuntu-24.04, toolchain: "clang-17-toolchain.cmake", clang_version: 17, installed_clang_version: 14, cmake_args: "-G \"Ninja Multi-Config\" -DCMAKE_CONFIGURATION_TYPES=\"RelWithDebInfo;Asan\" "}
+          - {name: "Ubuntu Clang 18", os: ubuntu-24.04, toolchain: "clang-18-toolchain.cmake", clang_version: 18, installed_clang_version: 14, cmake_args: "-G \"Ninja Multi-Config\" -DCMAKE_CONFIGURATION_TYPES=\"RelWithDebInfo;Asan\" "}
+          - {name: "Ubuntu GCC 13", os: ubuntu-24.04, toolchain: "gcc-13-toolchain.cmake", clang_version: 17, installed_clang_version: 14, cmake_args: "-G \"Ninja Multi-Config\" -DCMAKE_CONFIGURATION_TYPES=\"RelWithDebInfo;Asan\" "}
+          - {name: "Ubuntu GCC 14", os: ubuntu-24.04, toolchain: "gcc-14-toolchain.cmake", clang_version: 17, installed_clang_version: 14, cmake_args: "-G \"Ninja Multi-Config\" -DCMAKE_CONFIGURATION_TYPES=\"RelWithDebInfo;Asan\" "}
     steps:
       - uses: actions/checkout@v3
         with:
           submodules: 'true'
-
       - uses: seanmiddleditch/gha-setup-ninja@master
-
       - name: Activate verbose shell
         run: set -x
-
       - name: Install LLVM+Clang
         if: startsWith(matrix.config.os, 'ubuntu-')
         run: |
@@ -89,15 +50,11 @@ jobs:
           chmod +x llvm.sh
           sudo ./llvm.sh ${{matrix.config.clang_version}} all
           sudo apt-get install libc++-dev libc++1 libc++abi-dev libc++abi1
-
-
       - name: Install GCC 14
         if: matrix.config.name == 'Ubuntu GCC 14'
         run: |
           sudo apt update
           sudo apt-get install g++-14
-
-
       - name: Configure
         run: |
           rm -rf .build
@@ -106,11 +63,9 @@ jobs:
           echo ${{ matrix.config.cmake_args }}
           echo ${{ matrix.config.toolchain }}
           cmake ${{ matrix.config.cmake_args }} -DCMAKE_TOOLCHAIN_FILE=etc/${{ matrix.config.toolchain }} -B . -S ..
-
       - name: Build
         run: |
           cmake --build .build --config Asan --target all -- -k 0
-
       - name: Test
         run: |
           cd .build

diff --git a/.markdownlint.json b/.markdownlint.json
@@ -0,0 +1,4 @@
+{
+    "MD013": false,
+    "MD024": false
+}
diff --git a/.shellcheckrc b/.shellcheckrc
@@ -0,0 +1,3 @@
+# shellcheck
+# allow for non-alphanumeric filenames
+disable=SC2038 
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -1,9 +1,14 @@
+# cmake-format: off
 # /CMakeLists.txt -*-makefile-*-
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+# cmake-format: on
 
 cmake_minimum_required(VERSION 3.10)
 
-project(beman_optional26 VERSION 0.0.0 LANGUAGES CXX)
+project(
+  beman_optional26
+  VERSION 0.0.0
+  LANGUAGES CXX)
 
 enable_testing()
 
@@ -20,25 +25,21 @@ set(INSTALL_CONFIGDIR ${CMAKE_INSTALL_LIBDIR}/cmake)
 install(
   EXPORT ${TARGETS_EXPORT_NAME}
   NAMESPACE ${CMAKE_PROJECT_NAME}
-  DESTINATION ${INSTALL_CONFIGDIR}
-  )
+  DESTINATION ${INSTALL_CONFIGDIR})
 
 include(CMakePackageConfigHelpers)
 
 write_basic_package_version_file(
-    ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}ConfigVersion.cmake
-    VERSION ${PROJECT_VERSION}
-    COMPATIBILITY AnyNewerVersion
-)
+  ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}ConfigVersion.cmake
+  VERSION ${PROJECT_VERSION}
+  COMPATIBILITY AnyNewerVersion)
 
 configure_package_config_file(
-    "cmake/Config.cmake.in"
-    ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}Config.cmake
-    INSTALL_DESTINATION ${INSTALL_CONFIGDIR}
-)
-
-install(FILES
-    ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}Config.cmake
-    ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}ConfigVersion.cmake
-    DESTINATION ${INSTALL_CONFIGDIR}
-)
+  "cmake/Config.cmake.in"
+  ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}Config.cmake
+  INSTALL_DESTINATION ${INSTALL_CONFIGDIR})
+
+install(
+  FILES ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}Config.cmake
+        ${CMAKE_CURRENT_BINARY_DIR}/${CMAKE_PROJECT_NAME}ConfigVersion.cmake
+  DESTINATION ${INSTALL_CONFIGDIR})
diff --git a/CMakePresets.json b/CMakePresets.json
@@ -31,12 +31,33 @@
       "description": "Build with GCC 14 compilers",
       "toolchainFile": "${sourceDir}/etc/gcc-14-toolchain.cmake"
     },
+    {
+      "name": "gcc-13",
+      "inherits": "common",
+      "displayName": "GCC 13",
+      "description": "Build with GCC 13 compilers",
+      "toolchainFile": "${sourceDir}/etc/gcc-13-toolchain.cmake"
+    },
+    {
+      "name": "clang-19",
+      "inherits": "common",
+      "displayName": "Clang 19",
+      "description": "Build with Clang 19 compilers",
+      "toolchainFile": "${sourceDir}/etc/clang-19-toolchain.cmake"
+    },
     {
       "name": "clang-18",
       "inherits": "common",
       "displayName": "Clang 18",
       "description": "Build with Clang 18 compilers",
       "toolchainFile": "${sourceDir}/etc/clang-18-toolchain.cmake"
+    },
+    {
+      "name": "clang-17",
+      "inherits": "common",
+      "displayName": "Clang 17",
+      "description": "Build with Clang 17 compilers",
+      "toolchainFile": "${sourceDir}/etc/clang-17-toolchain.cmake"
     }
   ],
   "buildPresets": [
@@ -53,9 +74,21 @@
       "name": "gcc-14",
       "configurePreset": "gcc-14"
     },
+    {
+      "name": "gcc-13",
+      "configurePreset": "gcc-13"
+    },
+    {
+      "name": "clang-19",
+      "configurePreset": "clang-19"
+    },
     {
       "name": "clang-18",
       "configurePreset": "clang-18"
+    },
+    {
+      "name": "clang-17",
+      "configurePreset": "clang-17"
     }
   ],
   "testPresets": [
@@ -80,10 +113,25 @@
       "inherits": "common",
       "configurePreset": "gcc-14"
     },
+    {
+      "name": "gcc-13",
+      "inherits": "common",
+      "configurePreset": "gcc-13"
+    },
+    {
+      "name": "clang-19",
+      "inherits": "common",
+      "configurePreset": "clang-19"
+    },
     {
       "name": "clang-18",
       "inherits": "common",
       "configurePreset": "clang-18"
+    },
+    {
+      "name": "clang-17",
+      "inherits": "common",
+      "configurePreset": "clang-17"
     }
   ],
   "workflowPresets": [
@@ -121,6 +169,40 @@
         }
       ]
     },
+    {
+      "name": "gcc-13",
+      "steps": [
+        {
+          "type": "configure",
+          "name": "gcc-13"
+        },
+        {
+          "type": "build",
+          "name": "gcc-13"
+        },
+        {
+          "type": "test",
+          "name": "gcc-13"
+        }
+      ]
+    },
+    {
+      "name": "clang-19",
+      "steps": [
+        {
+          "type": "configure",
+          "name": "clang-19"
+        },
+        {
+          "type": "build",
+          "name": "clang-19"
+        },
+        {
+          "type": "test",
+          "name": "clang-19"
+        }
+      ]
+    },
     {
       "name": "clang-18",
       "steps": [
@@ -137,6 +219,23 @@
           "name": "clang-18"
         }
       ]
+    },
+    {
+      "name": "clang-17",
+      "steps": [
+        {
+          "type": "configure",
+          "name": "clang-17"
+        },
+        {
+          "type": "build",
+          "name": "clang-17"
+        },
+        {
+          "type": "test",
+          "name": "clang-17"
+        }
+      ]
     }
   ]
 }
diff --git a/Makefile b/Makefile
@@ -1,6 +1,8 @@
 #! /usr/bin/make -f
+# cmake-format: off
 # /Makefile -*-makefile-*-
 # SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+# cmake-format: on
 
 INSTALL_PREFIX?=.install/
 PROJECT?=$(shell basename $(CURDIR))