RFR [15] 8247936: Fix typos in man pages

Pavel Rappo pavel.rappo at oracle.com
Fri Jun 19 14:55:17 UTC 2020


Hello,

Please review the below change for https://bugs.openjdk.java.net/browse/JDK-8247936

-----------------------
diff --git a/closed/src/java.base/share/man/java.md b/closed/src/java.base/share/man/java.md
--- a/closed/src/java.base/share/man/java.md
+++ b/closed/src/java.base/share/man/java.md
@@ -2691,7 +2691,7 @@
 :   Sets the allocation spike tolerance for ZGC. By default, this option is
     set to 2.0. This factor describes the level of allocation spikes to expect.
     For example, using a factor of 3.0 means the current allocation rate can
-    be expected to tripple at any time.
+    be expected to triple at any time.
 
 `-XX:ZCollectionInterval`=*seconds*
 :   Sets the maximum interval (in seconds) between two GC cycles when using
@@ -2700,7 +2700,7 @@
 `-XX:ZFragmentationLimit`=*percent*
 :   Sets the maximum acceptable heap fragmentation (in percent) for ZGC.
     By default, this option is set to 25. Using a lower value will cause the
-    heap to be compacted more agressively, to reclaim more memory at the cost
+    heap to be compacted more aggressively, to reclaim more memory at the cost
     of using more CPU time.
 
 `-XX:+ZProactive`
diff --git a/closed/src/java.base/share/specs/jar/jar.md b/closed/src/java.base/share/specs/jar/jar.md
--- a/closed/src/java.base/share/specs/jar/jar.md
+++ b/closed/src/java.base/share/specs/jar/jar.md
@@ -605,7 +605,7 @@
 
 Digital signature files for signature algorithms not listed above must
 reside in the `META-INF` directory and have the prefix "`SIG-`". The
-corresonding signature file (`.SF` file) must also have the same prefix.
+corresponding signature file (`.SF` file) must also have the same prefix.
 
 For those formats that do not support external signed data, the file
 shall consist of a signed copy of the `.SF` file. Thus some data may be
diff --git a/closed/src/jdk.jcmd/share/man/jcmd.md b/closed/src/jdk.jcmd/share/man/jcmd.md
--- a/closed/src/jdk.jcmd/share/man/jcmd.md
+++ b/closed/src/jdk.jcmd/share/man/jcmd.md
@@ -629,7 +629,7 @@
 
 `VM.log` \[*options*\]
 :   Lists current log configuration, enables/disables/configures a log output,
-    or ro tates all logs.
+    or rotates all logs.
 
     Impact: Low
 
diff --git a/closed/src/jdk.jdwp.agent/share/specs/jdwp/jdwp-transport.md b/closed/src/jdk.jdwp.agent/share/specs/jdwp/jdwp-transport.md
--- a/closed/src/jdk.jdwp.agent/share/specs/jdwp/jdwp-transport.md
+++ b/closed/src/jdk.jdwp.agent/share/specs/jdwp/jdwp-transport.md
@@ -38,7 +38,7 @@
 value other than `JDWPTRANSPORT_ERROR_NONE`) then a string representing the
 error can be subsequently obtained through a call to the jdwpTransport function
 `GetLastError`. Errors are recorded on a per-thread basis. The `GetLastError`
-function will return a string represetning the last error that was encountered
+function will return a string representing the last error that was encountered
 by the current thread only.
 
 ## Developing a Transport implementation
@@ -90,7 +90,7 @@
 
 The function table has two entries. The `alloc` function allocates an area of
 memory. It has a single argument to specify the number of bytes to allocate. It
-returns a pointer to the begining of the allocated memory, or NULL if the
+returns a pointer to the beginning of the allocated memory, or NULL if the
 memory request cannot be honored. If the number of bytes requested is zero then
 NULL is returned. The `free` function deallocates an area of memory that was
 previously allocated using the `alloc` function.
-----------------------

Since we are waiting for the remaining updates to man pages for JDK 15 [1], I think now is a good opportunity to fix some typos.

Regarding that change above. There's one typo could be fixed by rephrasing.

Instead of fixing like this:

-    be expected to tripple at any time.
+    be expected to triple at any time.

It could be alternatively fixed like this:

-    be expected to tripple at any time.
+    be expected to increase threefold at any time.

-Pavel


[1] https://mail.openjdk.java.net/pipermail/build-dev/2020-June/027674.html




More information about the build-dev mailing list