Skip to content

Commit bd6f74c

Browse files
authored
Change references to "master" branch to "main" (#236)
Signed-off-by: Cary Phillips <[email protected]>
1 parent 4013019 commit bd6f74c

File tree

6 files changed

+21
-24
lines changed

6 files changed

+21
-24
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ Imath is a sub-project of
1515
follows OpenEXR's governance and contribution policies.
1616

1717
For a description of the roles and responsibilities of the various
18-
members of the OpeneEXR community, see [GOVERNANCE.md](https://github.com/AcademySoftwareFoundation/openexr/blob/master/GOVERNANCE.md),
18+
members of the OpeneEXR community, see [GOVERNANCE.md](https://github.com/AcademySoftwareFoundation/openexr/blob/main/GOVERNANCE.md),
1919
and for further details, see the OpenEXR project's [Technical
20-
Charter](https://github.com/AcademySoftwareFoundation/openexr/blob/master/ASWF/charter/OpenEXR-Technical-Charter.md).
20+
Charter](https://github.com/AcademySoftwareFoundation/openexr/blob/main/ASWF/charter/OpenEXR-Technical-Charter.md).
2121
Briefly, a "contributor" is anyone who submits content to the project,
2222
a "committer" is someone who reviews and approves such submissions,
2323
and the Technical Steering Committee provides general project
@@ -74,7 +74,7 @@ refer to [SECURITY.md](SECURITY.md) to responsibly disclose it.
7474
### How to Contribute a Bug Fix or Change
7575

7676
To contribute code to the project, first read over the
77-
[GOVERNANCE.md](https://github.com/AcademySoftwareFoundation/openexr/blob/master/GOVERNANCE.md)
77+
[GOVERNANCE.md](https://github.com/AcademySoftwareFoundation/openexr/blob/main/GOVERNANCE.md)
7878
page to understand the roles involved. You'll need:
7979

8080
* A good knowledge of git.
@@ -109,24 +109,24 @@ can be merged.
109109

110110
* If you are an individual writing the code on your own time and
111111
you're SURE you are the sole owner of any intellectual property you
112-
contribute, you can [sign the CLA as an individual contributor](https://github.com/communitybridge/easycla/blob/master/contributors/sign-a-cla-as-an-individual-contributor-to-github.md).
112+
contribute, you can [sign the CLA as an individual contributor](https://github.com/communitybridge/easycla/blob/main/contributors/sign-a-cla-as-an-individual-contributor-to-github.md).
113113

114114
* If you are writing the code as part of your job, or if there is any
115115
possibility that your employers might think they own any
116116
intellectual property you create, then you should use the [Corporate
117117
Contributor Licence
118-
Agreement](https://github.com/communitybridge/easycla/blob/master/contributors/contribute-to-a-github-company-project.md).
118+
Agreement](https://github.com/communitybridge/easycla/blob/main/contributors/contribute-to-a-github-company-project.md).
119119

120120
The Imath CLAs are the standard forms used by Linux Foundation
121-
projects and [recommended by the ASWF TAC](https://github.com/AcademySoftwareFoundation/tac/blob/master/process/contributing.md#contributor-license-agreement-cla).
121+
projects and [recommended by the ASWF TAC](https://github.com/AcademySoftwareFoundation/tac/blob/main/process/contributing.md#contributor-license-agreement-cla).
122122

123123
### Commit Sign-Off
124124

125125
Every commit must be signed off. That is, every commit log message
126126
must include a “`Signed-off-by`” line (generated, for example, with
127127
`git commit --signoff`”), indicating that the committer wrote the
128128
code and has the right to release it under the [BSD-3-Clause](LICENSE.md)
129-
license. See https://github.com/AcademySoftwareFoundation/tac/blob/master/process/contributing.md#contribution-sign-off for more information on this requirement.
129+
license. See https://github.com/AcademySoftwareFoundation/tac/blob/main/process/contributing.md#contribution-sign-off for more information on this requirement.
130130

131131
## Development Workflow
132132

@@ -149,21 +149,21 @@ Documentation](https://git-scm.com/doc).
149149

150150
The Imath repository uses a simple branching and merging strategy.
151151

152-
All development work is done directly on the master branch. The master
152+
All development work is done directly on the ``main`` branch. The ``main``
153153
branch represents the bleeding-edge of the project and most
154154
contributions should be done on top of it.
155155

156-
After sufficient work is done on the master branch and the Imath
156+
After sufficient work is done on the ``main`` branch and the Imath
157157
leadership determines that a release is due, we will bump the relevant
158158
internal versioning and tag a commit with the corresponding version
159159
number, e.g. v2.0.1. Each minor version also has its own “Release
160160
Branch”, e.g. RB-1.1. This marks a branch of code dedicated to that
161161
``major.minor version``, which allows upstream bug fixes to be
162-
cherry-picked to a given version while still allowing the master
162+
cherry-picked to a given version while still allowing the ``main``
163163
branch to continue forward onto higher versions. This basic repository
164164
structure keeps maintenance low, while remaining simple to understand.
165165

166-
To reiterate, the master branch represents the latest development
166+
To reiterate, the ``main`` branch represents the latest development
167167
version, so beware that it may include untested features and is not
168168
generally stable enough for release. To retrieve a stable version of
169169
the source code, use one of the release branches.
@@ -224,7 +224,7 @@ the work.
224224

225225
6. Upon receiving the required number of committer approvals (as
226226
outlined in [Required Approvals](#required-approvals)), a committer
227-
other than the PR contributor may merge changes into the master
227+
other than the PR contributor may merge changes into the ``main``
228228
branch.
229229

230230
### Code Review and Required Approvals
@@ -307,7 +307,7 @@ pull request.
307307

308308
Code formattting is controlled by ``clang-format``, with the style
309309
specified via the project
310-
[.clang-format](https://github.com/AcademySoftwareFoundation/Imath/blob/master/.clang-format)
310+
[.clang-format](https://github.com/AcademySoftwareFoundation/Imath/blob/main/.clang-format)
311311
file.
312312

313313
* Indent with spaces, never tabs. Each indent level should be 4 spaces.

INSTALL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To build from the latest development version, clone the GitHub repo directly via
1010

1111
% git clone https://github.com/AcademySoftwareFoundation/Imath.git
1212

13-
The ``master`` branch is the most recent development version, which
13+
The ``main`` branch is the most recent development version, which
1414
may be unstable, but the ``release`` branch always points to the most
1515
recent and most modern, stable, released version.
1616

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ project.
7878
Imath continues to be maintained as a sub-project of OpenEXR, which is
7979
now a project of the [Academy Software
8080
Foundation](https://www.aswf.io). See
81-
the OpenEXR project's [GOVERNANCE.md](https://github.com/AcademySoftwareFoundation/openexr/blob/master/GOVERNANCE.md)
81+
the OpenEXR project's [GOVERNANCE.md](https://github.com/AcademySoftwareFoundation/openexr/blob/main/GOVERNANCE.md)
8282
for more information about how the project operates.
8383

8484
The OpenEXR project is dedicated to promoting a harassment-free
@@ -94,7 +94,7 @@ from source.
9494

9595
If you encounter problems compiling code or building projects written
9696
with an earlier release of Imath, the [porting
97-
guide](https://github.com/AcademySoftwareFoundation/Imath/blob/master/docs/PortingGuide2-3.md)
97+
guide](https://github.com/AcademySoftwareFoundation/Imath/blob/main/docs/PortingGuide2-3.md)
9898
explains some of the differences and how to address them.
9999

100100
### A Note about Versioning
@@ -133,4 +133,4 @@ Imath is released under OpenEXR's [BSD-3-Clause](LICENSE.md) license.
133133

134134
---
135135

136-
![aswf](https://github.com/AcademySoftwareFoundation/openexr/blob/master/ASWF/images/aswf.png)
136+
![aswf](https://github.com/AcademySoftwareFoundation/openexr/blob/main/ASWF/images/aswf.png)

docs/PortingGuide2-3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ To reduce library size and make linkage behavior similar across
281281
platforms, Imath and OpenEXR now build with directives that make
282282
symbol visibility hidden by default, with specific externally-visible
283283
symbols explicitly marked for export. See the [Symbol
284-
Visibility](https://github.com/AcademySoftwareFoundation/openexr/blob/master/docs/SymbolVisibility.md)
284+
Visibility](https://github.com/AcademySoftwareFoundation/openexr/blob/main/docs/SymbolVisibility.md)
285285
doc and the appropriate ``*Export.h`` header file for more details.
286286

287287
## Imath Now Uses Standard C++ Exceptions and `noexcept`

docs/conf.py

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,6 @@
6868
# The encoding of source files.
6969
#source_encoding = 'utf-8-sig'
7070

71-
# The master toctree document.
72-
master_doc = 'index'
73-
7471
# General information about the project.
7572
project = 'Imath'
7673
copyright = '2021, Contributors to the OpenEXR Project'

docs/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ objects, functions, and data types common in computer graphics
77
applications, including the ``half`` 16-bit floating-point type.
88

99
- Download: https://github.com/AcademySoftwareFoundation/Imath
10-
- Install Help: `INSTALL.md <https://github.com/AcademySoftwareFoundation/Imath/blob/master/INSTALL>`_
11-
- Porting Help: `Imath/OpenEXR Version 2->3 Porting Guide <https://github.com/AcademySoftwareFoundation/Imath/blob/master/docs/PortingGuide2-3.md>`_
12-
- License: `BSD License <https://github.com/AcademySoftwareFoundation/Imath/blob/master/LICENSE.md>`_
10+
- Install Help: `INSTALL.md <https://github.com/AcademySoftwareFoundation/Imath/blob/main/INSTALL>`_
11+
- Porting Help: `Imath/OpenEXR Version 2->3 Porting Guide <https://github.com/AcademySoftwareFoundation/Imath/blob/main/docs/PortingGuide2-3.md>`_
12+
- License: `BSD License <https://github.com/AcademySoftwareFoundation/Imath/blob/main/LICENSE.md>`_
1313

1414
Introduction
1515
############

0 commit comments

Comments
 (0)