[Bug][JDK10] Fix duplicated "the" occurrences in docs and inline comments
Hey, Just noticed an occurrence of a duplicated "the" in a Locale doc and looked for other occurrences in java.base while being on it. I don't know if documentation changes follow a special workflow because of possible translations. Please let me know! But I'd be happy if this is sponsored or moved to the appropriate mailing list. Cheers, Christoph ===== PATCH ====== diff -r 359c604930af src/java.base/share/classes/java/lang/WeakPairMap.java --- a/src/java.base/share/classes/java/lang/WeakPairMap.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/java/lang/WeakPairMap.java Sun Oct 29 16:13:11 2017 +0100 @@ -88,7 +88,7 @@ * Maps the specified key pair to the specified value in this WeakPairMap. * Neither the keys nor the value can be null. * <p>The value can be retrieved by calling the {@link #get} method - * with the the same keys (compared by identity). + * with the same keys (compared by identity). * * @param k1 the 1st of the pair of keys with which the specified value is to * be associated diff -r 359c604930af src/java.base/share/classes/java/lang/invoke/MethodHandleImpl.java --- a/src/java.base/share/classes/java/lang/invoke/MethodHandleImpl.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/java/lang/invoke/MethodHandleImpl.java Sun Oct 29 16:13:11 2017 +0100 @@ -1196,7 +1196,7 @@ static MethodHandle bindCaller(MethodHandle mh, Class<?> hostClass) { - // Code in the the boot layer should now be careful while creating method handles or + // Code in the boot layer should now be careful while creating method handles or // functional interface instances created from method references to @CallerSensitive methods, // it needs to be ensured the handles or interface instances are kept safe and are not passed // from the boot layer to untrusted code. diff -r 359c604930af src/java.base/share/classes/java/lang/invoke/StringConcatFactory.java --- a/src/java.base/share/classes/java/lang/invoke/StringConcatFactory.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/java/lang/invoke/StringConcatFactory.java Sun Oct 29 16:13:11 2017 +0100 @@ -195,7 +195,7 @@ // In case we need to double-back onto the StringConcatFactory during this // static initialization, make sure we have the reasonable defaults to complete // the static initialization properly. After that, actual users would use the - // the proper values we have read from the the properties. + // the proper values we have read from the properties. STRATEGY = DEFAULT_STRATEGY; // CACHE_ENABLE = false; // implied // CACHE = null; // implied diff -r 359c604930af src/java.base/share/classes/java/util/Locale.java --- a/src/java.base/share/classes/java/util/Locale.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/java/util/Locale.java Sun Oct 29 16:13:11 2017 +0100 @@ -1909,7 +1909,7 @@ * Returns a name for the locale that is appropriate for display to the * user. This will be the values returned by getDisplayLanguage(), * getDisplayScript(), getDisplayCountry(), and getDisplayVariant() assembled - * into a single string. The the non-empty values are used in order, + * into a single string. The non-empty values are used in order, * with the second and subsequent names in parentheses. For example: * <blockquote> * language (script, country, variant)<br> diff -r 359c604930af src/java.base/share/classes/java/util/ServiceLoader.java --- a/src/java.base/share/classes/java/util/ServiceLoader.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/java/util/ServiceLoader.java Sun Oct 29 16:13:11 2017 +0100 @@ -1409,7 +1409,7 @@ * * <p> To achieve laziness the actual work of locating providers is done * when processing the stream. If a service provider cannot be loaded for any - * of the the reasons specified in the <a href="#errors">Errors</a> section + * of the reasons specified in the <a href="#errors">Errors</a> section * above then {@link ServiceConfigurationError} is thrown by whatever method * caused the service provider to be loaded. </p> * diff -r 359c604930af src/java.base/share/classes/jdk/internal/module/ModuleBootstrap.java --- a/src/java.base/share/classes/jdk/internal/module/ModuleBootstrap.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/jdk/internal/module/ModuleBootstrap.java Sun Oct 29 16:13:11 2017 +0100 @@ -66,7 +66,7 @@ * -m and --add-modules options. The modules are located on a module path that * is constructed from the upgrade module path, system modules, and application * module path. The Configuration is instantiated as the boot layer with each - * module in the the configuration defined to a class loader. + * module in the configuration defined to a class loader. */ public final class ModuleBootstrap { diff -r 359c604930af src/java.base/share/classes/jdk/internal/module/ModuleHashesBuilder.java --- a/src/java.base/share/classes/jdk/internal/module/ModuleHashesBuilder.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/jdk/internal/module/ModuleHashesBuilder.java Sun Oct 29 16:13:11 2017 +0100 @@ -74,7 +74,7 @@ * the outgoing edges from M to non-candidate modules. */ public Map<String, ModuleHashes> computeHashes(Set<String> roots) { - // build a graph containing the the packaged modules and + // build a graph containing the packaged modules and // its transitive dependences matching --hash-modules Graph.Builder<String> builder = new Graph.Builder<>(); Deque<ResolvedModule> deque = new ArrayDeque<>(configuration.modules()); diff -r 359c604930af src/java.base/share/classes/jdk/internal/module/Resources.java --- a/src/java.base/share/classes/jdk/internal/module/Resources.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/jdk/internal/module/Resources.java Sun Oct 29 16:13:11 2017 +0100 @@ -56,7 +56,7 @@ /** * Derive a <em>package name</em> for a resource. The package name * returned by this method may not be a legal package name. This method - * returns null if the the resource name ends with a "/" (a directory) + * returns null if the resource name ends with a "/" (a directory) * or the resource name does not contain a "/". */ public static String toPackageName(String name) { diff -r 359c604930af src/java.base/share/classes/jdk/internal/org/objectweb/asm/Frame.java --- a/src/java.base/share/classes/jdk/internal/org/objectweb/asm/Frame.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/jdk/internal/org/objectweb/asm/Frame.java Sun Oct 29 16:13:11 2017 +0100 @@ -192,7 +192,7 @@ private static final int LOCAL = 0x2000000; /** - * Kind of the the types that are relative to the stack of an input stack + * Kind of the types that are relative to the stack of an input stack * map frame. The value of such types is a position relatively to the top of * this stack. */ diff -r 359c604930af src/java.base/share/classes/sun/security/provider/certpath/ResponderId.java --- a/src/java.base/share/classes/sun/security/provider/certpath/ResponderId.jav a Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/security/provider/certpath/ResponderId.jav a Sun Oct 29 16:13:11 2017 +0100 @@ -119,7 +119,7 @@ * When encoded in DER this object will use the byKey option, a * SHA-1 hash of the responder's public key. * - * @param pubKey the the OCSP responder's public key + * @param pubKey the OCSP responder's public key * * @throws IOException if the internal DER-encoding of the * {@code KeyIdentifier} fails. diff -r 359c604930af src/java.base/share/classes/sun/security/provider/certpath/SunCertPathBuilde rException.java --- a/src/java.base/share/classes/sun/security/provider/certpath/SunCertPathBuil derException.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/security/provider/certpath/SunCertPathBuil derException.java Sun Oct 29 16:13:11 2017 +0100 @@ -94,7 +94,7 @@ } /** - * Creates a <code>SunCertPathBuilderException</code> withe the specified + * Creates a <code>SunCertPathBuilderException</code> with the specified * detail message and adjacency list. * * @param msg the detail message diff -r 359c604930af src/java.base/share/classes/sun/security/ssl/CertStatusReqItemV2.java --- a/src/java.base/share/classes/sun/security/ssl/CertStatusReqItemV2.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/security/ssl/CertStatusReqItemV2.java Sun Oct 29 16:13:11 2017 +0100 @@ -145,7 +145,7 @@ * @return the encoded length of this {@code CertStatusReqItemV2} */ int length() { - // The length is the the status type (1 byte) + the request length + // The length is the status type (1 byte) + the request length // field (2 bytes) + the StatusRequest data length. return request.length() + 3; } diff -r 359c604930af src/java.base/share/classes/sun/security/ssl/MAC.java --- a/src/java.base/share/classes/sun/security/ssl/MAC.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/security/ssl/MAC.java Sun Oct 29 16:13:11 2017 +0100 @@ -188,7 +188,7 @@ * @param type record type * @param bb a ByteBuffer in which the position and limit * demarcate the data to be MAC'd. - * @param isSimulated if true, simulate the the MAC computation + * @param isSimulated if true, simulate the MAC computation * * @return the MAC result */ diff -r 359c604930af src/java.base/share/classes/sun/security/ssl/TrustStoreManager.java --- a/src/java.base/share/classes/sun/security/ssl/TrustStoreManager.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/security/ssl/TrustStoreManager.java Sun Oct 29 16:13:11 2017 +0100 @@ -333,7 +333,7 @@ } /** - * Load the the KeyStore as described in the specified descriptor. + * Load the KeyStore as described in the specified descriptor. */ private static KeyStore loadKeyStore( TrustStoreDescriptor descriptor) throws Exception { diff -r 359c604930af src/java.base/share/classes/sun/text/normalizer/Trie2.java --- a/src/java.base/share/classes/sun/text/normalizer/Trie2.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/text/normalizer/Trie2.java Sun Oct 29 16:13:11 2017 +0100 @@ -592,7 +592,7 @@ // may be lower when iterating over the code points for a single lead surrogate. private int limitCP; - // True while iterating over the the Trie2 values for code points. + // True while iterating over the Trie2 values for code points. // False while iterating over the alternate values for lead surrogates. private boolean doingCodePoints = true;
Hi Christoph, I'll sponsor it. [1] BTW, email wrapped some of the lines in the patch; I'll fix it up. Thanks, Roger https://bugs.openjdk.java.net/browse/JDK-8190323 On 10/29/17 11:24 AM, Christoph Dreis wrote:
Hey,
Just noticed an occurrence of a duplicated "the" in a Locale doc and looked for other occurrences in java.base while being on it.
I don't know if documentation changes follow a special workflow because of possible translations. Please let me know!
But I'd be happy if this is sponsored or moved to the appropriate mailing list.
Cheers, Christoph
===== PATCH ====== diff -r 359c604930af src/java.base/share/classes/java/lang/WeakPairMap.java --- a/src/java.base/share/classes/java/lang/WeakPairMap.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/java/lang/WeakPairMap.java Sun Oct 29 16:13:11 2017 +0100 @@ -88,7 +88,7 @@ * Maps the specified key pair to the specified value in this WeakPairMap. * Neither the keys nor the value can be null. * <p>The value can be retrieved by calling the {@link #get} method - * with the the same keys (compared by identity). + * with the same keys (compared by identity). * * @param k1 the 1st of the pair of keys with which the specified value is to * be associated
diff -r 359c604930af src/java.base/share/classes/java/lang/invoke/MethodHandleImpl.java --- a/src/java.base/share/classes/java/lang/invoke/MethodHandleImpl.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/java/lang/invoke/MethodHandleImpl.java Sun Oct 29 16:13:11 2017 +0100 @@ -1196,7 +1196,7 @@
static MethodHandle bindCaller(MethodHandle mh, Class<?> hostClass) { - // Code in the the boot layer should now be careful while creating method handles or + // Code in the boot layer should now be careful while creating method handles or // functional interface instances created from method references to @CallerSensitive methods, // it needs to be ensured the handles or interface instances are kept safe and are not passed // from the boot layer to untrusted code.
diff -r 359c604930af src/java.base/share/classes/java/lang/invoke/StringConcatFactory.java --- a/src/java.base/share/classes/java/lang/invoke/StringConcatFactory.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/java/lang/invoke/StringConcatFactory.java Sun Oct 29 16:13:11 2017 +0100 @@ -195,7 +195,7 @@ // In case we need to double-back onto the StringConcatFactory during this // static initialization, make sure we have the reasonable defaults to complete // the static initialization properly. After that, actual users would use the - // the proper values we have read from the the properties. + // the proper values we have read from the properties. STRATEGY = DEFAULT_STRATEGY; // CACHE_ENABLE = false; // implied // CACHE = null; // implied
diff -r 359c604930af src/java.base/share/classes/java/util/Locale.java --- a/src/java.base/share/classes/java/util/Locale.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/java/util/Locale.java Sun Oct 29 16:13:11 2017 +0100 @@ -1909,7 +1909,7 @@ * Returns a name for the locale that is appropriate for display to the * user. This will be the values returned by getDisplayLanguage(), * getDisplayScript(), getDisplayCountry(), and getDisplayVariant() assembled - * into a single string. The the non-empty values are used in order, + * into a single string. The non-empty values are used in order, * with the second and subsequent names in parentheses. For example: * <blockquote> * language (script, country, variant)<br>
diff -r 359c604930af src/java.base/share/classes/java/util/ServiceLoader.java --- a/src/java.base/share/classes/java/util/ServiceLoader.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/java/util/ServiceLoader.java Sun Oct 29 16:13:11 2017 +0100 @@ -1409,7 +1409,7 @@ * * <p> To achieve laziness the actual work of locating providers is done * when processing the stream. If a service provider cannot be loaded for any - * of the the reasons specified in the <a href="#errors">Errors</a> section + * of the reasons specified in the <a href="#errors">Errors</a> section * above then {@link ServiceConfigurationError} is thrown by whatever method * caused the service provider to be loaded. </p> *
diff -r 359c604930af src/java.base/share/classes/jdk/internal/module/ModuleBootstrap.java --- a/src/java.base/share/classes/jdk/internal/module/ModuleBootstrap.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/jdk/internal/module/ModuleBootstrap.java Sun Oct 29 16:13:11 2017 +0100 @@ -66,7 +66,7 @@ * -m and --add-modules options. The modules are located on a module path that * is constructed from the upgrade module path, system modules, and application * module path. The Configuration is instantiated as the boot layer with each - * module in the the configuration defined to a class loader. + * module in the configuration defined to a class loader. */
public final class ModuleBootstrap {
diff -r 359c604930af src/java.base/share/classes/jdk/internal/module/ModuleHashesBuilder.java --- a/src/java.base/share/classes/jdk/internal/module/ModuleHashesBuilder.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/jdk/internal/module/ModuleHashesBuilder.java Sun Oct 29 16:13:11 2017 +0100 @@ -74,7 +74,7 @@ * the outgoing edges from M to non-candidate modules. */ public Map<String, ModuleHashes> computeHashes(Set<String> roots) { - // build a graph containing the the packaged modules and + // build a graph containing the packaged modules and // its transitive dependences matching --hash-modules Graph.Builder<String> builder = new Graph.Builder<>(); Deque<ResolvedModule> deque = new ArrayDeque<>(configuration.modules());
diff -r 359c604930af src/java.base/share/classes/jdk/internal/module/Resources.java --- a/src/java.base/share/classes/jdk/internal/module/Resources.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/jdk/internal/module/Resources.java Sun Oct 29 16:13:11 2017 +0100 @@ -56,7 +56,7 @@ /** * Derive a <em>package name</em> for a resource. The package name * returned by this method may not be a legal package name. This method - * returns null if the the resource name ends with a "/" (a directory) + * returns null if the resource name ends with a "/" (a directory) * or the resource name does not contain a "/". */ public static String toPackageName(String name) {
diff -r 359c604930af src/java.base/share/classes/jdk/internal/org/objectweb/asm/Frame.java --- a/src/java.base/share/classes/jdk/internal/org/objectweb/asm/Frame.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/jdk/internal/org/objectweb/asm/Frame.java Sun Oct 29 16:13:11 2017 +0100 @@ -192,7 +192,7 @@ private static final int LOCAL = 0x2000000;
/** - * Kind of the the types that are relative to the stack of an input stack + * Kind of the types that are relative to the stack of an input stack * map frame. The value of such types is a position relatively to the top of * this stack. */
diff -r 359c604930af src/java.base/share/classes/sun/security/provider/certpath/ResponderId.java --- a/src/java.base/share/classes/sun/security/provider/certpath/ResponderId.jav a Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/security/provider/certpath/ResponderId.jav a Sun Oct 29 16:13:11 2017 +0100 @@ -119,7 +119,7 @@ * When encoded in DER this object will use the byKey option, a * SHA-1 hash of the responder's public key. * - * @param pubKey the the OCSP responder's public key + * @param pubKey the OCSP responder's public key * * @throws IOException if the internal DER-encoding of the * {@code KeyIdentifier} fails.
diff -r 359c604930af src/java.base/share/classes/sun/security/provider/certpath/SunCertPathBuilde rException.java --- a/src/java.base/share/classes/sun/security/provider/certpath/SunCertPathBuil derException.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/security/provider/certpath/SunCertPathBuil derException.java Sun Oct 29 16:13:11 2017 +0100 @@ -94,7 +94,7 @@ }
/** - * Creates a <code>SunCertPathBuilderException</code> withe the specified + * Creates a <code>SunCertPathBuilderException</code> with the specified * detail message and adjacency list. * * @param msg the detail message
diff -r 359c604930af src/java.base/share/classes/sun/security/ssl/CertStatusReqItemV2.java --- a/src/java.base/share/classes/sun/security/ssl/CertStatusReqItemV2.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/security/ssl/CertStatusReqItemV2.java Sun Oct 29 16:13:11 2017 +0100 @@ -145,7 +145,7 @@ * @return the encoded length of this {@code CertStatusReqItemV2} */ int length() { - // The length is the the status type (1 byte) + the request length + // The length is the status type (1 byte) + the request length // field (2 bytes) + the StatusRequest data length. return request.length() + 3; }
diff -r 359c604930af src/java.base/share/classes/sun/security/ssl/MAC.java --- a/src/java.base/share/classes/sun/security/ssl/MAC.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/security/ssl/MAC.java Sun Oct 29 16:13:11 2017 +0100 @@ -188,7 +188,7 @@ * @param type record type * @param bb a ByteBuffer in which the position and limit * demarcate the data to be MAC'd. - * @param isSimulated if true, simulate the the MAC computation + * @param isSimulated if true, simulate the MAC computation * * @return the MAC result */
diff -r 359c604930af src/java.base/share/classes/sun/security/ssl/TrustStoreManager.java --- a/src/java.base/share/classes/sun/security/ssl/TrustStoreManager.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/security/ssl/TrustStoreManager.java Sun Oct 29 16:13:11 2017 +0100 @@ -333,7 +333,7 @@ }
/** - * Load the the KeyStore as described in the specified descriptor. + * Load the KeyStore as described in the specified descriptor. */ private static KeyStore loadKeyStore( TrustStoreDescriptor descriptor) throws Exception {
diff -r 359c604930af src/java.base/share/classes/sun/text/normalizer/Trie2.java --- a/src/java.base/share/classes/sun/text/normalizer/Trie2.java Fri Oct 27 09:51:48 2017 -0700 +++ b/src/java.base/share/classes/sun/text/normalizer/Trie2.java Sun Oct 29 16:13:11 2017 +0100 @@ -592,7 +592,7 @@ // may be lower when iterating over the code points for a single lead surrogate. private int limitCP;
- // True while iterating over the the Trie2 values for code points. + // True while iterating over the Trie2 values for code points. // False while iterating over the alternate values for lead surrogates. private boolean doingCodePoints = true;
Hi Roger,
I'll sponsor it. [1]
Thank you!
BTW, email wrapped some of the lines in the patch; I'll fix it up. Again - thanks. I'll need to get webrev to run for this somewhat "larger" patches. Is it okay to have this running on private domains? I know that some people don't like to open unknown links because of security concerns.
Cheers, Christoph
Hi Christoph, The core-libs-dev email should allow patches as attachments (specifically normal text with a .patch extension). I'm not sure on the precise filter rules but give that a try. For webrev's they would need to be on cr.openjdk.java.net; so until you have author status someone will need to sponsor them. Roger On 10/30/17 3:50 AM, Christoph Dreis wrote:
Hi Roger,
I'll sponsor it. [1] Thank you!
BTW, email wrapped some of the lines in the patch; I'll fix it up. Again - thanks. I'll need to get webrev to run for this somewhat "larger" patches. Is it okay to have this running on private domains? I know that some people don't like to open unknown links because of security concerns.
Cheers, Christoph
participants (2)
-
Christoph Dreis
-
Roger Riggs