mirror of
https://github.com/PixarAnimationStudios/OpenSubdiv
synced 2024-11-24 20:40:15 +00:00
Updated for rename of 'master' branch to 'release'
Documentation and build scripts have been updated to accommodate this renaming.
This commit is contained in:
David G Yu
parent
ed544590be
commit
37e8468207
@ -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
|
||||
|
||||
@ -11,7 +11,7 @@ For more details about OpenSubdiv, see [Pixar Graphics Technologies](http://grap
|
||||
| | Linux | Windows | macOS |
|
||||
|:-------:|:---------:|:---------:|:---------:|
|
||||
| dev | [](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=dev) | [](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=dev) | [](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=dev) |
|
||||
| master | [](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=master) | [](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=master) | [](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=master) |
|
||||
| release | [](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=release) | [](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=release) | [](https://dev.azure.com/PixarAnimationStudios/OpenSubdiv/_build/latest?definitionId=2&branchName=release) |
|
||||
|
||||
## Documents
|
||||
* [User Documents](http://graphics.pixar.com/opensubdiv/docs/intro.html)
|
||||
|
||||
@ -3,7 +3,7 @@ clone_folder: c:\projects\OpenSubdiv
|
||||
|
||||
branches:
|
||||
only:
|
||||
- master
|
||||
- release
|
||||
- dev
|
||||
- dev_appv
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
trigger:
|
||||
- master
|
||||
- release
|
||||
- dev
|
||||
|
||||
jobs:
|
||||
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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
|
||||
<https://github.com/PixarAnimationStudios/OpenSubdiv/blob/master/OpenSubdivCLA_individual.pdf>`__,
|
||||
`corporate form <https://github.com/PixarAnimationStudios/OpenSubdiv/blob/master/OpenSubdivCLA_corporate.pdf>`__).
|
||||
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
|
||||
<https://github.com/PixarAnimationStudios/OpenSubdiv/blob/release/OpenSubdivCLA_individual.pdf>`__,
|
||||
`corporate form <https://github.com/PixarAnimationStudios/OpenSubdiv/blob/release/OpenSubdivCLA_corporate.pdf>`__).
|
||||
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
|
||||
|
||||
@ -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 <https://github.com/PixarAnimationStudios/OpenSubdiv/archive/master.zip>`__
|
||||
- Zip archive : downloaded from `here <https://github.com/PixarAnimationStudios/OpenSubdiv/archive/release.zip>`__
|
||||
|
||||
- Using a GUI client : you can find a list `here <http://git-scm.com/downloads/guis>`__
|
||||
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 <https://github.com/nvie/gitflow>`__ 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 <https://github.com/PixarAnimationStudios/OpenSubdiv/blob/master/opensubdiv/version.h>`__.
|
||||
read from the file `./opensubdiv/version.h <https://github.com/PixarAnimationStudios/OpenSubdiv/blob/release/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 <https://help.github.com/articles/using-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 |
|
||||
|
||||
@ -64,7 +64,7 @@ def Process(srcfile, title):
|
||||
rest += basename+"\n"
|
||||
rest += ("-" * len(basename))+"\n\n"
|
||||
|
||||
rest += "`<https://github.com/PixarAnimationStudios/OpenSubdiv/blob/master/tutorials/"+title+">`_\n"
|
||||
rest += "`<https://github.com/PixarAnimationStudios/OpenSubdiv/blob/release/tutorials/"+title+">`_\n"
|
||||
|
||||
rest += ("\n"
|
||||
"----\n"
|
||||
|
||||
@ -32,7 +32,7 @@ Tutorials
|
||||
----
|
||||
|
||||
The tutorial source code can be found in the `github.com repository
|
||||
<https://github.com/PixarAnimationStudios/OpenSubdiv/tree/master/tutorials>`__
|
||||
<https://github.com/PixarAnimationStudios/OpenSubdiv/tree/release/tutorials>`__
|
||||
or in your local ``<repository root>/tutorials``.
|
||||
|
||||
Far Tutorials
|
||||
|
||||
Loading…
Reference in New Issue
Block a user