Merge pull request #648 from biojppm/doc

Improve documentation, add benchmark results

Author: biojppm

.github/workflows/benchmarks.yml

@@ -104,11 +104,11 @@ jobs:
           os: ubuntu-24.04
           cmkflags: -DCMAKE_CXX_COMPILER=clang++-18 -DCMAKE_C_COMPILER=clang-18
         - std: 17
-          comp: vs2022
-          os: windows-2022
-          cmkflags: -G 'Visual Studio 17 2022' -A x64
+          comp: vs2026
+          os: windows-2025
+          cmkflags: -G 'Visual Studio 18 2026' -A x64
         - std: 17
-          comp: xcode15
+          comp: xcode16
           os: macos-15-intel
           xcver: 16
           cmkflags: -G Xcode -DCMAKE_OSX_ARCHITECTURES=x86_64
@@ -169,16 +169,16 @@ jobs:
         which pip
         python --version
         pip --version
-        pip install -v -r ext/c4core/cmake/bm-xp/requirements.txt
+        pip install -v -r proj/c4proj/bm-xp/requirements.txt
         python -c 'import munch ; print("ok!") ; exit(0)'
         echo $?
     - name: configure-------------------------------------------------
       run: |
         cmake -S . -B build \
             ${{matrix.cmkflags}} \
             -DPython_EXECUTABLE="$(which python)" \
-            -DC4_CXX_STANDARD=${{matrix.std}} \
-            -DRYML_CXX_STANDARD=${{matrix.std}} \
+            -DCMAKE_CXX_STANDARD=${{matrix.std}} \
+            -DCMAKE_BUILD_TYPE=Release \
             -DRYML_BUILD_BENCHMARKS=ON
     - name: build
       run: cmake --build build --config Release --parallel --verbose --target ryml-bm-build
@@ -188,19 +188,14 @@ jobs:
       run: cmake --build build --config Release --verbose --target ryml-bm-plot
     - name: gather benchmark results-------------------------------------------
       run: |
-        set -x
-        source vars.sh
-        echo SRC_TAG=$SRC_TAG
-        echo SRC_VERSION=$SRC_VERSION
-        desc=$SRC_TAG
-        for bl in ${{matrix.bitlinks}} ; do
-          dst=$(echo ryml-benchmark_results/$desc/x86_64/${{matrix.cxx}}-${{matrix.bt}}-c++${{matrix.std}}-$bl | sed 's:++-:xx:g' | sed 's:+:x:g')
-          mkdir -p $dst
-          find build -name bm-results
-          mv -vf build/$bl/bm/bm-results/* $dst/.
-        done
+        set -xe
+        desc=`cd proj/ ; make describe`
+        dst=ryml-benchmark-results/$desc/x86_64/
+        name=${{matrix.comp}}-Release-cxx${{matrix.std}}
+        mkdir -p $dst
+        mv -vf build/bm/bm-results/ $dst/$name
     - name: upload benchmark result artifacts
       uses: actions/upload-artifact@v7
       with:
-        name: ryml-benchmark_results-${{strategy.job-index}}
-        path: ryml-benchmark_results/
+        name: ryml-benchmark-results-${{matrix.comp}}
+        path: ryml-benchmark-results/

.github/workflows/benchmarks.ys

@@ -21,9 +21,8 @@ jobs:
         include:
         - {std: 17, comp: gcc14  , os: ubuntu-24.04, cmkflags: -DCMAKE_CXX_COMPILER=g++-14     -DCMAKE_C_COMPILER=gcc-14}
         - {std: 17, comp: clang18, os: ubuntu-24.04, cmkflags: -DCMAKE_CXX_COMPILER=clang++-18 -DCMAKE_C_COMPILER=clang-18}
-        #- {std: 17, comp: vs2019 , os: windows-2019, cmkflags: -G 'Visual Studio 16 2019' -A x64}
-        - {std: 17, comp: vs2022 , os: windows-2022, cmkflags: -G 'Visual Studio 17 2022' -A x64}
-        - {std: 17, comp: xcode15, os: macos-15-intel, xcver: 16, cmkflags: -G Xcode -DCMAKE_OSX_ARCHITECTURES=x86_64}
+        - {std: 17, comp: vs2026 , os: windows-2025, cmkflags: -G 'Visual Studio 18 2026' -A x64}
+        - {std: 17, comp: xcode16, os: macos-15-intel, xcver: 16, cmkflags: -G Xcode -DCMAKE_OSX_ARCHITECTURES=x86_64}
     env:: +{'BM' 'ON'} + load('share/env.yaml')
     steps:
     - :: checkout-action
@@ -41,16 +40,16 @@ jobs:
         which pip
         python --version
         pip --version
-        pip install -v -r ext/c4core/cmake/bm-xp/requirements.txt
+        pip install -v -r proj/c4proj/bm-xp/requirements.txt
         python -c 'import munch ; print("ok!") ; exit(0)'
         echo $?
     - name: configure-------------------------------------------------
       run: |
         cmake -S . -B build \
             ${{matrix.cmkflags}} \
             -DPython_EXECUTABLE="$(which python)" \
-            -DC4_CXX_STANDARD=${{matrix.std}} \
-            -DRYML_CXX_STANDARD=${{matrix.std}} \
+            -DCMAKE_CXX_STANDARD=${{matrix.std}} \
+            -DCMAKE_BUILD_TYPE=Release \
             -DRYML_BUILD_BENCHMARKS=ON
     - name: build
       run: cmake --build build --config Release --parallel --verbose --target ryml-bm-build
@@ -60,19 +59,14 @@ jobs:
       run: cmake --build build --config Release --verbose --target ryml-bm-plot
     - name: gather benchmark results-------------------------------------------
       run: |
-        set -x
-        source vars.sh
-        echo SRC_TAG=$SRC_TAG
-        echo SRC_VERSION=$SRC_VERSION
-        desc=$SRC_TAG
-        for bl in ${{matrix.bitlinks}} ; do
-          dst=$(echo ryml-benchmark_results/$desc/x86_64/${{matrix.cxx}}-${{matrix.bt}}-c++${{matrix.std}}-$bl | sed 's:++-:xx:g' | sed 's:+:x:g')
-          mkdir -p $dst
-          find build -name bm-results
-          mv -vf build/$bl/bm/bm-results/* $dst/.
-        done
+        set -xe
+        desc=`cd proj/ ; make describe`
+        dst=ryml-benchmark-results/$desc/x86_64/
+        name=${{matrix.comp}}-Release-cxx${{matrix.std}}
+        mkdir -p $dst
+        mv -vf build/bm/bm-results/ $dst/$name
     - name: upload benchmark result artifacts
       uses: actions/upload-artifact@v7
       with:
-        name: ryml-benchmark_results-${{strategy.job-index}}
-        path: ryml-benchmark_results/
+        name: ryml-benchmark-results-${{matrix.comp}}
+        path: ryml-benchmark-results/