From c757a2a8f8d1ef46e5f11e9308f1d5c7cd3bb8a3 Mon Sep 17 00:00:00 2001 From: Juan Ramos Date: Mon, 16 Jan 2023 16:10:30 -0700 Subject: github: Use main instead of master closes #729 --- .github/workflows/build.yml | 7 ++----- BUILD.md | 7 +------ CONTRIBUTING.md | 6 +++--- README.md | 14 ++++++++++++-- scripts/check_code_format.sh | 4 ++-- scripts/update_deps.py | 2 +- vulkaninfo/json_validation_process.md | 2 +- vulkaninfo/vulkaninfo.md | 2 +- 8 files changed, 23 insertions(+), 21 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 205bdddc..fe47a53b 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -21,7 +21,7 @@ on: push: pull_request: branches: - - master + - main jobs: linux: @@ -113,10 +113,7 @@ jobs: env: cache-name: cache-macos-latest with: - path: | - external/Vulkan-Headers/build/install - external/MoltenVK - external/Vulkan-Loader/build/install + path: external/ key: ${{ runner.os }}-build-${{ env.cache-name }}-${{ matrix.config }}-${{ hashfiles('scripts/known_good.json') }} - name: Fetch/Update dependencies diff --git a/BUILD.md b/BUILD.md index 4b5eef7c..f5d16b24 100644 --- a/BUILD.md +++ b/BUILD.md @@ -93,7 +93,7 @@ from this set of release binaries. If you don't wish the CMake code to download these binaries, then you must clone the [glslang repository](https://github.com/KhronosGroup/glslang) and build its `install` target. Follow the build instructions in the glslang -[README.md](https://github.com/KhronosGroup/glslang/blob/master/README.md) +[README.md](https://github.com/KhronosGroup/glslang/blob/main/README.md) file. Ensure that the `update_glslang_sources.py` script has been run as part of building glslang. You must also take note of the glslang install directory and pass it on the CMake command line for building this repository, as @@ -677,11 +677,6 @@ NOTE: To force the OSX version set the environment variable [MACOSX_DEPLOYMENT_T Setup Homebrew and components -- Follow instructions on [brew.sh](http://brew.sh) to get Homebrew installed. - - /usr/bin/ruby -e "$(curl -fsSL \ - https://raw.githubusercontent.com/Homebrew/install/master/install)" - - Ensure Homebrew is at the beginning of your PATH: export PATH=/usr/local/bin:$PATH diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bad1de23..e3d5f0f3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -22,7 +22,7 @@ to work on an issue that is assigned, simply coordinate with the current assigne This will involve [forking the repository](https://help.github.com/articles/fork-a-repo/), creating a branch with your commits, and then [submitting a pull request](https://help.github.com/articles/using-pull-requests/). * Please read and adhere to the style and process [guidelines ](#coding-conventions-and-formatting) enumerated below. -* Please base your fixes on the master branch. SDK branches are generally not updated except for critical fixes needed to repair an SDK release. +* Please base your fixes on the main branch. SDK branches are generally not updated except for critical fixes needed to repair an SDK release. * The resulting Pull Request will be assigned to a repository maintainer. It is the maintainer's responsibility to ensure the Pull Request passes the Google/LunarG internal CI processes. Once the Pull Request has been approved and is passing internal CI, a repository maintainer will merge the PR. @@ -73,7 +73,7 @@ generator scripts in the `scripts` directory. All changes to these scripts _must corresponding generated output to keep the repository self-consistent. This requirement is enforced by both Travis CI and AppVeyor test configurations. Regenerate source files after modifying any of the generator scripts and before building and testing your changes. More details can be found in -[BUILD.md](https://github.com/KhronosGroup/Vulkan-Tools/blob/master/BUILD.md#generated-source-code). +[BUILD.md](https://github.com/KhronosGroup/Vulkan-Tools/blob/main/BUILD.md#generated-source-code). #### **Testing Your Changes** * Run the repository components with the Vulkan Validation Layers before and after each of your commits to check for any regressions. @@ -85,7 +85,7 @@ scripts and before building and testing your changes. More details can be found * In the `vulkaninfo` directory, run: > vulkaninfo * If you are adding or changing JSON output, please read - [Validating vulkaninfo JSON output](https://github.com/KhronosGroup/Vulkan-Tools/blob/master/vulkaninfo/json_validation_process.md). + [Validating vulkaninfo JSON output](https://github.com/KhronosGroup/Vulkan-Tools/blob/main/vulkaninfo/json_validation_process.md). **Note:** When adding new output to vulkaninfo, do NOT add JSON output unless the formmatting is defined by a schema. * Run tests that explicitly exercise your changes. * Feel free to subject your code changes to other tests as well! diff --git a/README.md b/README.md index e23d0091..ed26aa13 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,19 @@ This project provides Khronos official Vulkan Tools and Utilities for Windows, Linux, Android, and MacOS. -## CI Build Status -[![Build Status](https://github.com/KhronosGroup/Vulkan-Tools/workflows/CI%20Build/badge.svg?branch=master)](https://github.com/KhronosGroup/Vulkan-Tools/actions) +## Default branch changed to 'main' 2023-01-16 + +As discussed in #729, the default branch of this repository is now 'main'. This change should be largely transparent to repository users, since github rewrites many references to the old 'master' branch to 'main'. However, if you have a checked-out local clone, you may wish to take the following steps as recommended by github: +```sh +git branch -m master main +git fetch origin +git branch -u origin/main main +git remote set-head origin -a +``` + +## CI Build Status +[![Build Status](https://github.com/KhronosGroup/Vulkan-Tools/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/KhronosGroup/Vulkan-Tools/actions) ## Introduction diff --git a/scripts/check_code_format.sh b/scripts/check_code_format.sh index 216da478..dbd7b799 100755 --- a/scripts/check_code_format.sh +++ b/scripts/check_code_format.sh @@ -24,14 +24,14 @@ NC='\033[0m' # No Color clang-format --version -FILES_TO_CHECK=$(git diff --name-only master | grep -v -E "^include/vulkan" | grep -E ".*\.(cpp|cc|c\+\+|cxx|c|h|hpp)$") +FILES_TO_CHECK=$(git diff --name-only main | grep -v -E "^include/vulkan" | grep -E ".*\.(cpp|cc|c\+\+|cxx|c|h|hpp)$") if [ -z "${FILES_TO_CHECK}" ]; then echo -e "${GREEN}No source code to check for formatting.${NC}" exit 0 fi -FORMAT_DIFF=$(git diff -U0 master -- ${FILES_TO_CHECK} | python ./scripts/clang-format-diff.py -p1 -style=file) +FORMAT_DIFF=$(git diff -U0 main -- ${FILES_TO_CHECK} | python ./scripts/clang-format-diff.py -p1 -style=file) if [ -z "${FORMAT_DIFF}" ]; then echo -e "${GREEN}All source code in PR properly formatted.${NC}" diff --git a/scripts/update_deps.py b/scripts/update_deps.py index f892be0a..ff09871b 100755 --- a/scripts/update_deps.py +++ b/scripts/update_deps.py @@ -619,7 +619,7 @@ def main(): '--ref', dest='ref', default='', - help="Override 'commit' with git reference. E.g., 'origin/master'") + help="Override 'commit' with git reference. E.g., 'origin/main'") parser.add_argument( '--no-build', dest='do_build', diff --git a/vulkaninfo/json_validation_process.md b/vulkaninfo/json_validation_process.md index a4695331..32df4f6f 100644 --- a/vulkaninfo/json_validation_process.md +++ b/vulkaninfo/json_validation_process.md @@ -1,4 +1,4 @@ -# Validating [vulkaninfo](https://github.com/KhronosGroup/Vulkan-Tools/tree/master/vulkaninfo) JSON output +# Validating [vulkaninfo](https://github.com/KhronosGroup/Vulkan-Tools/tree/main/vulkaninfo) JSON output The format of vulkaninfo's JSON output is designed to be used as input for the [Vulkan Profiles](https://github.com/KhronosGroup/Vulkan-Profiles) diff --git a/vulkaninfo/vulkaninfo.md b/vulkaninfo/vulkaninfo.md index 7f1f287b..3e7456a1 100644 --- a/vulkaninfo/vulkaninfo.md +++ b/vulkaninfo/vulkaninfo.md @@ -98,7 +98,7 @@ Note: The Vulkan Info binary found in the Vulkan SDK is renamed to `vulkaninfoSD Vulkan Info is now avaialble for iOS devices, but must be built manually. -The Vulkan Info project contains a folder at [vulkaninfo/ios](https://github.com/KhronosGroup/Vulkan-Tools/tree/master/vulkaninfo/iOS) that contains an XCode project that will build Vulkan Info for iOS devices. In order to deploy to an iOS device, the developer must be a member of the [Apple Developer Program](https://developer.apple.com/programs/). In addition, Vulkan Info makes use of the [MoltenVK](https://github.com/KhronosGroup/MoltenVK) libraries, which is a seperate project from Vulkan-Tools and you will need to add the MoltenVK libraries to your XCode project manually. See the [LunarG Getting Started with the macOS SDK](https://vulkan.lunarg.com/doc/sdk/latest/mac/getting_started.html) guide for more information about using MoltenVK in the Vulkan SDK. +The Vulkan Info project contains a folder at [vulkaninfo/ios](https://github.com/KhronosGroup/Vulkan-Tools/tree/main/vulkaninfo/iOS) that contains an XCode project that will build Vulkan Info for iOS devices. In order to deploy to an iOS device, the developer must be a member of the [Apple Developer Program](https://developer.apple.com/programs/). In addition, Vulkan Info makes use of the [MoltenVK](https://github.com/KhronosGroup/MoltenVK) libraries, which is a seperate project from Vulkan-Tools and you will need to add the MoltenVK libraries to your XCode project manually. See the [LunarG Getting Started with the macOS SDK](https://vulkan.lunarg.com/doc/sdk/latest/mac/getting_started.html) guide for more information about using MoltenVK in the Vulkan SDK. When Vulkan Info is run on an iOS device, it will create the standard vulkaninfo.json file and also a portability.json file. An HTML file is also created, and is displayed in a webview on the iOS device when the application is run. These files are located on the iOS device, and are available via the [iOS application file sharing mechanism](https://support.apple.com/en-us/HT201301) via iTunes for Windows or macOS. You can also access these files using the macOS Finder or Windows Explorer when the device is attached to the host computer via a USB cable. Select the device, and navigate to the "vulkaninfo" folder to access these files. There is currently no supported means to access these files on an iOS device from a Linux host computer. -- cgit v1.2.3