From 8cfec8157fa4188b0f7bbe070c2fddae7c5770ef Mon Sep 17 00:00:00 2001 From: hengyunabc Date: Wed, 5 Dec 2018 02:20:44 +0800 Subject: [PATCH] update doc --- README_CN.md | 2 +- site/src/site/sphinx/en/quick-start.md | 6 +++--- site/src/site/sphinx/index.md | 2 +- site/src/site/sphinx/quick-start.md | 8 ++++---- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/README_CN.md b/README_CN.md index 8c555ab86..55a4fb17b 100644 --- a/README_CN.md +++ b/README_CN.md @@ -69,7 +69,7 @@ curl -L https://alibaba.github.io/arthas/install.sh | sh * [进阶使用](https://alibaba.github.io/arthas/advanced-use.html) * [命令列表](https://alibaba.github.io/arthas/commands.html) * [用户案例](https://github.com/alibaba/arthas/issues?q=label%3Auser-case) -* [Q&A](https://github.com/alibaba/arthas/issues?utf8=%E2%9C%93&q=label%3Aquestion-answered+) +* [常见问题](https://github.com/alibaba/arthas/issues?utf8=%E2%9C%93&q=label%3Aquestion-answered+) * [参与贡献](https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md) * [Release Notes](https://alibaba.github.io/arthas/release-notes.html) * [QQ群/钉钉群](https://alibaba.github.io/arthas/contact-us.html) diff --git a/site/src/site/sphinx/en/quick-start.md b/site/src/site/sphinx/en/quick-start.md index 0631e3f42..7b7af14df 100644 --- a/site/src/site/sphinx/en/quick-start.md +++ b/site/src/site/sphinx/en/quick-start.md @@ -24,7 +24,7 @@ $ java -jar arthas-boot.jar ``` * The user to run this command *MUST* have the same privilege as the owner of the target process, as a simple example you can try the following command if the target process is managed by user `admin`: `sudo su admin && java -jar arthas-boot.jar` or `sudo -u admin -EH java -jar arthas-boot.jar` -* .If you cannot be able to attach to the target process, please check the logs under `~/logs/arthas` for troubleshooting. +* If you cannot be able to attach to the target process, please check the logs under `~/logs/arthas` for troubleshooting. * `java -jar arthas-boot.jar -h` print usage. Select the target Java process to attach: @@ -60,7 +60,7 @@ $ Type '[dashboard](dashboard.md)' and hit 'ENTER', a brief report on the current process will be shown as below, pls. `Ctrl+C` to stop: -``` +```bash $ dashboard ID NAME GROUP PRIORI STATE %CPU TIME INTERRU DAEMON 17 pool-2-thread-1 system 5 WAITIN 67 0:0 false false @@ -188,7 +188,7 @@ Affect(row-cnt:1) cost in 970 ms. Use '[watch](watch.md)' to view the return object of `demo.MathGame#primeFactors`: -``` +```bash $ watch demo.MathGame primeFactors returnObj Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 107 ms. diff --git a/site/src/site/sphinx/index.md b/site/src/site/sphinx/index.md index b09e63e27..aeadde2e0 100644 --- a/site/src/site/sphinx/index.md +++ b/site/src/site/sphinx/index.md @@ -30,7 +30,7 @@ Contents * [进阶使用](advanced-use.md) * [命令列表](commands.md) * [用户案例](https://github.com/alibaba/arthas/issues?q=label%3Auser-case) -* [Questions and answers](https://github.com/alibaba/arthas/issues?q=label%3Aquestion-answered) +* [常见问题](https://github.com/alibaba/arthas/issues?q=label%3Aquestion-answered) * [Fork me at GitHub](https://github.com/alibaba/arthas) * [参与贡献](https://github.com/alibaba/arthas/blob/master/CONTRIBUTING.md) * [Release Notes](release-notes.md) diff --git a/site/src/site/sphinx/quick-start.md b/site/src/site/sphinx/quick-start.md index f4022aaf5..941d5a118 100644 --- a/site/src/site/sphinx/quick-start.md +++ b/site/src/site/sphinx/quick-start.md @@ -30,7 +30,7 @@ $ java -jar arthas-boot.jar 选择应用java进程： -``` +```bash $ $ java -jar arthas-boot.jar * [1]: 35542 [2]: 71560 arthas-demo.jar @@ -38,7 +38,7 @@ $ $ java -jar arthas-boot.jar Demo进程是第2个，则输入2，再输入回车/enter。Arthas会attach到目标进程上，并输出日志： -``` +```bash [INFO] Try to attach process 71560 [INFO] Attach process 71560 success. [INFO] arthas-client connect 127.0.0.1 3658 @@ -61,7 +61,7 @@ $ 输入[dashboard](dashboard.md)，按enter/回车，会展示当前进程的信息，按`ctrl+c`可以中断执行。 -``` +```bash $ dashboard ID NAME GROUP PRIORI STATE %CPU TIME INTERRU DAEMON 17 pool-2-thread-1 system 5 WAITIN 67 0:0 false false @@ -189,7 +189,7 @@ Affect(row-cnt:1) cost in 970 ms. 通过[watch](watch.md)命令来查看`demo.MathGame#primeFactors`函数的返回值： -``` +```bash $ watch demo.MathGame primeFactors returnObj Press Ctrl+C to abort. Affect(class-cnt:1 , method-cnt:1) cost in 107 ms.