Merge pull request #1592 from vim-jp/hh-update-terminal

Update terminal.{txt,jax}

doc/terminal.jax

@@ -1,4 +1,4 @@
-*terminal.txt*	For Vim バージョン 9.1.  Last change: 2024 Jun 13
+*terminal.txt*	For Vim バージョン 9.1.  Last change: 2024 Jun 20
 
 
 		VIMリファレンスマニュアル    by Bram Moolenaar
@@ -641,7 +641,7 @@ term_getjob({buf})					*term_getjob()*
 		端末ウィンドウ {buf} に関連付いたジョブを取得する。
 		{buf} の扱いについては |term_getsize()| と同じ。
 		ジョブがない場合は |v:null| を返す。Vim9 script では、ジョブが
-		ない場合 null_job を返す。
+		ない場合 |null_job| を返す。
 
 		|method| としても使用できる: >
 			GetBufnr()->term_getjob()
@@ -1272,6 +1272,15 @@ debugPC を使ってサインが利用されます。
 2つのウィンドウが閉じられます。
 
 一度にアクティブにできるデバッガは1つだけです。
+
+						*termdebug-timeout*
+gdb の起動方法によっては、termdebug の起動時間が異なる場合があります。
+gdb の起動プロセスに時間が掛かりすぎる場合に termdebug が停止しないように、設
+定可能なタイムアウトが含まれています。このタイムアウトは、10 ミリ秒の倍数で設
+定できます: >
+    let g:termdebug_config['timeout'] = 500 # 500 * 10 ミリ秒 = 5 秒。
+
+デフォルトのタイムアウトは 3000 ミリ秒です。
 							*:TermdebugCommand*
 デバッグ中のコマンドに特定のコマンドを与える場合は、`:TermdebugCommand` コマン
 ドの後にコマンド名と追加パラメータを使用できます。 >
@@ -1370,8 +1379,8 @@ gdb ウィンドウにフォーカスを移しコマンドを入力します。
 
 						*:Run* *:Arguments*
 ソースコードを表示するウィンドウで、これらのコマンドをgdbの制御に使用できます:
- :Run [args]	    [args] または以前の引数でプログラムを実行する
- :Arguments {args}  次の `:Run` のために引数を設定する
+ `:Run` [args]	    [args] または以前の引数でプログラムを実行する
+ `:Arguments` {args}  次の `:Run` のために引数を設定する
  *:Break*	カーソル位置にブレークポイントを設定する
  :Break {position}
 		指定位置にブレークポイントを設定する
@@ -1416,25 +1425,25 @@ gdbは各ブレークポイントに番号を与えます。Vim内では、赤
 
 変数を検査する ~
 					*termdebug-variables* *:Evaluate*
- :Evaluate          カーソルの下の式を評価する
- K                  上に同じ (無効にする場合は |termdebug_map_K| を参照)
- :Evaluate {expr}   {expr} を評価する
- :'<,'>Evaluate     ビジュアル選択したテキストを評価する
+ `:Evaluate`          カーソルの下の式を評価する
+ `K`                  上に同じ (無効にする場合は |termdebug_map_K| を参照)
+ `:Evaluate` {expr}   {expr} を評価する
+ `:'<,'>Evaluate`     ビジュアル選択したテキストを評価する
 
 これは gdb ウィンドウで "print" コマンドを使ったのに相当します。
 `:Evaluate` は `:Ev` に短縮できます。
 
 
 スタックフレームの移動 ~
 				*termdebug-frames* *:Frame* *:Up* *:Down*
- :Frame [frame]		フレームを選択する。[frame] は、フレーム番号、アドレ
+ `:Frame` [frame]	フレームを選択する。[frame] は、フレーム番号、アドレ
 			ス、または関数名 (デフォルト: カレントフレーム)
