github: Use main instead of master
authorJuan Ramos <juan@lunarg.com>
Mon, 23 Jan 2023 18:01:28 +0000 (11:01 -0700)
committerJuan Ramos <114601453+juan-lunarg@users.noreply.github.com>
Mon, 23 Jan 2023 19:45:23 +0000 (12:45 -0700)
closes #1107

.github/workflows/build.yml
BUILD.md
CONTRIBUTING.md
README.md
docs/LoaderApplicationInterface.md
docs/LoaderDriverInterface.md
docs/LoaderInterfaceArchitecture.md
docs/LoaderLayerInterface.md
scripts/check_code_format.sh
scripts/update_deps.py

index ac1ca2a19ff596d39c0b547cdb42c150a39b83f6..696714511d3a1d6e0edd907427372a3af3820246 100644 (file)
@@ -21,7 +21,7 @@ on:
     push:
     pull_request:
         branches:
-            - master
+            - main
 
 jobs:
     linux:
index 9b5a8f64054a14c5077fa302c564ceefb16ed1d5..5aaf23cdd0eaa17d5effa482f6e310d525b1374e 100644 (file)
--- 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
index 6faaf8851e9743ec8d7f692fcb45d62385d931dd..d794cc722654e392f8af042e0214809c8e5a5fc2 100644 (file)
@@ -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
 
index adb80ab8c2186892950028805369f7a51415c5ba..43a732c352d184ac904ced558702574f4930bec0 100644 (file)
--- 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
 
index 9b9eef25c1fc8644a60186177fda6ffac3af5634..14b856e1e823f7176fc46a0f92deedc0dd530959 100644 (file)
@@ -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.
index f7f501fc688c4c44c4f319d989eba131fb27cbbc..ccd26134864a90b42f7211e958fe91d3d76844e4 100644 (file)
@@ -1524,7 +1524,7 @@ Android Vulkan documentation</a>.
         possibly including crashes or corruption.
     </td>
     <td><small>
-        <a href="https://github.com/KhronosGroup/VK-GL-CTS/blob/master/external/openglcts/README.md">
+        <a href="https://github.com/KhronosGroup/VK-GL-CTS/blob/main/external/openglcts/README.md">
         Vulkan CTS Documentation</a>
         </small>
     </td>
index d3dd181cb48ab72e2970536d668efe84fc19b946..543fc71fbada1b54bb73b6b65219f828a4cd1f07 100644 (file)
@@ -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).
 <br/>
 <br/>
 
index 1d0a3be78e72fbdb4593928620a46e2df78c8be1..eeae72cadae329197ca4c75b5cb4ef9a6dc29058 100644 (file)
@@ -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>.
     <td>A layer <b>must</b> 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
-        <a href="https://github.com/LunarG/VulkanTools/blob/master/vkconfig_core/layers/layers_schema.json">
+        <a href="https://github.com/LunarG/VulkanTools/blob/main/vkconfig_core/layers/layers_schema.json">
         the layer schema</a> prior to publication.</br>
         The <b>only</b> exception is on Android which determines layer
         functionality through the introspection functions defined in
@@ -2271,7 +2271,7 @@ Android Vulkan documentation</a>.
     <td>Yes</td>
     <td>No</td>
     <td><small>
-        <a href="https://github.com/KhronosGroup/VK-GL-CTS/blob/master/external/openglcts/README.md">
+        <a href="https://github.com/KhronosGroup/VK-GL-CTS/blob/main/external/openglcts/README.md">
         Vulkan CTS Documentation</a>
         </small>
     </td>
index dde4379482538042bc94428288656c52edbdaf4b..1b07cf2168e98d5dc90a858bf3d29c4af59dd447 100755 (executable)
@@ -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}"
index 8a576d38f24804629483c8ff2f422c5c60a40817..d7c043f9ff4c3dd6cb82ecc47ec740b201288732 100755 (executable)
@@ -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',