8285306: Fix typos in java.desktop #8328

magicus · 2022-04-21T08:35:36Z

I ran codespell on the src/java.desktop directory, and accepted those changes where it indeed discovered real typos.

I ignored typos in public methods and variables. Maybe they can be fixed later on without much fanfare, if they are in internal classes. Typos in exposed APIs are likely here to stay.

I will update copyright years using a script before pushing (otherwise like every second change would be a copyright update, making reviewing much harder).

The long term goal here is to make tooling support for running codespell. The trouble with automating this is of course all false positives. But before even trying to solve that issue, all true positives must be fixed. Hence this PR.

Progress

Change must be properly reviewed (1 review required, with at least 1 Reviewer)
Change must not contain extraneous whitespace
Commit message must refer to an issue

Issue

JDK-8285306: Fix typos in java.desktop

Reviewers

Andrey Turbanov (@turbanoff - Committer) ⚠️ Review applies to 98e635a5
Phil Race (@prrace - Reviewer)
@SWinxy (no known github.com user name / role) ⚠️ Review applies to 2850610d

Contributors

Andrey Turbanov <aturbanov@openjdk.org>

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk pull/8328/head:pull/8328
$ git checkout pull/8328

Update a local copy of the PR:
$ git checkout pull/8328
$ git pull https://git.openjdk.org/jdk pull/8328/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 8328

View PR using the GUI difftool:
$ git pr show -t 8328

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/8328.diff

bridgekeeper · 2022-04-21T08:37:21Z

👋 Welcome back ihse! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2022-04-21T08:39:58Z

@magicus The following labels will be automatically applied to this pull request:

client
i18n

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

mlbridge · 2022-04-21T08:44:14Z

Webrevs