- :Up [count]		[count] フレーム上へ (デフォルト: 1; カレントを呼び出
+ `:Up` [count]		[count] フレーム上へ (デフォルト: 1; カレントを呼び出
 			したフレーム)
- +			同上 (無効にするには |termdebug_map_plus| を参照)
- :Down [count]		[count] フレーム下へ (デフォルト: 1; カレントによって
+ `+`			同上 (無効にするには |termdebug_map_plus| を参照)
+ `:Down` [count]	[count] フレーム下へ (デフォルト: 1; カレントによって
 			呼び出されるフレーム)
- -			同上 (無効にするには |termdebug_map_minus| を参照)
+ `-`			同上 (無効にするには |termdebug_map_minus| を参照)
 
 
 その他のコマンド ~
@@ -1509,6 +1518,10 @@ g:termdebug_config がない場合は、以下を使用できます: >
 	let g:termdebug_use_prompt = 1
 <
 マッピング ~
+termdebug プラグインは、いくつかのデフォルトマッピングを有効にします。
+termdebug セッションが終了すると、これらのマッピングはすべて元の値にリセットさ
+れます。
+
 					*termdebug_map_K* *termdebug-mappings*
 K へのバッファローカル (|:map-local|) マッピングがすでに存在している場合を除
 き、K キーは通常 |:Evaluate| にマップされています。これが不要な場合は: >

en/terminal.txt

@@ -1,4 +1,4 @@
-*terminal.txt*	For Vim version 9.1.  Last change: 2024 Jun 13
+*terminal.txt*	For Vim version 9.1.  Last change: 2024 Jun 20
 
 
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
@@ -648,7 +648,7 @@ term_getjob({buf})					*term_getjob()*
 		Get the Job associated with terminal window {buf}.
 		{buf} is used as with |term_getsize()|.
 		Returns |v:null| when there is no job. In Vim9 script, return
-		null_job when there is no job.
+		|null_job| when there is no job.
 
 		Can also be used as a |method|: >
 			GetBufnr()->term_getjob()
@@ -1283,6 +1283,15 @@ When the debugger ends, typically by typing "quit" in the gdb window, the two
 opened windows are closed.
 
 Only one debugger can be active at a time.
+
+						*termdebug-timeout*
+Depending on how gdb is launched, termdebug startup time may vary.
+To avoid termdebug to get stuck if the startup process of gdb takes too long,
+a configurable timeout is included. Such time out is configurable in terms of
+multiple of 10ms: >
+    let g:termdebug_config['timeout'] = 500 # 500 * 10ms = 5 seconds.
+
+The default timeout is 3000 ms.
 							*:TermdebugCommand*
 If you want to give specific commands to the command being debugged, you can
 use the `:TermdebugCommand` command followed by the command name and
@@ -1383,8 +1392,8 @@ Put focus on the gdb window to type commands there.  Some common ones are:
 						*:Run* *:Arguments*
 In the window showing the source code these commands can be used to control
 gdb:
- :Run [args]	    run the program with [args] or the previous arguments
- :Arguments {args}  set arguments for the next `:Run`
+ `:Run` [args]	    run the program with [args] or the previous arguments
+ `:Arguments` {args}  set arguments for the next `:Run`
 
  *:Break*	set a breakpoint at the cursor position
  :Break {position}
@@ -1430,25 +1439,25 @@ breakpoint, or use the "Clear breakpoint" right-click menu entry.
 
 Inspecting variables ~
 					*termdebug-variables* *:Evaluate*
- :Evaluate	    evaluate the expression under the cursor
- K		    same (see |termdebug_map_K| to disable)
- :Evaluate {expr}   evaluate {expr}
- :'<,'>Evaluate     evaluate the Visually selected text
+ `:Evaluate`	    evaluate the expression under the cursor
+ `K`		    same (see |termdebug_map_K| to disable)
+ `:Evaluate` {expr}   evaluate {expr}
+ `:'<,'>Evaluate`     evaluate the Visually selected text
 
 This is similar to using "print" in the gdb window.
 You can usually shorten `:Evaluate` to `:Ev`.
 
 
 Navigating stack frames ~
 				*termdebug-frames* *:Frame* *:Up* *:Down*
- :Frame [frame]	select frame [frame], which is a frame number,
+ `:Frame` [frame]	select frame [frame], which is a frame number,
 			address, or function name (default: current frame)
- :Up [count]		go up [count] frames (default: 1; the frame that
+ `:Up` [count]		go up [count] frames (default: 1; the frame that
 			called the current)
- +			same (see |termdebug_map_plus| to disable)
- :Down [count]	go down [count] frames (default: 1; the frame called
+ `+`			same (see |termdebug_map_plus| to disable)
+ `:Down` [count]	go down [count] frames (default: 1; the frame called
 			by the current)
- -			same (see |termdebug_map_minus| to disable)
+ `-`			same (see |termdebug_map_minus| to disable)
 
 
 Other commands ~
@@ -1524,6 +1533,9 @@ If there is no g:termdebug_config you can use: >
 	let g:termdebug_use_prompt = 1
 <
 Mappings ~
+The termdebug plugin enables a few default mappings.  All those mappings
+are reset to their original values once the termdebug session concludes.
+
 					*termdebug_map_K* *termdebug-mappings*
 The K key is normally mapped to |:Evaluate| unless a buffer local (|:map-local|)
 mapping to K already exists.  If you do not want this use: >