From 4afc58f6faf62c7ce1d95239f354a2d955327040 Mon Sep 17 00:00:00 2001 From: Honggyu Kim Date: Sun, 29 Sep 2024 13:58:08 +0900 Subject: [PATCH] doc: Update man pages for better sync up Having applying Sin Sohi's man page update[1], I found many more differences in Korean and English man pages so apply more changes for better sync up. In addition, uftrace-live.md also has some missing parts for --srcline and --format so add them together. [1] 5430d02d doc/ko: Add missing options in uftrace-replay.md Signed-off-by: Honggyu Kim --- doc/ko/uftrace-live.md | 22 +++++++++++++++++----- doc/ko/uftrace-record.md | 7 +++++-- doc/ko/uftrace-replay.md | 8 ++++---- doc/uftrace-live.md | 12 +++++++++--- 4 files changed, 35 insertions(+), 14 deletions(-) diff --git a/doc/ko/uftrace-live.md b/doc/ko/uftrace-live.md index 452d8cf59..b35b086c8 100644 --- a/doc/ko/uftrace-live.md +++ b/doc/ko/uftrace-live.md @@ -74,8 +74,11 @@ uftrace [live] [*options*] COMMAND [*command-options*] 기본 설정은 `regex`이다. \--disable -: uftrace 를 시작할때 데이터를 기록하지 않고 시작한다. - 이것은 `trace_on` 트리거와 함께 사용되었을 때만 의미를 가진다. +: 더 이상 사용되지 않으며 대신 `--trace=off` 를 사용할 수 있다. + +\--trace=*STATE* +: uftrace 트레이싱 상태를 설정한다. 가능한 상태는 `on`과 `off`이며 기본값은 + `on`이다. 이는 `trace_on` 트리거나 에이전트와 함께 사용할 때만 의미가 있다. \--with-syms=*DIR* : DIR 디렉토리의 .sym 파일에서 심볼(symbol) 데이터를 읽는다. @@ -237,9 +240,9 @@ RECORD 설정 옵션 REPLAY 옵션 ============== -f *FIELD*, \--output-fields=*FIELD* -: 결과로 보여지는 필드를 사용자가 지정한다. 가능한 값들로는 duration, tid, - time, delta, elapsed, addr 가 있다. 여러 필드를 갖는 경우 콤마로 구분된다. - 모든 필드를 감추기 위한 (단일하게 사용되는) 'none' 특수 필드가 있으며 +: 결과로 보여지는 필드를 사용자가 지정한다. 가능한 값들로는 duration, tid, addr, + time, delta, elapsed, task and module 이 있다. 여러 필드를 갖는 경우 콤마로 + 구분된다. 모든 필드를 감추기 위한 (단일하게 사용되는) 'none' 특수 필드가 있으며 기본적으로 'duration,tid' 가 사용된다. 상세한 설명은 *FIELDS* 를 참고한다. \--flat @@ -264,6 +267,15 @@ REPLAY 옵션 \--libname : 함수 이름과 함께 라이브러리 이름을 출력한다. +\--srcline +: 가능한 경우 각 함수의 소스 위치를 표시한다. + +\--format=*TYPE* +: 형식화된 출력을 보여준다. 현재는 'normal' 과 'html' 형식이 지원된다. + +\--no-args +: 함수 인자와 반환값을 표시하지 않는다. + 공통 분석 옵션 ======================= diff --git a/doc/ko/uftrace-record.md b/doc/ko/uftrace-record.md index 34a634ed8..818ad3b4b 100644 --- a/doc/ko/uftrace-record.md +++ b/doc/ko/uftrace-record.md @@ -172,8 +172,11 @@ RECORD 옵션 기본은 `regex`이다. \--disable -: 추적을 사용하지 않은 채로 uftrace를 시작한다. 이것은 `trace_on` 트리거와 함께 - 사용되었을 때만 의미를 가진다. +: 더 이상 사용되지 않으며 대신 `--trace=off` 를 사용할 수 있다. + +\--trace=*STATE* +: uftrace 트레이싱 상태를 설정한다. 가능한 상태는 `on`과 `off`이며 기본값은 + `on`이다. 이는 `trace_on` 트리거나 에이전트와 함께 사용할 때만 의미가 있다. \--with-syms=*DIR* : DIR 디렉토리의 .sym 파일에서 심볼(symbol) 데이터를 읽는다. diff --git a/doc/ko/uftrace-replay.md b/doc/ko/uftrace-replay.md index ee497eb04..eae24b2eb 100644 --- a/doc/ko/uftrace-replay.md +++ b/doc/ko/uftrace-replay.md @@ -21,9 +21,9 @@ uftrace replay [*options*] REPLAY 옵션 ============== -f *FIELD*, \--output-fields=*FIELD* -: 결과로 보여지는 필드를 사용자가 지정한다. 가능한 값들로는 duration, tid, - time, delta, elapsed, addr, task, module 가 있다. 여러 필드를 갖는 경우 콤마로 구분된다. - 모든 필드를 감추기 위한 (단일하게 사용되는) 'none' 특수 필드가 있으며 +: 결과로 보여지는 필드를 사용자가 지정한다. 가능한 값들로는 duration, tid, addr, + time, delta, elapsed, task, module 이 있다. 여러 필드를 갖는 경우 콤마 + 로 구분된다. 모든 필드를 감추기 위한 (단일하게 사용되는) 'none' 특수 필드가 있으며 기본적으로 'duration,tid' 가 사용된다. 상세한 설명은 *FIELDS* 를 참고한다. \--flat @@ -116,7 +116,7 @@ REPLAY 옵션 기본 설정은 `regex`이다. \--disable -: 더 이상 사용되지 않는다. 대신 `--trace=off`를 사용한다. +: 더 이상 사용되지 않으며 대신 `--trace=off` 를 사용할 수 있다. \--trace=*STATE* : uftrace 트레이싱 상태를 설정한다. 가능한 상태는 `on`과 `off`이며 기본값은 diff --git a/doc/uftrace-live.md b/doc/uftrace-live.md index 61338ea48..dafb288d3 100644 --- a/doc/uftrace-live.md +++ b/doc/uftrace-live.md @@ -238,9 +238,9 @@ RECORD CONFIG OPTIONS REPLAY OPTIONS ============== -f *FIELD*, \--output-fields=*FIELD* -: Customize field in the output. Possible values are: duration, tid, time, - delta, elapsed and addr. Multiple fields can be set by using comma. - Special field of 'none' can be used (solely) to hide all fields. +: Customize field in the output. Possible values are: duration, tid, addr, + time, delta, elapsed, task and module. Multiple fields can be set by using + comma. Special field of 'none' can be used (solely) to hide all fields. Default is 'duration,tid'. See *FIELDS*. \--flat @@ -265,6 +265,12 @@ REPLAY OPTIONS \--libname : Show library name along with function name. +\--srcline +: Show source location of each function if available. + +\--format=*TYPE* +: Show format style output. Currently, normal and html styles are supported. + \--no-args : Do not show function arguments and return value.