From 685c8f6654629a29272c5eb7e3646bf91bff1789 Mon Sep 17 00:00:00 2001 From: Minchul Kang Date: Sat, 9 Nov 2019 12:47:06 +0900 Subject: [PATCH] doc: Modified README.md and ko/README.md Since Lua 5.1 script is now available and dynamic tracing for AArch64 (ARM64) is possible in uftrace, this commit updates both English README and Korean README as containing those information. --- README.md | 13 +++++++------ doc/ko/README.md | 4 ++-- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d33e2cefa..c914277f3 100644 --- a/README.md +++ b/README.md @@ -88,11 +88,12 @@ For recording, the executable needs to be compiled with the `-pg` (or `-finstrument-functions`) option which generates profiling code (calling mcount or __cyg_profile_func_enter/exit) for each function. -Note that, there's an experimental support for dynamic tracing on x86_64 -which doesn't require such (re-)compilations. Also recent compilers have -some options to help uftrace to reduce tracing overhead with similar way -(although it still needs recompilation of your program). Please see -[doc/uftrace-record.md](doc/uftrace-record.md) file. +Note that, there's an experimental support for dynamic tracing on +x86_64 and AArch64(ARM64) which doesn't require such (re-)compilations. +Also recent compilers have some options to help uftrace +to reduce tracing overhead with similar way +(although it still needs recompilation of your program). +Please see [doc/uftrace-record.md](doc/uftrace-record.md) file. $ uftrace tests/t-abc # DURATION TID FUNCTION @@ -251,7 +252,7 @@ The `info` command shows system and program information when recorded. # disk iops : 0 / 24 (read / write) The `script` command allows user to run a custom script on a data recorded. -Currently python (version 2.7) is supported only. +The supported script types are Python 2.7 and Lua 5.1 as of now. The `tui` command is for interactive text-based user interface using ncurses. It provides basic functionality of `graph`, `report` and `info` commands as of diff --git a/doc/ko/README.md b/doc/ko/README.md index 79b2538ef..584020c9c 100644 --- a/doc/ko/README.md +++ b/doc/ko/README.md @@ -85,7 +85,7 @@ record 명령어로 기록을 하려면, 각 함수마다 mcount 나 __cyg_profi 호출하는 프로파일링 코드를 생성하기 위해 실행 파일을 `-pg`(혹은 `-finstrument-functions`) 옵션으로 컴파일해야 한다. -x86_64 아키텍처에서 (재)컴파일 과정이 필요하지 않은 동적 추적 기능이 +x86_64 와 AArch64(ARM64) 아키텍처에서 (재)컴파일 과정이 필요하지 않은 동적 추적 기능이 실험적으로 지원되고 있다. 또한 최근 컴파일러들 중 (여전히 사용자 프로그램을 재컴파일해야 하긴 하지만) 비슷한 방식으로 uftrace의 추적 과정에서 생기는 오버헤드를 줄이기 위한 옵션들을 제공하고 있다. @@ -246,7 +246,7 @@ flame-graph 형식의 결과 또한 지원한다. 해당 데이터는 `uftrace d # disk iops : 0 / 24 (read / write) `script` 명령어는 기록된 데이터에 사용자 정의 스크립트를 실행할 수 있게 한다. -지원되는 스크립트는 Python 2.7 뿐이다. +현재까지 지원되는 스크립트는 Python 2.7 과 Lua 5.1 이다. `tui` 명령어는 ncurses 를 이용한 텍스트 기반 대화형 사용자 인터페이스를 위한 명령어이다. 현재 `graph`, `report`, `info` 명령어의 기본적인 기능을 제공한다.