From 37e846820763906bdcf1c0de3182259921909044 Mon Sep 17 00:00:00 2001 From: David G Yu Date: Thu, 4 Feb 2021 10:08:43 -0800 Subject: [PATCH] Updated for rename of 'master' branch to 'release' Documentation and build scripts have been updated to accommodate this renaming. --- CMakeLists.txt | 6 +++--- README.md | 2 +- appveyor.yml | 2 +- azure-pipelines.yml | 2 +- documentation/OpenSubdiv.doxy | 2 +- documentation/contributing.rst | 20 ++++++++++---------- documentation/getting_started.rst | 14 +++++++------- documentation/processTutorials.py | 2 +- documentation/tutorials.rst | 2 +- 9 files changed, 26 insertions(+), 26 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index ee18c051..a144ce9d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -58,10 +58,10 @@ message(STATUS "Using cmake version ${CMAKE_VERSION}") #------------------------------------------------------------------------------- # Determine if the project is built as a subproject (using add_subdirectory) -# or if it is the master project. -set(MASTER_PROJECT OFF) +# or if it is the main project. +set(MAIN_PROJECT OFF) if (CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR) - set(MASTER_PROJECT ON) + set(MAIN_PROJECT ON) endif() # Specify the default install path diff --git a/README.md b/README.md index ec507b3a..c39d5faa 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ For more details about OpenSubdiv, see [Pixar Graphics Technologies](http://grap | | Linux | Windows | macOS | |:-------:|:---------:|:---------:|:---------:| | dev | [![Build Status](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_apis/build/status/PixarAnimationStudios.OpenSubdiv?branchName=dev&jobName=Linux)](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=dev) | [![Build Status](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_apis/build/status/PixarAnimationStudios.OpenSubdiv?branchName=dev&jobName=Windows)](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=dev) | [![Build Status](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_apis/build/status/PixarAnimationStudios.OpenSubdiv?branchName=dev&jobName=macOS)](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=dev) | -| master | [![Build Status](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_apis/build/status/PixarAnimationStudios.OpenSubdiv?branchName=master&jobName=Linux)](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=master) | [![Build Status](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_apis/build/status/PixarAnimationStudios.OpenSubdiv?branchName=master&jobName=Windows)](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=master) | [![Build Status](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_apis/build/status/PixarAnimationStudios.OpenSubdiv?branchName=master&jobName=macOS)](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=master) | +| release | [![Build Status](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_apis/build/status/PixarAnimationStudios.OpenSubdiv?branchName=release&jobName=Linux)](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=release) | [![Build Status](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_apis/build/status/PixarAnimationStudios.OpenSubdiv?branchName=release&jobName=Windows)](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=release) | [![Build Status](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_apis/build/status/PixarAnimationStudios.OpenSubdiv?branchName=release&jobName=macOS)](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=release) | ## Documents * [User Documents](http://graphics.pixar.com/opensubdiv/docs/intro.html) diff --git a/appveyor.yml b/appveyor.yml index 8f8b77df..042f1452 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -3,7 +3,7 @@ clone_folder: c:\projects\OpenSubdiv branches: only: - - master + - release - dev - dev_appv diff --git a/azure-pipelines.yml b/azure-pipelines.yml index 5d8a35fc..8ae74be4 100644 --- a/azure-pipelines.yml +++ b/azure-pipelines.yml @@ -1,5 +1,5 @@ trigger: -- master +- release - dev jobs: diff --git a/documentation/OpenSubdiv.doxy b/documentation/OpenSubdiv.doxy index 55e4573e..dfe69c3e 100644 --- a/documentation/OpenSubdiv.doxy +++ b/documentation/OpenSubdiv.doxy @@ -1108,7 +1108,7 @@ HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). +# it should be included in the main .chm file (NO). GENERATE_CHI = NO diff --git a/documentation/contributing.rst b/documentation/contributing.rst index b9e2ea55..d641477c 100644 --- a/documentation/contributing.rst +++ b/documentation/contributing.rst @@ -34,12 +34,12 @@ Contributing to OpenSubdiv Contributor License Agreement ============================= -In order for us to accept code submissions (merge git pull-requests), contributors -need to sign the Contributor License Agreement (CLA). There are two CLAs, one for -individuals and one for corporations. As for the end-user license, both are based -on Apache. They are found in the code repository (`individual form -`__, -`corporate form `__). +In order for us to accept code submissions (merge git pull-requests), contributors +need to sign the Contributor License Agreement (CLA). There are two CLAs, one for +individuals and one for corporations. As for the end-user license, both are based +on Apache. They are found in the code repository (`individual form +`__, +`corporate form `__). Please email the signed CLA to opensubdiv-cla@pixar.com. Understand Git @@ -64,7 +64,7 @@ changes. You will need to integrate changes from the source tree as you work; the following outlines the workflow used by core OpenSubdiv engineers at Pixar and DreamWorks: -#. Fork the master repository into your own local copy. This can be done via the +#. Fork the repository into your own local copy. This can be done via the GitHub website using the "fork" button. #. Clone your fork locally: @@ -78,7 +78,7 @@ and DreamWorks: result of cloning your remote repository, but upstream must be setup manually: | git remote add **upstream** https://github.com/PixarAnimationStudios/OpenSubdiv.git - + Verify your remotes are setup correctly: | git remote -v @@ -113,7 +113,7 @@ and DreamWorks: Notice the "--rebase" option here. It updates the current branch to the upstream/dev branch and rebases all edits so they are at the head of your local feature branch. - + Alternatively, you can rebase all your work at once when your feature is complete. @@ -122,7 +122,7 @@ Sending a Pull Request First, rebase and squash your changes appropriately to produce a clean set of changes at the head of your tree. We require changes to be grouped locally to -ensure that rolling back changes can be done easily. +ensure that rolling back changes can be done easily. If you've followed the steps above, your pending change should already be queued up as required. If you have not, you may need to rebase and squash changes at diff --git a/documentation/getting_started.rst b/documentation/getting_started.rst index 03000f79..1b7db4e1 100644 --- a/documentation/getting_started.rst +++ b/documentation/getting_started.rst @@ -40,7 +40,7 @@ You can access the OpenSubdiv Git repository at https://github.com/PixarAnimatio From there, there are several ways of downloading the OpenSubdiv source code. - - Zip archive : downloaded from `here `__ + - Zip archive : downloaded from `here `__ - Using a GUI client : you can find a list `here `__ Please refer to the documentation of your preferred application. @@ -75,7 +75,7 @@ Since version 1.1.0, OpenSubdiv has adopted the `Git Flow Our active development branch is named *dev* : all new features and bug fixes should be submitted to this branch. The changes submitted to the dev branch are periodically -patched to the 'master' branch as new versions are released. +patched to the 'release' branch as new versions are released. .. image:: images/git_flow.png :align: center @@ -88,7 +88,7 @@ _____________________ The Git Flow `tools `__ are not a requisite for working with the OpenSubdiv code base, but new work should always be performed in the *dev* branch, or dedicated feature-branches. By default, a cloned repository -will be pointing to the 'master' branch. You can switch to the *dev* branch using +will be pointing to the 'release' branch. You can switch to the *dev* branch using the following command: .. code:: c++ @@ -106,14 +106,14 @@ Which should return: .. code:: c++ * dev - master + release API Versions ____________ OpenSubdiv maintains an internal API versioning system. The version number can be -read from the file `./opensubdiv/version.h `__. +read from the file `./opensubdiv/version.h `__. Following the Git-Flow pattern, our releases are indexed using Git's tagging system. @@ -132,7 +132,7 @@ Checking out version 1.2.0: Making Changes ______________ -Direct push access to the OpenSubdiv master repository is currently limited to a +Direct push access to the OpenSubdiv repository is currently limited to a small internal development team. External code should be submitted by sending Git `pull-requests `__ from forks of our *dev* branch. @@ -157,7 +157,7 @@ The OpenSubdiv code base contains the following main areas: | **./tutorials/** | Tutorials showing how to manipulate the APIs of OpenSubdiv. | +----------------------+---------------------------------------------------------------------------------------+ | **./documentation/** | The reStructuredText source files along with python scripts that generate the HTML | -| | documentation site. | +| | documentation site. | +----------------------+---------------------------------------------------------------------------------------+ | **./regression/** | Standalone regression tests and baseline data to help maintain the integrity of | | | our APIs. If GPU SDKs are detected, some tests will attempt to run computations | diff --git a/documentation/processTutorials.py b/documentation/processTutorials.py index e6329152..8889de08 100755 --- a/documentation/processTutorials.py +++ b/documentation/processTutorials.py @@ -64,7 +64,7 @@ def Process(srcfile, title): rest += basename+"\n" rest += ("-" * len(basename))+"\n\n" - rest += "``_\n" + rest += "``_\n" rest += ("\n" "----\n" diff --git a/documentation/tutorials.rst b/documentation/tutorials.rst index b720ba98..2f93e4c7 100644 --- a/documentation/tutorials.rst +++ b/documentation/tutorials.rst @@ -32,7 +32,7 @@ Tutorials ---- The tutorial source code can be found in the `github.com repository -`__ +`__ or in your local ``/tutorials``. Far Tutorials