Skip to content

Commit 4a3d263

Browse files
committed
Fix spelling, grammar and small refactorings
1 parent fdcc43f commit 4a3d263

File tree

5 files changed

+151
-176
lines changed

5 files changed

+151
-176
lines changed

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
This plugin for the [Cloud Foundry Command Line](https://github.com/cloudfoundry/cli) provides convenience utilities to
88
work with Java applications deployed on Cloud Foundry.
99

10-
Currently, it allows to:
10+
Currently, it allows you to:
1111

1212
- Trigger and retrieve a heap dump and a thread dump from an instance of a Cloud Foundry Java application
1313
- To run jcmd remotely on your application
@@ -44,7 +44,7 @@ Trigger installation of the plugin via
4444
cf install-plugin java
4545
```
4646

47-
The releases in the community repository are older that the actual releases on GitHub, that you can install manually, so
47+
The releases in the community repository are older than the actual releases on GitHub, that you can install manually, so
4848
we recommend the manual installation.
4949

5050
### Manual Installation of Snapshot Release
@@ -97,16 +97,16 @@ applications:
9797
buildpack: https://github.com/cloudfoundry/java-buildpack
9898
env:
9999
JBP_CONFIG_OPEN_JDK_JRE:
100-
'{ jre: { repository_root: "https://java-buildpack.cloudfoundry.org/openjdk-jdk/bionic/x86_64", version: 11.+ }
100+
'{ jre: { repository_root: "https://java-buildpack.cloudfoundry.org/openjdk-jdk/jammy/x86_64", version: 11.+ }
101101
}'
102102
JBP_CONFIG_JAVA_OPTS: "[java_opts: '-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints']"
103103
```
104104
105-
`-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints` is used to improve profiling accurary and has no known negative
105+
`-XX:+UnlockDiagnosticVMOptions -XX:+DebugNonSafepoints` is used to improve profiling accuracy and has no known negative
106106
performance impacts.
107107

108108
Please note that this requires the use of an online buildpack (configured in the `buildpack` property). When system
109-
buildpacks are used, staging will fail with cache issues, because the system buildpacks don’t have the JDK chached.
109+
buildpacks are used, staging will fail with cache issues, because the system buildpacks don’t have the JDK cached.
110110
Please also note that this is not to be considered a recommendation to use a full JDK. It's just one option to get the
111111
tools required for the use of this plugin when you need it, e.g., for troubleshooting. The `version` property is
112112
optional and can be used to request a specific Java version.
@@ -150,7 +150,7 @@ Creating a CPU-time profile via async-profiler:
150150
> cf java asprof-start-cpu $APP_NAME
151151
Profiling started
152152
# wait some time to gather data
153-
> cf java asprof-stop-cpu $APP_NAME
153+
> cf java asprof-stop $APP_NAME
154154
-> ./$APP_NAME-asprof-$RANDOM.jfr
155155
```
156156

@@ -222,19 +222,19 @@ USAGE:
222222

223223
jfr-start
224224
Start a Java Flight Recorder default recording on a running Java
225-
application (stores in the the container-dir)
225+
application (stores in the container-dir)
226226

227227
jfr-start-profile
228228
Start a Java Flight Recorder profile recording on a running Java
229-
application (stores in the the container-dir))
229+
application (stores in the container-dir))
230230

231231
jfr-start-gc (recent SapMachine only)
232232
Start a Java Flight Recorder GC recording on a running Java application
233-
(stores in the the container-dir)
233+
(stores in the container-dir)
234234

235235
jfr-start-gc-details (recent SapMachine only)
236236
Start a Java Flight Recorder detailed GC recording on a running Java
237-
application (stores in the the container-dir)
237+
application (stores in the container-dir)
238238

239239
jfr-stop
240240
Stop a Java Flight Recorder recording on a running Java application
@@ -288,23 +288,23 @@ USAGE:
288288
Get the status of async-profiler on a running Java application
289289

290290
OPTIONS:
291-
-args -a, Miscellaneous arguments to pass to the command (if supported) in the
292-
container, be aware to end it with a space if it is a simple option. For
293-
commands that create arbitrary files (jcmd, asprof), the environment
294-
variables @FSPATH, @ARGS, @APP_NAME, @FILE_NAME, and @STATIC_FILE_NAME are
295-
available in --args to reference the working directory path, arguments,
296-
application name, and generated file name respectively.
297291
-container-dir -cd, the directory path in the container that the heap dump/JFR/... file will be
298292
saved to
299293
-dry-run -n, just output to command line what would be executed
300294
-keep -k, keep the heap dump in the container; by default the heap dump/JFR/... will
301-
be deleted from the container's filesystem after been downloaded
295+
be deleted from the container's filesystem after being downloaded
302296
-local-dir -ld, the local directory path that the dump/JFR/... file will be saved to,
303297
defaults to the current directory
304298
-no-download -nd, don't download the heap dump/JFR/... file to local, only keep it in the
305299
container, implies '--keep'
306300
-verbose -v, enable verbose output for the plugin
307301
-app-instance-index -i [index], select to which instance of the app to connect
302+
-args -a, Miscellaneous arguments to pass to the command (if supported) in the
303+
container, be aware to end it with a space if it is a simple option. For
304+
commands that create arbitrary files (jcmd, asprof), the environment
305+
variables @FSPATH, @ARGS, @APP_NAME, @FILE_NAME, and @STATIC_FILE_NAME are
306+
available in --args to reference the working directory path, arguments,
307+
application name, and generated file name respectively.
308308

309309
</pre>
310310

0 commit comments

Comments
 (0)