docs: removed typos and fixes grammatical errors (#1206)

pull/1413/head
Arteev Raina 5 years ago committed by GitHub
parent 61876370d4
commit daac254aea
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -62,7 +62,7 @@ Tip: you can use `--versions` to list all available versions.
## issue ## Issue
欢迎在issue里对arthas做反馈分享使用技巧排查问题的经历。 欢迎在issue里对arthas做反馈分享使用技巧排查问题的经历。

@ -42,14 +42,14 @@ Arthas was built to solve these issues. A developer can troubleshoot your produc
* Supports Linux/Mac/Windows. * Supports Linux/Mac/Windows.
### Online Tutorials(Recommend) ### Online Tutorials(Recommended)
* [Arthas Basics](https://alibaba.github.io/arthas/arthas-tutorials?language=en&id=arthas-basics) * [Arthas Basics](https://alibaba.github.io/arthas/arthas-tutorials?language=en&id=arthas-basics)
* [Arthas Advanced](https://alibaba.github.io/arthas/arthas-tutorials?language=en&id=arthas-advanced) * [Arthas Advanced](https://alibaba.github.io/arthas/arthas-tutorials?language=en&id=arthas-advanced)
### Quick start ### Quick start
#### Use `arthas-boot`(Recommend) #### Use `arthas-boot`(Recommended)
Download`arthas-boot.jar`Start with `java` command: Download`arthas-boot.jar`Start with `java` command:
@ -79,7 +79,7 @@ You can enter its interactive interface by executing `as.sh`, or execute `as.sh
### Documentation ### Documentation
* [Online Tutorials(Recommend)](https://alibaba.github.io/arthas/arthas-tutorials?language=en) * [Online Tutorials(Recommended)](https://alibaba.github.io/arthas/arthas-tutorials?language=en)
* [User manual](https://alibaba.github.io/arthas/en) * [User manual](https://alibaba.github.io/arthas/en)
* [Installation](https://alibaba.github.io/arthas/en/install-detail.html) * [Installation](https://alibaba.github.io/arthas/en/install-detail.html)
* [Download](https://alibaba.github.io/arthas/en/download.html) * [Download](https://alibaba.github.io/arthas/en/download.html)
@ -106,7 +106,7 @@ You can enter its interactive interface by executing `as.sh`, or execute `as.sh
* https://alibaba.github.io/arthas/en/thread * https://alibaba.github.io/arthas/en/thread
See what is eating your cpu (ranked by top cpu usage) and what is going on there in one glance: See what is eating your CPU (ranked by top CPU usage) and what is going on there in one glance:
```bash ```bash
$ thread -n 3 $ thread -n 3
@ -516,11 +516,11 @@ Welcome to register the company name in this issue: https://github.com/alibaba/a
* [Bistoury: A project that integrates Arthas](https://github.com/qunarcorp/bistoury) * [Bistoury: A project that integrates Arthas](https://github.com/qunarcorp/bistoury)
* [A fork of arthas using MVEL](https://github.com/XhinLiang/arthas) * [A fork of arthas using MVEL](https://github.com/XhinLiang/arthas)
### Credit ### Credits
#### Contributors #### Contributors
This project exists thanks to all the people who contribute. This project exists, thanks to all the people who contributed.
<a href="https://github.com/alibaba/arthas/graphs/contributors"><img src="https://opencollective.com/arthas/contributors.svg?width=890&button=false" /></a> <a href="https://github.com/alibaba/arthas/graphs/contributors"><img src="https://opencollective.com/arthas/contributors.svg?width=890&button=false" /></a>

@ -45,7 +45,7 @@ Advanced Usage
## monitor/watch/trace - related ## monitor/watch/trace - related
> **Attention**: commands here are taking advantage of byte-code-injection, which means we are injecting some [aspects](https://en.wikipedia.org/wiki/Aspect-oriented_programming) into the current classes for monitoring and statistics purpose. Therefore when use it for online troubleshooting in your production environment, you'd better **explicitly specify** classes/methods/criteria, and remember to remove the injected code by `stop` or `reset`. > **Attention**: commands here are taking advantage of byte-code-injection, which means we are injecting some [aspects](https://en.wikipedia.org/wiki/Aspect-oriented_programming) into the current classes for monitoring and statistics purpose. Therefore, when using it for online troubleshooting in your production environment, you'd better **explicitly specify** classes/methods/criteria, and remember to remove the injected code by `stop` or `reset`.
* [monitor](monitor.md) - monitor method execution statistics * [monitor](monitor.md) - monitor method execution statistics
* [watch](watch.md) - display the input/output parameter, return object, and thrown exception of specified method invocation * [watch](watch.md) - display the input/output parameter, return object, and thrown exception of specified method invocation

@ -40,8 +40,8 @@ You can see that there is currently a background job executing:
When the job is executing in the foreground, for example, directly executing the command `trace Test t`, or executing the background job command `trace Test t &`, then putting the job back to the foreground via `fg` command, the console cannot continue to execute other command, but can receive and process the following keyboard events: When the job is executing in the foreground, for example, directly executing the command `trace Test t`, or executing the background job command `trace Test t &`, then putting the job back to the foreground via `fg` command, the console cannot continue to execute other command, but can receive and process the following keyboard events:
* ctrl + z: Suspend the job, the job status will change to `Stopped`, and the job can be restarted by `bg <job-id>` or `fg <job-id>` * ctrl + z: Suspends the job, the job status will change to `Stopped`, and the job can be restarted by `bg <job-id>` or `fg <job-id>`
* ctrl + c: Stop the job * ctrl + c: Stops the job
* ctrl + d: According to linux semantics this should lead to exit the terminal, right now Arthas has not implemented this yet, therefore simply ignore this keystroke. * ctrl + d: According to linux semantics this should lead to exit the terminal, right now Arthas has not implemented this yet, therefore simply ignore this keystroke.
## 4. fg/bg, switch the job from the foreground to the background, and vise verse ## 4. fg/bg, switch the job from the foreground to the background, and vise verse
@ -60,7 +60,7 @@ $ trace Test t >> test.out &
The trace command will be running in the background and the output will be redirect to `~/logs/arthas-cache/test.out`. You can continue to execute other commands in the console, at the same time, you can also examine the execution result from the output file. The trace command will be running in the background and the output will be redirect to `~/logs/arthas-cache/test.out`. You can continue to execute other commands in the console, at the same time, you can also examine the execution result from the output file.
When connect to a remote Arthas server, you may not be able to view the output file on the remote machine. In this case, Arthas also supports automatically redirecting the output to the local cache file. Examples are as follows: When connected to a remote Arthas server, you may not be able to view the output file on the remote machine. In this case, Arthas also supports automatically redirecting the output to the local cache file. Examples are as follows:
```bash ```bash
$ trace Test t >> & $ trace Test t >> &

@ -38,7 +38,7 @@ Use `-c` also can specify the commands, like this:
./as.sh -c 'sysprop; thread' 56328 > test.out ./as.sh -c 'sysprop; thread' 56328 > test.out
``` ```
#### Step 3: Check the outputs #### Step 3: Check the output
```bash ```bash
cat test.out cat test.out

@ -3,7 +3,7 @@ classloader
View hierarchy, urls and classes-loading info for the class-loaders. View hierarchy, urls and classes-loading info for the class-loaders.
`classloader` can search and print out the URLs for a specified resource from one particular classloader. It is quite handy when analyze `ResourceNotFoundException`. `classloader` can search and print out the URLs for a specified resource from one particular classloader. It is quite handy when analyzing `ResourceNotFoundException`.
### Options ### Options

@ -42,15 +42,15 @@ All Commands
### Basic Arthas Commands ### Basic Arthas Commands
* help - examine help information * help - examines help information
* cls - clear out the screen * cls - clears out the screen
* session - examine the current session * session - examines the current session
* [reset](reset.md) - reset enhanced classes. All enhanced classes will be reset to their original states. When Arthas server closes, all these enhanced classes will be reset too * [reset](reset.md) - resets enhanced classes. All enhanced classes will be reset to their original states. When Arthas server closes, all these enhanced classes will be reset too
* version - print out Arthas's version * version - prints out Arthas's version
* history - view command history * history - view command history
* quit - exit the current Arthas client without affecting other clients * quit - exit the current Arthas client without affecting other clients
* stop - terminate the Arthas server, all the Arthas clients connecting to this server will be disconnected * stop - terminates the Arthas server, all the Arthas clients connecting to this server will be disconnected
* [keymap](keymap.md) - list all Arthas keyboard shortcuts and shortcut customizations. * [keymap](keymap.md) - lists all Arthas keyboard shortcuts and shortcut customizations.

@ -3,7 +3,7 @@ Download
## Download full package ## Download full package
### Dwonload from maven central ### Download from maven central
Latest Version, Click To Download: [![](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.taobao.arthas&a=arthas-packaging&e=zip&c=bin&v=LATEST) Latest Version, Click To Download: [![](https://img.shields.io/maven-central/v/com.taobao.arthas/arthas-packaging.svg?style=flat-square "Arthas")](http://repository.sonatype.org/service/local/artifact/maven/redirect?r=central-proxy&g=com.taobao.arthas&a=arthas-packaging&e=zip&c=bin&v=LATEST)

@ -1,7 +1,7 @@
getstatic getstatic
========= =========
* It is recommended to use the [OGNL] (ognl.md) command, which will be more flexibility. * It is recommended to use the [OGNL] (ognl.md) command, which will be more flexible.
Check the static fields of classes conveniently, the usage is `getstatic class_name field_name`. Check the static fields of classes conveniently, the usage is `getstatic class_name field_name`.

@ -6,7 +6,7 @@ groovy
### Limitations ### Limitations
1. Prohibit from alternating the original logic. Like `watch` command, The major purpose of scripting is monitoring and observing. 1. Prohibit from alternating the original logic. Like `watch` command, The major purpose of scripting is monitoring and observing.
1. Only allow to monitor at the stages of before/success/exception/finish on one method. 2. Only allow to monitor at the stages of before/success/exception/finish on one method.
### Parameters ### Parameters

@ -34,7 +34,7 @@ Arthas is built to solve these issues. A developer can troubleshoot production i
* Supports Linux/Mac/Windows * Supports Linux/Mac/Windows
**If you are using Arthas, please let us know. Your use is very important to us: [View](https://github.com/alibaba/arthas/issues/111)** **If you are using Arthas, please let us know. Your feedback is very important to us: [View](https://github.com/alibaba/arthas/issues/111)**
Contents Contents
-------- --------

@ -4,7 +4,7 @@ Install Arthas
## Quick installation ## Quick installation
### Use `arthas-boot`(Recommend) ### Use `arthas-boot`(Recommended)
Download`arthas-boot.jar`Start with `java` command: Download`arthas-boot.jar`Start with `java` command:

@ -62,8 +62,8 @@ then replace `"\C-h": backward-delete-char` with `"\C-h": backward-char`, then r
#### Shortcuts for jobs #### Shortcuts for jobs
* `ctrl + c`: Terminate current command * `ctrl + c`: Terminates current command
* `ctrl + z`: Suspend the current command, you can restore this command with `bg`/`fg`, or `kill` it. * `ctrl + z`: Suspends the current command, you can restore this command with `bg`/`fg`, or `kill` it.
* `ctrl + a`: Go to the beginning the line * `ctrl + a`: Go to the beginning the line
* `ctrl + e`: Go to the end of the line * `ctrl + e`: Go to the end of the line

@ -8,7 +8,7 @@ curl -O https://alibaba.github.io/arthas/arthas-demo.jar
java -jar arthas-demo.jar java -jar arthas-demo.jar
``` ```
`arthas-demo` is a simple program that generates a random number every second, then find all prime factors of the number. `arthas-demo` is a simple program that generates a random number every second, then it finds all prime factors of that number.
The source code of `arthas-demo`: [View](https://github.com/alibaba/arthas/blob/master/demo/src/main/java/demo/MathGame.java) The source code of `arthas-demo`: [View](https://github.com/alibaba/arthas/blob/master/demo/src/main/java/demo/MathGame.java)

Loading…
Cancel
Save