From: Juan Ramos Date: Mon, 23 Jan 2023 18:01:28 +0000 (-0700) Subject: github: Use main instead of master X-Git-Tag: upstream/1.3.240~5 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=0a2c1bece62909bfbe740cb81243e93d4c1c8629;p=platform%2Fupstream%2FVulkan-Loader.git github: Use main instead of master closes #1107 --- diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index ac1ca2a1..69671451 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -21,7 +21,7 @@ on: push: pull_request: branches: - - master + - main jobs: linux: diff --git a/BUILD.md b/BUILD.md index 9b5a8f64..5aaf23cd 100644 --- a/BUILD.md +++ b/BUILD.md @@ -622,11 +622,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 6faaf885..d794cc72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,7 +42,7 @@ current assignee. [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. +* Please base your fixes on the `main` branch. SDK branches are generally not updated except for critical fixes needed to repair an SDK release. * Provide one or more tests which show a failure for the issue before your changes @@ -117,7 +117,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-Loader/blob/master/BUILD.md#generated-source-code). +[BUILD.md](BUILD.md#generated-source-code). #### Testing Your Changes diff --git a/README.md b/README.md index adb80ab8..43a732c3 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,20 @@ This project provides the Khronos official Vulkan ICD desktop loader for Windows, Linux, and MacOS. -## master to main upcoming change (January 23, 2023) +## Default branch changed to 'main' (January 23, 2023) -See https://github.com/KhronosGroup/Vulkan-ValidationLayers/issues/5084 for details. +As discussed in https://github.com/KhronosGroup/Vulkan-Loader/issues/1107, 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-Loader/workflows/CI%20Build/badge.svg?branch=master)](https://github.com/KhronosGroup/Vulkan-Loader/actions) +[![Build Status](https://github.com/KhronosGroup/Vulkan-Loader/workflows/CI%20Build/badge.svg?branch=main)](https://github.com/KhronosGroup/Vulkan-Loader/actions) ## Introduction diff --git a/docs/LoaderApplicationInterface.md b/docs/LoaderApplicationInterface.md index 9b9eef25..14b856e1 100644 --- a/docs/LoaderApplicationInterface.md +++ b/docs/LoaderApplicationInterface.md @@ -373,7 +373,7 @@ layer, dropping the need for meta layers. While not necessary for validation anymore, VkConfig does use meta layers to group layers together based on user's preferences. More can be found out about this functionality through both the -[VkConfig documentation](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/README.md) +[VkConfig documentation](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/README.md) and the section later on the [Override Layer](#override-layer). Meta-layers are detailed more in the @@ -446,7 +446,7 @@ The table below details more information: #### Override Layer The "Override Layer" is a special implicit meta-layer created by the -[VkConfig](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/README.md) +[VkConfig](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/README.md) tool and available by default when the tool is running. Once VkConfig exits, the override layer is removed, and the system should return to standard Vulkan behavior. @@ -469,7 +469,7 @@ the system-installed layers. This can be accomplished in one of two ways: 1. Selecting specific layer paths using the -[VkConfig](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/README.md) +[VkConfig](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/README.md) tool shipped with the Vulkan SDK. 2. Directing the loader to look for layers in specific files and/or folders by using the `VK_LAYER_PATH` environment variable. @@ -512,7 +512,7 @@ application they are using. This can be also be accomplished in one of two ways: 1. Selecting specific layers using the -[VkConfig](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/README.md) +[VkConfig](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/README.md) tool shipped with the Vulkan SDK. 2. Directing the loader to look for additional layers by name using the `VK_INSTANCE_LAYERS` environment variable. diff --git a/docs/LoaderDriverInterface.md b/docs/LoaderDriverInterface.md index f7f501fc..ccd26134 100644 --- a/docs/LoaderDriverInterface.md +++ b/docs/LoaderDriverInterface.md @@ -1524,7 +1524,7 @@ Android Vulkan documentation. possibly including crashes or corruption. - + Vulkan CTS Documentation diff --git a/docs/LoaderInterfaceArchitecture.md b/docs/LoaderInterfaceArchitecture.md index d3dd181c..543fc71f 100644 --- a/docs/LoaderInterfaceArchitecture.md +++ b/docs/LoaderInterfaceArchitecture.md @@ -226,7 +226,7 @@ In the future, VkConfig may have additional interactions with the Vulkan loader. More details on VkConfig can be found in its -[GitHub documentation](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/README.md). +[GitHub documentation](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/README.md).

diff --git a/docs/LoaderLayerInterface.md b/docs/LoaderLayerInterface.md index 1d0a3be7..eeae72ca 100644 --- a/docs/LoaderLayerInterface.md +++ b/docs/LoaderLayerInterface.md @@ -1176,7 +1176,7 @@ If any component layer is not present in the provided override paths, the meta layer is disabled. The override meta-layer is primarily enabled when using the -[VkConfig](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/README.md) +[VkConfig](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/README.md) tool included in the Vulkan SDK. It is typically only available while the VkConfig tool is actually executing. Please refer to that documentation for more information. @@ -1895,7 +1895,7 @@ application. #### Layer Manifest File Version 1.2.0 The ability to define the layer settings as defined by the -[layer manifest schema](https://github.com/LunarG/VulkanTools/blob/master/vkconfig_core/layers/layers_schema.json). +[layer manifest schema](https://github.com/LunarG/VulkanTools/blob/main/vkconfig_core/layers/layers_schema.json). The ability to briefly document the layer thanks to the fields: * "introduction": Presentation of the purpose of the layer in a paragraph. @@ -1905,7 +1905,7 @@ The ability to briefly document the layer thanks to the fields: These changes were made to enable third-party layers to expose their features within -[Vulkan Configurator](https://github.com/LunarG/VulkanTools/blob/master/vkconfig/README.md) +[Vulkan Configurator](https://github.com/LunarG/VulkanTools/blob/main/vkconfig/README.md) or other tools. #### Layer Manifest File Version 1.1.2 @@ -2193,7 +2193,7 @@ Android Vulkan documentation. A layer must have a valid JSON manifest file for the loader to process that ends with the ".json" suffix. It is recommended validating the layer manifest file against - + the layer schema prior to publication.
The only exception is on Android which determines layer functionality through the introspection functions defined in @@ -2271,7 +2271,7 @@ Android Vulkan documentation. Yes No - + Vulkan CTS Documentation diff --git a/scripts/check_code_format.sh b/scripts/check_code_format.sh index dde43794..1b07cf21 100755 --- a/scripts/check_code_format.sh +++ b/scripts/check_code_format.sh @@ -22,14 +22,14 @@ RED='\033[0;31m' GREEN='\033[0;32m' NC='\033[0m' # No Color -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 8a576d38..d7c043f9 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',