prrace · 2022-04-27T03:38:09Z

 static class AquaHierarchyButtonListener implements HierarchyListener {

   // Everytime a hierarchy is change we need to check if the button if moved on or from

   // Every time a hierarchy is change we need to check if the button if moved on or from

change -> changed
if moved -> is moved

src/java.desktop/macosx/classes/sun/lwawt/macosx/CEmbeddedFrame.java

       // it won't be invoced if focuse is moved to a html element

       // it won't be invoced if focus is moved to a html element

invoced -> invoked
"a html" -> "an html"

src/java.desktop/macosx/native/libjsound/PLATFORM_API_MacOSX_MidiOut.c

// $$fb 2002-04-04: It is responsibility of the application developer to

"is the"

src/java.desktop/windows/native/libjsound/PLATFORM_API_WinOS_MidiOut.c

// $$fb 2002-04-04: It is responsibility of the application developer to

same as above

Regarding changes in gif + freetype
diff --git a/src/java.desktop/share/native/libawt/awt/image/gif/gifdecoder.c b/src/java.desktop/share/native/libawt/awt/image/gif/gifdecoder.c

diff --git a/src/java.desktop/share/native/libfontmanager/freetypeScaler.c b/src/java.desktop/share/native/libfontmanager/freetypeScaler.c

Please exclude ALL 3rd party libraries from this PR.

aivanov-jdk

Nearly 500 files are too many. Smaller chunks would be easier to review.

Some of the native code files could come from upstream libraries.

src/java.desktop/macosx/classes/com/apple/laf/AquaButtonUI.java

src/java.desktop/macosx/classes/sun/lwawt/macosx/CEmbeddedFrame.java

src/java.desktop/macosx/native/libawt_lwawt/awt/AWTWindow.m

src/java.desktop/macosx/native/libawt_lwawt/awt/CTextPipe.m

src/java.desktop/windows/native/libawt/windows/awt_Label.h

src/java.desktop/windows/native/libawt/windows/awt_PrintDialog.cpp

src/java.desktop/windows/native/libawt/windows/awt_PrintJob.cpp

src/java.desktop/windows/native/libawt/windows/awt_Toolkit.cpp

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

…ata.m Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

…aphicsConfig.m Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

…rtexCache.m Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

….cpp Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

…eListener.java Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

magicus · 2022-09-06T14:49:28Z

/contributor add @turbanoff

openjdk · 2022-09-06T14:50:26Z

@magicus
Contributor Andrey Turbanov <aturbanov@openjdk.org> successfully added.

aivanov-jdk

Is src/java.desktop/share/native/libawt/awt/image/gif/gifdecoder.c a third-party code?

aivanov-jdk · 2022-09-13T19:48:47Z

src/java.desktop/macosx/native/libawt_lwawt/java2d/metal/MTLLayer.m

-        J2dTraceLn4(J2D_TRACE_VERBOSE, "MTLLayer.blitTexture: uninitialized (mtlc=%p, javaLayer=%p, buffer=%p, device=%p)", self.ctx, self.javaLayer, self.buffer, ctx.device);
+        J2dTraceLn4(J2D_TRACE_VERBOSE,
+                    "MTLLayer.blitTexture: uninitialized (mtlc=%p, javaLayer=%p, buffer=%p, device=%p)", self.ctx,
+                    self.javaLayer, self.buffer, ctx.device);


Is this an intended change? Or does it come from a merge?

May I suggest wrapping the line after the format string before self.ctx? It would make it easier to read.

This is from the merge. The only difference wrt to current code is "devide" => "device". I can change wrapping if you request it, but I'd prefer to only fix typos.

I'd prefer to only fix typos.

Let us keep only the typos.

magicus · 2022-09-13T21:28:24Z

Is src/java.desktop/share/native/libawt/awt/image/gif/gifdecoder.c a third-party code?

I don't think so. I find no comments in the source code, or any kind of indication on this being so. If you say it is, I can revert the changes in that file.

magicus · 2022-09-13T21:32:44Z

I see now that Phil cryptically said:

Regarding changes in gif + freetype
diff --git a/src/java.desktop/share/native/libawt/awt/image/gif/gifdecoder.c b/src/java.desktop/share/native/libawt/awt/image/gif/gifdecoder.c

diff --git a/src/java.desktop/share/native/libfontmanager/freetypeScaler.c b/src/java.desktop/share/native/libfontmanager/freetypeScaler.c

Please exclude ALL 3rd party libraries from this PR.

That might be interpreted as stating that gifdecoder.c is 3rd party source code (although that was by no means clear to me the first time I read it). I'll revert the changes in that file, and also src/java.desktop/share/native/libfontmanager/freetypeScaler.c.

prrace · 2022-09-13T22:03:44Z

I see now that Phil cryptically said:

Regarding changes in gif + freetype
diff --git a/src/java.desktop/share/native/libawt/awt/image/gif/gifdecoder.c b/src/java.desktop/share/native/libawt/awt/image/gif/gifdecoder.c

diff --git a/src/java.desktop/share/native/libfontmanager/freetypeScaler.c b/src/java.desktop/share/native/libfontmanager/freetypeScaler.c

Please exclude ALL 3rd party libraries from this PR.

That might be interpreted as stating that gifdecoder.c is 3rd party source code (although that was by no means clear to me the first time I read it). I'll revert the changes in that file, and also src/java.desktop/share/native/libfontmanager/freetypeScaler.c.

I don't know why I mentioned those two files like that but those particular two are JDK code so are fair game.

I did write
"Please exclude ALL 3rd party libraries from this PR."
and later :
"We need to revert the native code changes to "libfreetype".
and those points are correct.

You did fix the latter, but there are still some 3rd party files in there that are edited : glext.h, wsutils.h, multiVis.c

magicus · 2022-09-21T11:49:27Z

@prrace I have now reverted the changes to glext.h, wsutils.h and multiVis.c. Is this finally ready for merging?

(Going forward, I think we absolutely need to have some way to document in the code tree that certain files is 3rd party, like the UPSTREAM notation I previously suggested, or some variant thereof. This "tribal knowledge" about what is 3rd party is not beneficial to anyone, and only wastes both your and my time...)

SWinxy · 2022-09-22T01:29:24Z

src/java.desktop/share/classes/javax/swing/plaf/metal/MetalTheme.java

@@ -65,7 +65,7 @@
 */
 public abstract class MetalTheme {

-    // Contants identifying the various Fonts that are Theme can support
+    // Constants identifying the various Fonts that a Theme can support


I think this is possibly meant to say "constants that our theme can support"?

Please submit a new JBS issue for it if you can; if you can't, I can submit one on your behalf.

Possibly it meant to say “the theme”.

I unfortunately don't have a JBS (yet..), so if you could, that would be amazing.

I think the text is correct here: …that a Theme can support

MetalTheme is a superclass for classes which implement Themes. Thus the constants define fonts which a particular theme may use.

Makes sense.

SWinxy · 2022-09-22T01:35:49Z

src/java.desktop/share/classes/sun/awt/SunToolkit.java

@@ -1431,7 +1431,7 @@ public IllegalThreadException() {
    private static final int MINIMAL_DELAY = 5;

    /**
-     * Parameterless version of realsync which uses default timout (see DEFAUL_WAIT_TIME).
+     * Parameterless version of realsync which uses default timeout (see DEFAULT_WAIT_TIME).


Suggested change

* Parameterless version of realsync which uses default timeout (see DEFAULT_WAIT_TIME).

* Parameterless version of realsync which uses the {@link #DEFAULT_WAIT_TIME default timeout}.

I mean this suggestion might not be warranted.

I'm for a clearer message:

Parameterless version of {@code realsSync} which uses the default timeout of {@link #DEFAULT_WAIT_TIME}.

Let us address this in a separate issue.

JDK-8294255: Add link to DEFAULT_WAIT_TIME in javadoc for SunToolKit.realsSync

Feel free to provide a patch.

SWinxy · 2022-09-22T01:52:48Z

Everything looks fine, and you can freely ignore my suggestions. They are just thoughts. And yeah we should probably earmark third party files to avoid "tribal knowledge".

magicus · 2022-09-22T17:25:18Z

/integrate

openjdk · 2022-09-22T17:25:57Z

@magicus This pull request has not yet been marked as ready for integration.

magicus · 2022-10-12T11:01:06Z

@prrace Do you think you can approve this now, so we can finally close it? (I promise I won't open huge PRs like this in the future; lesson well learnt.)

openjdk · 2022-10-18T16:47:23Z

@magicus This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8285306: Fix typos in java.desktop

Co-authored-by: Andrey Turbanov <aturbanov@openjdk.org>
Reviewed-by: aturbanov, prr

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 89 new commits pushed to the master branch:

5dbd495: 8295457: Make the signatures of write barrier methods consistent
7b2e83b: 8295469: S390X: Optimized builds are broken
63867c4: 8295433: EpsilonHeap doesn't need to override post_initialize()
e7375f9: 8295468: RISC-V: Minimal builds are broken
bd41428: 8293590: Some syntax checks performed by URL.openConnection() could be performed earlier, at URL construction
78fed9d: 7175397: The divider color is not changed to green when dragging for Nimbus LaF.
8c40b7d: 8292177: InitialSecurityProperty JFR event
e7a964b: 8295268: Optimized builds are broken due to incorrect assert_is_rfp shortcuts
0b7d811: 8294730: Add @throws and @implNote clauses to BigInteger::isProblablePrime and BigInteger::nextProblablePrime
4434cbb: 8295264: Fix PaX check on RISC-V
... and 79 more: https://git.openjdk.org/jdk/compare/bdb4ed0fb136e9e5391cfa520048de6b7f83067d...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

magicus · 2022-10-18T17:06:11Z

/integrate

openjdk · 2022-10-18T17:08:59Z

Going to push as commit 2a799e5.
Since your change was applied there have been 90 commits pushed to the master branch:

d1f7945: 6924219: (fc spec) FileChannel.write(ByteBuffer, position) behavior when file opened for append not specified
5dbd495: 8295457: Make the signatures of write barrier methods consistent
7b2e83b: 8295469: S390X: Optimized builds are broken
63867c4: 8295433: EpsilonHeap doesn't need to override post_initialize()
e7375f9: 8295468: RISC-V: Minimal builds are broken
bd41428: 8293590: Some syntax checks performed by URL.openConnection() could be performed earlier, at URL construction
78fed9d: 7175397: The divider color is not changed to green when dragging for Nimbus LaF.
8c40b7d: 8292177: InitialSecurityProperty JFR event
e7a964b: 8295268: Optimized builds are broken due to incorrect assert_is_rfp shortcuts
0b7d811: 8294730: Add @throws and @implNote clauses to BigInteger::isProblablePrime and BigInteger::nextProblablePrime
... and 80 more: https://git.openjdk.org/jdk/compare/bdb4ed0fb136e9e5391cfa520048de6b7f83067d...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-10-18T17:09:17Z

@magicus Pushed as commit 2a799e5.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

magicus added 2 commits April 21, 2022 10:15

Pass #1

be44f14

Pass #2

e5c0e79

openjdk bot changed the title ~~8285306~~ 8285306: Fix typos in java.desktop Apr 21, 2022

openjdk bot added the rfr Pull request is ready for review label Apr 21, 2022

openjdk bot added client client-libs-dev@openjdk.org i18n i18n-dev@openjdk.org labels Apr 21, 2022

aivanov-jdk reviewed Apr 28, 2022

View reviewed changes

magicus and others added 19 commits May 13, 2022 18:00

Fix according to review

d62d91e

Update src/java.desktop/macosx/native/libawt_lwawt/awt/AWTWindow.m

096a5b8

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/macosx/native/libawt_lwawt/awt/AWTWindow.m

84f7d2f

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/macosx/native/libawt_lwawt/awt/CTextPipe.m

6742b00

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/macosx/native/libawt_lwawt/awt/QuartzSurfaceD…

4bce48b

…ata.m Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/macosx/native/libawt_lwawt/java2d/metal/MTLGr…

4072eac

…aphicsConfig.m Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/macosx/native/libawt_lwawt/java2d/metal/MTLVe…

fbf591a

…rtexCache.m Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/macosx/native/libawt_lwawt/java2d/metal/MTLVe…

15cf358

…rtexCache.m Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/windows/native/libawt/windows/awt_Label.h

5ca7010

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/windows/native/libawt/windows/awt_PrintDialog…

634c76a

….cpp Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/windows/native/libawt/windows/awt_PrintJob.cpp

06b1e45

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/windows/native/libawt/windows/awt_Toolkit.cpp

6fb0319

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/windows/native/libawt/windows/awt_Toolkit.cpp

fcb1f93

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/share/classes/javax/swing/ActionPropertyChang…

d11ef86

…eListener.java Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/share/classes/javax/swing/DefaultRowSorter.java

27a5d9a

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/share/classes/javax/swing/JCheckBox.java

39c282f

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/share/classes/javax/swing/JLayeredPane.java

7f1f6ad

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/share/classes/javax/swing/JLayeredPane.java

42656f5

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

Update src/java.desktop/share/classes/javax/swing/JMenu.java

cd085eb

Co-authored-by: Alexey Ivanov <70774172+aivanov-jdk@users.noreply.github.com>

aivanov-jdk reviewed Sep 13, 2022

View reviewed changes

magicus added 3 commits September 21, 2022 13:44

Revert changes to multiVis.c and wsutils.h

c023962

Revert changes to glext.h

e9f67a3

Merge branch 'master' into typos-in-java.desktop

2850610

SWinxy reviewed Sep 22, 2022

View reviewed changes

SWinxy approved these changes Sep 26, 2022

View reviewed changes

Merge branch 'master' into typos-in-java.desktop

e2d0979

prrace approved these changes Oct 18, 2022

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Oct 18, 2022

openjdk bot added the integrated Pull request has been integrated label Oct 18, 2022

openjdk bot closed this Oct 18, 2022

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Oct 18, 2022

magicus deleted the typos-in-java.desktop branch October 18, 2022 18:46

aivanov-jdk mentioned this pull request Feb 29, 2024

8286759: TextComponentPrintable: consequent -> consecutive positions #18067

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8285306: Fix typos in java.desktop #8328

8285306: Fix typos in java.desktop #8328

magicus commented Apr 21, 2022 •

edited by openjdk bot

Loading

bridgekeeper bot commented Apr 21, 2022

openjdk bot commented Apr 21, 2022

mlbridge bot commented Apr 21, 2022 •

edited

Loading

prrace commented Apr 27, 2022

aivanov-jdk left a comment

magicus commented Sep 6, 2022

openjdk bot commented Sep 6, 2022

aivanov-jdk left a comment

aivanov-jdk Sep 13, 2022

magicus Sep 13, 2022

aivanov-jdk Sep 14, 2022

magicus commented Sep 13, 2022

magicus commented Sep 13, 2022 •

edited

Loading

prrace commented Sep 13, 2022

magicus commented Sep 21, 2022

SWinxy Sep 22, 2022

aivanov-jdk Sep 22, 2022

SWinxy Sep 22, 2022

aivanov-jdk Sep 22, 2022

SWinxy Sep 26, 2022

SWinxy Sep 22, 2022 •

edited

Loading

aivanov-jdk Sep 22, 2022

aivanov-jdk Sep 22, 2022

SWinxy commented Sep 22, 2022

magicus commented Sep 22, 2022

openjdk bot commented Sep 22, 2022

magicus commented Oct 12, 2022

openjdk bot commented Oct 18, 2022

magicus commented Oct 18, 2022

openjdk bot commented Oct 18, 2022

openjdk bot commented Oct 18, 2022

	* Parameterless version of realsync which uses default timeout (see DEFAULT_WAIT_TIME).
	* Parameterless version of realsync which uses the {@link #DEFAULT_WAIT_TIME default timeout}.

8285306: Fix typos in java.desktop #8328

8285306: Fix typos in java.desktop #8328

Conversation

magicus commented Apr 21, 2022 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Contributors

Reviewing

bridgekeeper bot commented Apr 21, 2022

openjdk bot commented Apr 21, 2022

mlbridge bot commented Apr 21, 2022 • edited Loading

Webrevs

prrace commented Apr 27, 2022

aivanov-jdk left a comment

Choose a reason for hiding this comment

magicus commented Sep 6, 2022

openjdk bot commented Sep 6, 2022

aivanov-jdk left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

magicus commented Sep 13, 2022

magicus commented Sep 13, 2022 • edited Loading

prrace commented Sep 13, 2022

magicus commented Sep 21, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SWinxy Sep 22, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SWinxy commented Sep 22, 2022

magicus commented Sep 22, 2022

openjdk bot commented Sep 22, 2022

magicus commented Oct 12, 2022

openjdk bot commented Oct 18, 2022

magicus commented Oct 18, 2022

openjdk bot commented Oct 18, 2022

openjdk bot commented Oct 18, 2022

magicus commented Apr 21, 2022 •

edited by openjdk bot

Loading

mlbridge bot commented Apr 21, 2022 •

edited

Loading

magicus commented Sep 13, 2022 •

edited

Loading

SWinxy Sep 22, 2022 •

edited

Loading