Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Modified README.md and ko/README.md #1027

Merged
merged 1 commit into from
Nov 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove all the white spaces at the end of lines. They are shown as red blocks in the diff output.
Screen Shot 2019-11-11 at 11 22 04 PM


$ uftrace tests/t-abc
# DURATION TID FUNCTION
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions doc/ko/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ record 명령어로 기록을 하려면, 각 함수마다 mcount 나 __cyg_profi
호출하는 프로파일링 코드를 생성하기 위해 실행 파일을 `-pg`(혹은 `-finstrument-functions`) 옵션으로
컴파일해야 한다.

x86_64 아키텍처에서 (재)컴파일 과정이 필요하지 않은 동적 추적 기능이
x86_64 와 AArch64(ARM64) 아키텍처에서 (재)컴파일 과정이 필요하지 않은 동적 추적 기능이
실험적으로 지원되고 있다. 또한 최근 컴파일러들 중
(여전히 사용자 프로그램을 재컴파일해야 하긴 하지만) 비슷한 방식으로
uftrace의 추적 과정에서 생기는 오버헤드를 줄이기 위한 옵션들을 제공하고 있다.
Expand Down Expand Up @@ -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` 명령어의 기본적인 기능을 제공한다.
Expand Down