Skip to content

Commit

Permalink
doc: Update man pages for better sync up
Browse files Browse the repository at this point in the history
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] 5430d02 doc/ko: Add missing options in uftrace-replay.md
Signed-off-by: Honggyu Kim <[email protected]>
  • Loading branch information
honggyukim committed Sep 29, 2024
1 parent 5430d02 commit 4afc58f
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 14 deletions.
22 changes: 17 additions & 5 deletions doc/ko/uftrace-live.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) ๋ฐ์ดํ„ฐ๋ฅผ ์ฝ๋Š”๋‹ค.
Expand Down Expand Up @@ -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
Expand All @@ -264,6 +267,15 @@ REPLAY ์˜ต์…˜
\--libname
: ํ•จ์ˆ˜ ์ด๋ฆ„๊ณผ ํ•จ๊ป˜ ๋ผ์ด๋ธŒ๋Ÿฌ๋ฆฌ ์ด๋ฆ„์„ ์ถœ๋ ฅํ•œ๋‹ค.

\--srcline
: ๊ฐ€๋Šฅํ•œ ๊ฒฝ์šฐ ๊ฐ ํ•จ์ˆ˜์˜ ์†Œ์Šค ์œ„์น˜๋ฅผ ํ‘œ์‹œํ•œ๋‹ค.

\--format=*TYPE*
: ํ˜•์‹ํ™”๋œ ์ถœ๋ ฅ์„ ๋ณด์—ฌ์ค€๋‹ค. ํ˜„์žฌ๋Š” 'normal' ๊ณผ 'html' ํ˜•์‹์ด ์ง€์›๋œ๋‹ค.

\--no-args
: ํ•จ์ˆ˜ ์ธ์ž์™€ ๋ฐ˜ํ™˜๊ฐ’์„ ํ‘œ์‹œํ•˜์ง€ ์•Š๋Š”๋‹ค.


๊ณตํ†ต ๋ถ„์„ ์˜ต์…˜
=======================
Expand Down
7 changes: 5 additions & 2 deletions doc/ko/uftrace-record.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) ๋ฐ์ดํ„ฐ๋ฅผ ์ฝ๋Š”๋‹ค.
Expand Down
8 changes: 4 additions & 4 deletions doc/ko/uftrace-replay.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -116,7 +116,7 @@ REPLAY ์˜ต์…˜
๊ธฐ๋ณธ ์„ค์ •์€ `regex`์ด๋‹ค.

\--disable
: ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š๋Š”๋‹ค. ๋Œ€์‹  `--trace=off`๋ฅผ ์‚ฌ์šฉํ•œ๋‹ค.
: ๋” ์ด์ƒ ์‚ฌ์šฉ๋˜์ง€ ์•Š์œผ๋ฉฐ ๋Œ€์‹  `--trace=off` ๋ฅผ ์‚ฌ์šฉํ•  ์ˆ˜ ์žˆ๋‹ค.

\--trace=*STATE*
: uftrace ํŠธ๋ ˆ์ด์‹ฑ ์ƒํƒœ๋ฅผ ์„ค์ •ํ•œ๋‹ค. ๊ฐ€๋Šฅํ•œ ์ƒํƒœ๋Š” `on`๊ณผ `off`์ด๋ฉฐ ๊ธฐ๋ณธ๊ฐ’์€
Expand Down
12 changes: 9 additions & 3 deletions doc/uftrace-live.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand Down

0 comments on commit 4afc58f

Please sign in to comment.