Skip to content

Commit 66158f8

Browse files
authored
Fix typos (#1954)
Signed-off-by: Dimitris Apostolou <[email protected]>
1 parent 8bc3fae commit 66158f8

24 files changed

+184
-187
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ remains linear, avoiding the "bubbles" characteristic of the
192192
[GitFlow](https://www.endoflineblog.com/gitflow-considered-harmful)
193193
workflow.
194194

195-
### Use the Fork, Luke.
195+
### Use the Fork, Luke
196196

197197
In a typical workflow, you should **fork** the OpenEXR repository to
198198
your account. This creates a copy of the repository under your user
@@ -214,7 +214,7 @@ [email protected] mail list.
214214

215215
Contributions should be submitted as GitHub pull requests. See
216216
[Creating a pull request](https://help.github.com/articles/creating-a-pull-request/)
217-
if you're unfamiliar with this concept.
217+
if you're unfamiliar with this concept.
218218

219219
The development cycle for a code change should follow this protocol:
220220

@@ -336,7 +336,7 @@ code.
336336

337337
* Function return types go on a separate line:
338338

339-
const float &
339+
const float &
340340
Header::pixelAspectRatio () const
341341
{
342342
...
@@ -452,7 +452,7 @@ each version with three numbers: ``major.minor.patch``, where:
452452

453453
* ``major`` - indicates incompatible API changes
454454
* ``minor`` - indicates functionality added in a backwards-compatible manner
455-
* ``patch`` - indicates backwards-compatible bug fixes
455+
* ``patch`` - indicates backwards-compatible bug fixes
456456

457457
## Contributing to the Website
458458

@@ -474,7 +474,7 @@ Building the website requires that ``sphinx``, ``breathe``, and
474474
``doxygen`` are installed. It further requires the [sphinx-press-theme]
475475
(https://pypi.org/project/sphinx-press-theme). Complete dependencies
476476
are described in the [requirements.txt](website/requirements.txtg)
477-
file.
477+
file.
478478

479479
On Debian/Ubuntu Linux:
480480

@@ -498,7 +498,7 @@ browser to preview the resulting website, that is, load
498498
``file://<build-directory>/website/sphinx/index.html`` into your web
499499
browser.
500500

501-
Once you submit a PR, a check labled ``docs/readthedocs.org:openexr``
501+
Once you submit a PR, a check labeled ``docs/readthedocs.org:openexr``
502502
will validate the build. Click on the ``Details`` link to
503503
preview. Also, a link to this preview will be added automatically to
504504
the PR description.
@@ -550,11 +550,11 @@ The preferred workflow is:
550550

551551
c. Increment ``OPENEXR_VERSION_PATCH`` in
552552
[src/lib/OpenEXRCore/openexr_version.h](src/lib/OpenEXRCore/openexr_version.h)
553-
553+
554554
d. Update the ``IMATH_TAG`` setting in
555555
[cmake/OpenEXRSetup.cmake](cmake/OpenEXRSetup.cmake) to
556556
correspond to the proper Imath release.
557-
557+
558558
e. Add release notes to [CHANGES.md](CHANGES.md):
559559

560560
- Generate a list of links to merged pull requests.
@@ -589,16 +589,16 @@ The preferred workflow is:
589589

590590
- If there are any public CVE's, mention them explicitly with a
591591
link to the CVE registry item.
592-
592+
593593
- Provide an executive summary of the patch changes, in a few
594594
sentences as well as bullet points if appropriate.
595595

596596
- Choose a proposed release date at least several days in
597597
advance.
598-
598+
599599
f. If there are any public CVE's, reference them in
600600
[SECURITY.md](SECURITY.md).
601-
601+
602602
g. Submit the PR for others to review. The PR should go *to the
603603
release branch, not ``main``*, obviously.
604604

@@ -611,9 +611,9 @@ The preferred workflow is:
611611
i. If further fixes come in that need to go into the release, push
612612
them to the PR branch. It's not absolutely essential that all
613613
changes to the release branch go in via a PR. The PR is simply a
614-
convient forum for publicly discussing and reviewing the
614+
convenient forum for publicly discussing and reviewing the
615615
composition of the release.
616-
616+
617617
2. Tag the release with a ``-rc`` "release candidate" tag,
618618
e.g. ``v3.1.9-rc``.
619619

@@ -636,7 +636,7 @@ The preferred workflow is:
636636

637637
Create the release from the latest ``--rc`` tag, and give it a name
638638
that begins with ``v``, i.e. ``v3.1.9``.
639-
639+
640640
Save the release as a "draft".
641641

642642
6. Wait at least 48 hours, to give the community time to discover and
@@ -666,16 +666,16 @@ The preferred workflow is:
666666
with your GitHub account and git config.
667667

668668
b. Create a signed tag with the release name via `git tag -s v3.1.9`.
669-
669+
670670
c. Push the tag via `git push --tags`
671-
671+
672672
8. Publish the release
673673

674674
a. Click the "Publish release" button on the GitHub release draft
675675

676676
b. Send an email to ``[email protected]`` officially
677-
annoucing the release.
678-
677+
announcing the release.
678+
679679
9. Update the ``release`` branch, which should always point to the
680680
most recent patch of the most recent minor release, i.e. the most
681681
preferred release.
@@ -694,7 +694,7 @@ The preferred workflow is:
694694
the associated commit as well.
695695

696696
- Also include in this PR edits to [``docs/news.rst``](docs/news.rst)
697-
that add an announcment of the release.
697+
that add an announcement of the release.
698698

699699
11. After review/merge of the updates to ``docs/news.rst``, build the
700700
website at https://readthedocs.org/projects/openexr.
@@ -740,15 +740,15 @@ To create a new release from the ``main`` branch:
740740

741741
- If there are any public CVE's, mention them explicitly with a
742742
link to the CVE registry item.
743-
743+
744744
- Submit this change as a separate PR.
745745

746746
3. Add a mention of the release to [``docs/news.rst``](docs/news.rst)
747747

748748
- Submit this change as a separate PR.
749749

750750
4. Increment the ``OPENEXR_LIB_SOVERSION`` setting in [CMakeLists.txt](CMakeLists.txt).
751-
751+
752752
- The SO version increases whenever, and only when, the ABI changes
753753
in non-backwards-compatible ways. Consistent with the semantic
754754
versioning policy, this usually happens at major and minor
@@ -770,7 +770,7 @@ To create a new release from the ``main`` branch:
770770
of the release with link to the release candidate tag. Include the
771771
release notes from [CHANGES.md](CHANGES.md) for review.
772772

773-
9. If additonal fixes need to go in before release:
773+
9. If additional fixes need to go in before release:
774774

775775
a. Merge commits to the release branch. Push them directly, no need
776776
for a pull request.
@@ -790,7 +790,7 @@ To create a new release from the ``main`` branch:
790790

791791
- Create the release from the latest ``--rc`` tag, and give it a name
792792
that begins with ``v`` and ends in ``0``, e.g. ``v3.2.0``.
793-
793+
794794
- Save the release as a "draft".
795795

796796
11. Wait at least 48 hours after the email announcement.
@@ -800,8 +800,8 @@ To create a new release from the ``main`` branch:
800800
a. Click the "Publish release" button on the GitHub release draft
801801

802802
b. Send an email to ``[email protected]`` officially
803-
annoucing the release.
804-
803+
announcing the release.
804+
805805
13. Update the ``release`` branch, which should always point to the
806806
most recent release.
807807

SECURITY.md

Lines changed: 17 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,27 @@ These vulnerabilities are present in the given versions:
2222

2323
* [CVE-2023-5841](https://nvd.nist.gov/vuln/detail/CVE-2023-5841) 3.1.0, 3.1.1, 3.1.2, 3.1.3 3.1.4 3.1.5 3.1.6 3.1.7 3.1.8 3.1.9 3.1.10 3.1.11 3.2.0 3.2.1
2424
* [CVE-2021-45942](https://nvd.nist.gov/vuln/detail/CVE-2021-45942) 3.1.0, 3.1.1, 3.1.2, 3.1.3
25-
* [CVE-2021-20296](https://nvd.nist.gov/vuln/detail/CVE-2021-20296) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
26-
* [CVE-2021-3479](https://nvd.nist.gov/vuln/detail/CVE-2021-3479) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
27-
* [CVE-2021-3478](https://nvd.nist.gov/vuln/detail/CVE-2021-3478) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
28-
* [CVE-2021-3477](https://nvd.nist.gov/vuln/detail/CVE-2021-3477) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
29-
* [CVE-2021-3476](https://nvd.nist.gov/vuln/detail/CVE-2021-3476) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
30-
* [CVE-2021-3475](https://nvd.nist.gov/vuln/detail/CVE-2021-3475) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
31-
* [CVE-2021-3474](https://nvd.nist.gov/vuln/detail/CVE-2021-3474) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
25+
* [CVE-2021-20296](https://nvd.nist.gov/vuln/detail/CVE-2021-20296) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
26+
* [CVE-2021-3479](https://nvd.nist.gov/vuln/detail/CVE-2021-3479) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
27+
* [CVE-2021-3478](https://nvd.nist.gov/vuln/detail/CVE-2021-3478) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
28+
* [CVE-2021-3477](https://nvd.nist.gov/vuln/detail/CVE-2021-3477) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
29+
* [CVE-2021-3476](https://nvd.nist.gov/vuln/detail/CVE-2021-3476) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
30+
* [CVE-2021-3475](https://nvd.nist.gov/vuln/detail/CVE-2021-3475) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
31+
* [CVE-2021-3474](https://nvd.nist.gov/vuln/detail/CVE-2021-3474) 2.4.0, 2.4.1, 2.4.2, 2.5.0, 2.5.1, 2.5.2, 2.5.3
3232
* [CVE-2020-16589](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-16589) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0
3333
* [CVE-2020-16588](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-16588) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0
3434
* [CVE-2020-16587](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-16587) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0
3535
* [CVE-2020-15306](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-15306) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0, 2.4.1, 2.5.0, 2.5.1
3636
* [CVE-2020-15305](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-15305) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0, 2.4.1, 2.5.0, 2.5.1
3737
* [CVE-2020-15304](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-15304) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0, 2.4.1, 2.5.0, 2.5.1
38-
* [CVE-2020-11765](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11765) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
39-
* [CVE-2020-11764](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11764) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
40-
* [CVE-2020-11763](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11763) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
41-
* [CVE-2020-11762](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11762) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
42-
* [CVE-2020-11761](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11761) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
43-
* [CVE-2020-11760](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11760) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
44-
* [CVE-2020-11759](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11759) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
45-
* [CVE-2020-11758](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11758) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
38+
* [CVE-2020-11765](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11765) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
39+
* [CVE-2020-11764](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11764) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
40+
* [CVE-2020-11763](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11763) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
41+
* [CVE-2020-11762](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11762) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
42+
* [CVE-2020-11761](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11761) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
43+
* [CVE-2020-11760](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11760) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
44+
* [CVE-2020-11759](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11759) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
45+
* [CVE-2020-11758](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-11758) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0, 2.4.0
4646
* [CVE-2018-18444](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-18444) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0
4747
* [CVE-2018-18443](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2018-18443) 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.3.0
4848
* [CVE-2017-9116](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-9116) 2.0.0, 2.0.1, 2.1.0, 2.2.0
@@ -108,7 +108,7 @@ To verify a downloaded release at a given tag:
108108
The website implements no interactive features and requires no login
109109
credentials.
110110

111-
- The library reads and writes only to file paths specificly requested
111+
- The library reads and writes only to file paths specifically requested
112112
via the C/C++ API. The runtime library uses no system configuration
113113
files or sidecar data files. Access to data files uses only standard
114114
file I/O system calls.
@@ -140,7 +140,7 @@ to scan for dependency vulnerability.
140140
Potential entry points are images being loaded using the
141141
library. Malformed images could caused issues such as heap buffer
142142
overflows, out-of-memory faults, or segmentation faults that could be
143-
exploitable as denial-of-service attacks.
143+
exploitable as denial-of-service attacks.
144144

145145
### Hardening
146146

@@ -172,6 +172,3 @@ changes are reviewed by multiple TSC members.
172172

173173
The library is distributed in binary form via many common package
174174
managers across all platforms.
175-
176-
177-

src/examples/deepExamples.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ readDeepScanlineFile (
4747
// - allocate memory for the pixels
4848
// - describe the layout of the A, and Z pixel buffers
4949
// - read the sample counts from the file
50-
// - allocate the memory requred to store the samples
50+
// - allocate the memory required to store the samples
5151
// - read the pixels from the file
5252
//
5353

src/examples/deepTiledExamples.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ readDeepTiledFile (
5454
// - allocate memory for the pixels
5555
// - describe the layout of the A, and Z pixel buffers
5656
// - read the sample counts from the file
57-
// - allocate the memory requred to store the samples
57+
// - allocate the memory required to store the samples
5858
// - read the pixels from the file
5959
//
6060

src/examples/multipartExamples.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ combineFiles ()
9494
//
9595
// Read multiple single-part input files and write them as a multi-part file.
9696
// If an input file is multi-part, only one part is copied.
97-
// All input files dimentions must be the same.
97+
// All input files dimensions must be the same.
9898
//
9999

100100
std::vector<MultiPartInputFile*> inputFiles;

src/lib/OpenEXR/ImfChromaticities.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
//-----------------------------------------------------------------------------
77
//
88
// CIE (x,y) chromaticities, and conversions between
9-
// RGB tiples and CIE XYZ tristimulus values.
9+
// RGB triples and CIE XYZ tristimulus values.
1010
//
1111
//-----------------------------------------------------------------------------
1212

src/lib/OpenEXR/ImfChromaticities.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
//-----------------------------------------------------------------------------
1010
//
1111
// CIE (x,y) chromaticities, and conversions between
12-
// RGB tiples and CIE XYZ tristimulus values.
12+
// RGB triples and CIE XYZ tristimulus values.
1313
//
1414
//-----------------------------------------------------------------------------
1515

src/lib/OpenEXR/ImfInputFile.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ class IMF_EXPORT_TYPE InputFile
212212
// in a threadsafe manner (where the only way that was possible
213213
// before was to have a larger framebuffer, set the framebuffer
214214
// once, then call readPixels by the external threads, although
215-
// that occured with a mutex and so the reads were serialized.
215+
// that occurred with a mutex and so the reads were serialized.
216216
// There are reasons why that might still be serialized, such as a
217217
// non-threadable stream.
218218
//----------------------------------------------

src/lib/OpenEXR/ImfRgbaYca.h

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
// YCA YCA YCA YCA ... YCA YCA
4848
// YCA YCA YCA YCA ... YCA YCA
4949
//
50-
// Next, decimateChomaHoriz() eliminates the chroma values from
50+
// Next, decimateChromaHoriz() eliminates the chroma values from
5151
// the odd-numbered pixels in every scan line:
5252
//
5353
// YCA YA YCA YA ... YCA YA
@@ -152,7 +152,7 @@ void decimateChromaVert (int n, const Rgba* const ycaIn[N], Rgba ycaOut[/*n*/]);
152152
//
153153
// Round the luminance and chroma channels of an array of YCA
154154
// pixels that has already been filtered and subsampled.
155-
// The signifcands of the pixels' luminance and chroma values
155+
// The significands of the pixels' luminance and chroma values
156156
// are rounded to roundY and roundC bits respectively.
157157
//
158158

@@ -175,7 +175,7 @@ reconstructChromaHoriz (int n, const Rgba ycaIn[/*n+N-1*/], Rgba ycaOut[/*n*/]);
175175

176176
//
177177
// For a scan line that has only luminance and no valid chroma data,
178-
// reconstruct chroma from the surronding N scan lines.
178+
// reconstruct chroma from the surrounding N scan lines.
179179
//
180180

181181
IMF_EXPORT

src/lib/OpenEXRCore/internal_dwa_encoder.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -860,7 +860,7 @@ static uint16_t algoQuantize (
860860
//
861861
// 99.99% of the time, the mask or round will be a good choice,
862862
// but only in a few combinations of tolerance will the truncation
863-
// be needed because the mask trunction will be out of range,
863+
// be needed because the mask truncation will be out of range,
864864
// which is not surprising given we're just shifting the
865865
// significand of the half-float tolerance, where the tolerance is
866866
// against the original 32-bit value, but can be quickly tested

0 commit comments

Comments
 (0)