Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Major non-content documentation fixes. #773

Merged
merged 1 commit into from
Sep 21, 2023

Major non-content documentation fixes.

0e8ba2d
Select commit
Loading
Failed to load commit list.
Merged

Major non-content documentation fixes. #773

Major non-content documentation fixes.
0e8ba2d
Select commit
Loading
Failed to load commit list.
Travis CI / Travis CI - Branch succeeded Sep 21, 2023 in 2h 16m 29s

Build Passed

The build passed.

Details

This is a normal build for the doc-fixes branch. You should be able to reproduce it by checking out the branch locally.

Jobs and Stages

This build has 18 jobs, running in parallel.

Job Compiler Xcode ENV OS State
3706.1 xcode14.2 BUILD_DIR=build macOS passed
3706.2 xcode14.2 BUILD_DIR=build macOS passed
3706.3 xcode14.2 BUILD_DIR=build macOS passed
3706.4 xcode14.2 BUILD_DIR=build macOS passed
3706.5 xcode14.2 BUILD_DIR=build macOS passed
3706.6 xcode14.2 BUILD_DIR=build macOS passed
3706.7 xcode14.2 BUILD_DIR=build macOS passed
3706.8 xcode14.2 BUILD_DIR=build macOS passed
3706.9 xcode14.2 BUILD_DIR=build macOS passed
3706.10 BUILD_DIR=build Linux passed
3706.11 gcc BUILD_DIR=build Linux passed
3706.12 gcc BUILD_DIR=build Linux passed
3706.13 gcc BUILD_DIR=build Linux passed
3706.14 gcc BUILD_DIR=build Linux passed
3706.15 gcc BUILD_DIR=build Linux passed
3706.16 gcc BUILD_DIR=build Linux passed
3706.17 clang BUILD_DIR=build Linux passed
3706.18 clang BUILD_DIR=build Linux passed

Build Configuration

Build Option Setting
Language C++
Operating System macOS
Xcode Version xcode14.2
Build Configuration
{
  "language": "cpp",
  "os": [
    "osx"
  ],
  "osx_image": [
    "xcode14.2"
  ],
  "addons": {
    "homebrew": {
      "packages": [
        "git-lfs",
        "doxygen",
        "sdl2"
      ]
    }
  },
  "env": [
    "global={:BUILD_DIR=>\"build\"}={:CHECK_REUSE=>\"false\"}={:FEATURE_TESTS=>\"true\"}={:GIT_LFS_SKIP_SMUDGE=>\"1\"}={:PACKAGE=>\"false\"}={:REL_DESC_FILE=>\"$BUILD_DIR/rel_desc.md\"}={:VULKAN_SDK_VER=>\"1.3.243.0\"}={:VULKAN_INSTALL_DIR=>\"$HOME/VulkanSDK/$VULKAN_SDK_VER\"}={:VULKAN_SDK=>\"$VULKAN_INSTALL_DIR/macOS\"}={:WASM_BUILD=>\"false\"}={:WERROR=>\"true\"} jobs={:CONFIGURATION=>\"Debug,Release\", :PLATFORM=>\"macOS\", :ARCHS=>\"x86_64\", :FEATURE_DOC=>\"ON\", :FEATURE_JNI=>\"ON\", :FEATURE_LOADTESTS=>\"OpenGL+Vulkan\", :FEATURE_TOOLS=>\"ON\", :FEATURE_TOOLS_CTS=>\"ON\", :SUPPORT_SSE=>\"ON\", :SUPPORT_OPENCL=>\"OFF\", :DEPLOY_DOCS=>\"YES\", :PACKAGE=>\"YES\"}={:CONFIGURATION=>\"Release\", :PLATFORM=>\"macOS\", :ARCHS=>\"arm64\", :FEATURE_DOC=>\"ON\", :FEATURE_JNI=>\"ON\", :FEATURE_LOADTESTS=>\"OpenGL+Vulkan\", :FEATURE_TESTS=>\"OFF\", :FEATURE_TOOLS=>\"ON\", :FEATURE_TOOLS_CTS=>\"OFF\", :SUPPORT_SSE=>\"ON\", :SUPPORT_OPENCL=>\"OFF\", :PACKAGE=>\"YES\"}={:CONFIGURATION=>\"Release\", :PLATFORM=>\"macOS\", :ARCHS=>\"x86_64\", :FEATURE_DOC=>\"OFF\", :FEATURE_JNI=>\"OFF\", :FEATURE_LOADTESTS=>\"OFF\", :FEATURE_TOOLS=>\"OFF\", :FEATURE_TOOLS_CTS=>\"OFF\", :SUPPORT_SSE=>\"ON\", :SUPPORT_OPENCL=>\"ON\"}={:CONFIGURATION=>\"Release\", :PLATFORM=>\"macOS\", :ARCHS=>\"arm64\", :FEATURE_DOC=>\"OFF\", :FEATURE_JNI=>\"OFF\", :FEATURE_LOADTESTS=>\"OFF\", :FEATURE_TESTS=>\"OFF\", :FEATURE_TOOLS=>\"OFF\", :FEATURE_TOOLS_CTS=>\"OFF\", :SUPPORT_SSE=>\"ON\", :SUPPORT_OPENCL=>\"ON\"}={:CONFIGURATION=>\"Release\", :PLATFORM=>\"macOS\", :ARCHS=>\"x86_64\", :FEATURE_DOC=>\"OFF\", :FEATURE_JNI=>\"OFF\", :FEATURE_LOADTESTS=>\"OFF\", :FEATURE_TOOLS=>\"OFF\", :FEATURE_TOOLS_CTS=>\"OFF\", :SUPPORT_SSE=>\"OFF\", :SUPPORT_OPENCL=>\"ON\"}={:CONFIGURATION=>\"Release\", :PLATFORM=>\"macOS\", :ARCHS=>\"arm64\", :FEATURE_DOC=>\"OFF\", :FEATURE_JNI=>\"OFF\", :FEATURE_LOADTESTS=>\"OFF\", :FEATURE_TESTS=>\"OFF\", :FEATURE_TOOLS=>\"OFF\", :FEATURE_TOOLS_CTS=>\"OFF\", :SUPPORT_SSE=>\"OFF\", :SUPPORT_OPENCL=>\"ON\"}={:CONFIGURATION=>\"Release\", :PLATFORM=>\"macOS\", :ARCHS=>\"x86_64\", :FEATURE_DOC=>\"OFF\", :FEATURE_JNI=>\"OFF\", :FEATURE_LOADTESTS=>\"OFF\", :FEATURE_TOOLS=>\"OFF\", :FEATURE_TOOLS_CTS=>\"OFF\", :SUPPORT_SSE=>\"OFF\", :SUPPORT_OPENCL=>\"OFF\"}={:CONFIGURATION=>\"Release\", :PLATFORM=>\"macOS\", :ARCHS=>\"arm64\", :FEATURE_DOC=>\"OFF\", :FEATURE_JNI=>\"OFF\", :FEATURE_LOADTESTS=>\"OFF\", :FEATURE_TESTS=>\"OFF\", :FEATURE_TOOLS=>\"OFF\", :FEATURE_TOOLS_CTS=>\"OFF\", :SUPPORT_SSE=>\"OFF\", :SUPPORT_OPENCL=>\"OFF\"}={:CONFIGURATION=>\"Debug,Release\", :PLATFORM=>\"iOS\", :FEATURE_DOC=>\"OFF\", :FEATURE_JNI=>\"OFF\", :FEATURE_LOADTESTS=>\"OpenGL+Vulkan\", :FEATURE_TOOLS=>\"OFF\", :FEATURE_TOOLS_CTS=>\"OFF\", :SUPPORT_SSE=>\"OFF\", :SUPPORT_OPENCL=>\"OFF\", :PACKAGE=>\"YES\"}"
  ],
  "jobs": {
    "include": [
      {
        "os": "linux",
        "dist": "jammy",
        "env": [
          {
            "CHECK_REUSE": "ONLY"
          }
        ]
      },
      {
        "os": "linux",
        "dist": "jammy",
        "compiler": "gcc",
        "env": [
          {
            "VULKAN_SDK_VER": "1.3.243"
          },
          {
            "CMAKE_GEN": "Ninja"
          },
          {
            "CONFIGURATION": "Debug",
            "FEATURE_DOC": "OFF",
            "FEATURE_JNI": "ON",
            "FEATURE_LOADTESTS": "OpenGL+Vulkan",
            "FEATURE_TOOLS": "ON",
            "SUPPORT_SSE": "ON",
            "SUPPORT_OPENCL": "OFF",
            "WERROR": "ON"
          }
        ]
      },
      {
        "os": "linux",
        "dist": "jammy",
        "compiler": "gcc",
        "env": [
          {
            "VULKAN_SDK_VER": "1.3.243"
          },
          {
            "CMAKE_GEN": "Ninja"
          },
          {
            "CONFIGURATION": "Release",
            "FEATURE_DOC": "ON",
            "FEATURE_JNI": "ON",
            "FEATURE_LOADTESTS": "OpenGL+Vulkan",
            "FEATURE_TOOLS": "ON",
            "SUPPORT_SSE": "ON",
            "SUPPORT_OPENCL": "OFF",
            "WERROR": "ON",
            "PACKAGE": "YES"
          }
        ]
      },
      {
        "os": "linux",
        "arch": "arm64",
        "dist": "jammy",
        "compiler": "gcc",
        "env": [
          {
            "VULKAN_SDK_VER": "1.3.243"
          },
          {
            "CMAKE_GEN": "Ninja"
          },
          {
            "CONFIGURATION": "Release",
            "FEATURE_DOC": "ON",
            "FEATURE_JNI": "ON",
            "FEATURE_LOADTESTS": "OpenGL",
            "FEATURE_TOOLS": "ON",
            "FEATURE_TOOLS_CTS": "OFF",
            "SUPPORT_SSE": "OFF",
            "SUPPORT_OPENCL": "OFF",
            "WERROR": "ON",
            "PACKAGE": "YES"
          }
        ]
      },
      {
        "os": "linux",
        "dist": "jammy",
        "compiler": "gcc",
        "env": [
          {
            "CMAKE_GEN": "Ninja"
          },
          {
            "CONFIGURATION": "Release",
            "FEATURE_DOC": "OFF",
            "FEATURE_JNI": "OFF",
            "FEATURE_LOADTESTS": "OFF",
            "FEATURE_TOOLS": "OFF",
            "FEATURE_TOOLS_CTS": "OFF",
            "SUPPORT_SSE": "ON",
            "SUPPORT_OPENCL": "ON",
            "WERROR": "ON",
            "PACKAGE": "NO"
          }
        ]
      },
      {
        "os": "linux",
        "dist": "jammy",
        "compiler": "gcc",
        "env": [
          {
            "CMAKE_GEN": "Ninja"
          },
          {
            "CONFIGURATION": "Release",
            "FEATURE_DOC": "OFF",
            "FEATURE_JNI": "OFF",
            "FEATURE_LOADTESTS": "OFF",
            "FEATURE_TOOLS": "OFF",
            "FEATURE_TOOLS_CTS": "OFF",
            "SUPPORT_SSE": "OFF",
            "SUPPORT_OPENCL": "ON",
            "WERROR": "ON",
            "PACKAGE": "NO"
          }
        ]
      },
      {
        "os": "linux",
        "dist": "jammy",
        "compiler": "gcc",
        "env": [
          {
            "CMAKE_GEN": "Ninja"
          },
          {
            "CONFIGURATION": "Release",
            "FEATURE_DOC": "OFF",
            "FEATURE_JNI": "OFF",
            "FEATURE_LOADTESTS": "OFF",
            "FEATURE_TOOLS": "OFF",
            "FEATURE_TOOLS_CTS": "OFF",
            "SUPPORT_SSE": "OFF",
            "SUPPORT_OPENCL": "OFF",
            "WERROR": "ON",
            "PACKAGE": "NO"
          }
        ]
      },
      {
        "os": "linux",
        "dist": "jammy",
        "compiler": "clang",
        "services": [
          "docker"
        ],
        "env": [
          {
            "WASM_BUILD": "YES"
          },
          {
            "CONFIGURATION": "Debug",
            "FEATURE_DOC": "OFF",
            "FEATURE_JNI": "OFF",
            "FEATURE_LOADTESTS": "OpenGL",
            "SUPPORT_SSE": "OFF",
            "SUPPORT_OPENCL": "OFF",
            "WERROR": "ON"
          }
        ]
      },
      {
        "os": "linux",
        "dist": "jammy",
        "compiler": "clang",
        "services": [
          "docker"
        ],
        "env": [
          {
            "WASM_BUILD": "YES"
          },
          {
            "CONFIGURATION": "Release",
            "FEATURE_DOC": "OFF",
            "FEATURE_JNI": "OFF",
            "FEATURE_LOADTESTS": "OpenGL",
            "SUPPORT_SSE": "OFF",
            "SUPPORT_OPENCL": "OFF",
            "WERROR": "ON",
            "PACKAGE": "YES"
          }
        ]
      }
    ]
  },
  "before_install": [
    "echo -n \"Running on the following travis CI runner: \" && uname -a\n",
    "echo -n \"CMake version on the runner is \" && cmake --version\n",
    "echo -e \"machine github.com\\n  login $GITHUB_TOKEN\" >> ~/.netrc",
    "cat ~/.netrc",
    "case \"${TRAVIS_OS_NAME:-linux}\" in\nlinux)\n  if [ \"$WASM_BUILD\" = \"YES\" ]; then\n    # Need to set uid/gid because, unlike when running docker locally,\n    # /src ends up being owned by the uid/gid running this script and\n    # the recent fix for CVE-2022-24765 in Git causes Git to error\n    # when the repo owner differs from the user. For details see\n    # https://github.blog/2022-04-12-git-security-vulnerability-announced/\n    docker run -dit --name emscripten --user \"$(id -u):$(id -g)\" -v $(pwd):/src emscripten/emsdk bash\n  elif [ \"$CHECK_REUSE\" != \"ONLY\" ]; then\n    sudo apt-get update\n  fi\n  ;;\nesac\n"
  ],
  "install": [
    "case \"${TRAVIS_OS_NAME:-linux}\" in\nlinux)\n  if [ \"$CHECK_REUSE\" = \"YES\" -o \"$CHECK_REUSE\" = \"ONLY\" ]; then\n    set -e  # because the if below swallows a bad exit status.\n    pip3 install reuse\n    set +e\n  fi\n  if [ \"$CHECK_REUSE\" != \"ONLY\" -a \"$WASM_BUILD\" != \"YES\" ]; then\n    if [ \"$TRAVIS_CPU_ARCH\" = \"arm64\" ]; then\n      # JDK was not installed on arm64 runner. Kept for reference.\n      #sudo apt-get -qq install openjdk-17-jdk\n      # Must be manually set. Setting JAVA_HOME might be an alternative.\n      #sudo ln -s -f /usr/lib/jvm/java-1.17.0-openjdk-arm64 /usr/lib/jvm/default-java\n      # Runner now has JDK but is not setting JAVA_HOME or default-java.\n      # Delete this when fixed.\n      export JAVA_HOME=/usr/lib/jvm/temurin-11-jdk-arm64\n    fi\n    echo \"JAVA_HOME = $JAVA_HOME\"\n    echo \"/usr/lib/jvm\"\n    ls -l /usr/lib/jvm\n    echo \"/usr/local/lib/jvm\"\n    ls -l /usr/local/lib/jvm\n    ./ci_scripts/install_linux.sh\n  fi\n  ;;\nosx)\n  ./ci_scripts/install_macos.sh\n  ;;\nesac\n"
  ],
  "before_script": [
    "git fetch --unshallow --tags",
    "case \"${TRAVIS_OS_NAME:-linux}\" in\nlinux)\n  ;;\nosx)\n  ./ci_scripts/before_build_macos.sh\n  ;;\nesac\n",
    "./install-gitconfig.sh",
    "ci_scripts/smudge_date.sh"
  ],
  "script": [
    "case \"${TRAVIS_OS_NAME:-linux}\" in\nlinux)\n  if [ \"$CHECK_REUSE\" = \"YES\" -o \"$CHECK_REUSE\" = \"ONLY\" ]; then\n    echo \"Calling reuse lint.\"\n    set -e  # because the if below swallows a bad exit status.\n    reuse lint\n    set +e\n  fi\n  if [ \"$CHECK_REUSE\" != \"ONLY\" ]; then\n    if [ \"$WASM_BUILD\" = \"YES\" ]; then\n      ./ci_scripts/build_wasm_docker.sh\n    else\n      ./ci_scripts/build_linux.sh\n    fi\n  fi\n  ;;\nosx)\n  if [ \"$PLATFORM\" = \"macOS\" ]; then\n    ./ci_scripts/build_macos.sh\n  else\n    ./ci_scripts/build_ios.sh\n  fi\n  ;;\nesac\n"
  ],
  "after_failure": [
    "./ci_scripts/on_failure.sh"
  ],
  "after_success": [
],
"before_deploy": [
"gem install octokit:'> 4.15.0' mime-types\ncase "${TRAVIS_OS_NAME:-linux}" in\nlinux)\n  ;;\nosx)\n  # Only notarize if we're going to deploy. I.e on a tag. Also check for\n  # access to signing certs to make sure we don't try this on a fork which\n  # has a tag.\n  #\n  # Although undocumented, except for a blog post, before_deploy is run for\n  # each deployment so we need to take steps to prevent notarization being\n  # run twice. https://github.com/travis-ci/travis-ci/issues/2570 about\n  # this has been open for years. What a crock!\n  if [ -n "$MACOS_CERTIFICATES_P12" -a -n "$TRAVIS_TAG" -a -z "$NOTARIZED" ]; then\n    ./ci_scripts/notarize.sh $BUILD_DIR/KTX-Software-.pkg $APPLE_ID $DEVELOPMENT_TEAM $ALTOOL_PASSWORD && export NOTARIZED="true"\n  fi\n  ;;\nesac\nif [ ! -f $REL_DESC_FILE -a -f RELEASE_NOTES.md ]; then\n  # Remove lines that are unnecessary in the context of a GitHub\n  # release description.\n  awk '/^Release Notes/,/^## Version/ { next }\n       ! /<!-- Copyright/ && ! /<!-- SPDX/ { print }' RELEASE_NOTES.md \\n  > $REL_DESC_FILE\n  # dpl v2 alternative\n  #RELNOTES=$(awk '/^Release Notes/,/^## Version/ { next }\n  #     ! /<!-- Copyright/ && ! /<!-- SPDX/ { print }' RELEASE_NOTES.md)\nfi\n"
],
"deploy": [
{
"provider": "pages",
"strategy": "git",
"edge": true,
"token": "$GITHUB_TOKEN",
"local_dir": "$BUILD_DIR/docs/html",
"on": {
"tags": true,
"condition": [
"$DEPLOY_DOCS = YES"
]
}
},
{
"provider": "script",
"edge": true,
"script": "ruby ci_scripts/github_release.rb -s ${GITHUB_TOKEN} -r ${TRAVIS_REPO_SLUG} -c $REL_DESC_FILE -t ${TRAVIS_TAG} --overwrite true --draft true --prerelease true $BUILD_DIR/KTX-Software--*",
"on": {
"tags": true,
"condition": [
"$PACKAGE = "YES" && $TRAVIS_TAG = ^v[0-9].*"
]
}
}
]
}