Skip to content

Commit f036450

Browse files
committed
Document true, false, and pwd as substitutive built-ins
This commit updates the documentation to reflect the change of the type of the built-ins performed in: #124
1 parent d6def52 commit f036450

12 files changed

+27
-24
lines changed

NEWS

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
suspended if job-control is on. The built-in now waits for the
1818
target process to exit or be terminated by a signal regardless
1919
of mode.
20+
- The `true`, `false`, and `pwd` built-ins are now substitutive
21+
built-ins.
2022
- [line-editing] Updated the completion scripts to support Git
2123
2.48.1.
2224
- [line-editing] Added the completion script for `git-mv`.

NEWS.ja

+1
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- ジョブ制御が有効なとき `wait` 組込みはジョブが停止しても待機し
1515
続けるようになった。これで、`wait` 組込みはモードに関係なく
1616
ジョブが終了するまで待機するようになった
17+
- `true`, `false`, `pwd` を代替組込みコマンドに変更
1718
- [行編集] 補完スクリプトを Git 2.48.1 相当に更新
1819
- [行編集] git-mv の補完を追加
1920
- 対話シェルで `read` 組込みが入力を読み込む際にクラッシュすることが

doc/_colon.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@ The colon built-in is a link:builtin.html#types[special built-in].
2929
Arguments are link:expand.html[expanded] and link:redir.html[redirections] are
3030
performed as usual.
3131
The colon and link:_true.html[true] built-ins have the same effect, but colon
32-
is a special built-in while true is a mandatory.
32+
is a special built-in while true is a substitutive.
3333

3434
// vim: set filetype=asciidoc textwidth=78 expandtab:

doc/_false.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,6 @@ The exit status of the false built-in is non-zero.
2424
[[notes]]
2525
== Notes
2626

27-
The false built-in is a link:builtin.html#types[mandatory built-in].
27+
The false built-in is a link:builtin.html#types[substitutive built-in].
2828

2929
// vim: set filetype=asciidoc textwidth=78 expandtab:

doc/_pwd.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,6 @@ The exit status of the pwd built-in is zero unless there is any error.
4343
[[notes]]
4444
== Notes
4545

46-
The pwd built-in is a link:builtin.html#types[mandatory built-in].
46+
The pwd built-in is a link:builtin.html#types[substitutive built-in].
4747

4848
// vim: set filetype=asciidoc textwidth=78 expandtab:

doc/_true.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ The exit status of the true built-in is zero.
2424
[[notes]]
2525
== Notes
2626

27-
The true built-in is a link:builtin.html#types[mandatory built-in].
27+
The true built-in is a link:builtin.html#types[substitutive built-in].
2828

2929
The true and link:_colon.html[colon] built-ins have the same effect, but true
30-
is a mandatory built-in while colon is a special.
30+
is a substitutive built-in while colon is a special.
3131

3232
// vim: set filetype=asciidoc textwidth=78 expandtab:

doc/index.txt.in

+7-7
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Substitutive built-ins are not marked.
4444
- link:_exec.html[+exec+] (S)
4545
- link:_exit.html[+exit+] (S)
4646
- link:_export.html[+export+] (S)
47-
- link:_false.html[+false+] (M)
47+
- link:_false.html[+false+]
4848
- link:_fc.html[+fc+] (M)
4949
- link:_fg.html[+fg+] (M)
5050
- link:_getopts.html[+getopts+] (M)
@@ -57,7 +57,7 @@ Substitutive built-ins are not marked.
5757
- link:_popd.html[+popd+] (L)
5858
- link:_printf.html[+printf+]
5959
- link:_pushd.html[+pushd+] (L)
60-
- link:_pwd.html[+pwd+] (M)
60+
- link:_pwd.html[+pwd+]
6161
- link:_read.html[+read+] (M)
6262
- link:_readonly.html[+readonly+] (S)
6363
- link:_return.html[+return+] (S)
@@ -67,7 +67,7 @@ Substitutive built-ins are not marked.
6767
- link:_test.html[+test+]
6868
- link:_times.html[+times+] (S)
6969
- link:_trap.html[+trap+] (S)
70-
- link:_true.html[+true+] (M)
70+
- link:_true.html[+true+]
7171
- link:_type.html[+type+] (M)
7272
- link:_typeset.html[+typeset+] (L)
7373
- link:_ulimit.html[+ulimit+] (M)
@@ -103,7 +103,7 @@ Substitutive built-ins are not marked.
103103
- link:_umask.html[+umask+] (M)
104104
- link:_trap.html[+trap+] (S)
105105
- link:_cd.html[+cd+] (M)
106-
- link:_pwd.html[+pwd+] (M)
106+
- link:_pwd.html[+pwd+]
107107
- link:_times.html[+times+] (S)
108108

109109
[[g-job]]
@@ -138,7 +138,7 @@ Substitutive built-ins are not marked.
138138

139139
[role="list-group"]
140140
- link:_cd.html[+cd+] (M)
141-
- link:_pwd.html[+pwd+] (M)
141+
- link:_pwd.html[+pwd+]
142142
- link:_pushd.html[+pushd+] (L)
143143
- link:_popd.html[+popd+] (L)
144144
- link:_dirs.html[+dirs+] (L)
@@ -177,8 +177,8 @@ Substitutive built-ins are not marked.
177177
[role="list-group"]
178178
- link:_help.html[+help+] (L)
179179
- link:_colon.html[+:+ (colon)] (S)
180-
- link:_true.html[+true+] (M)
181-
- link:_false.html[+false+] (M)
180+
- link:_true.html[+true+]
181+
- link:_false.html[+false+]
182182
- link:_test.html[+[+ (bracket), +test+]
183183
- link:_type.html[+type+] (M)
184184

doc/ja/_colon.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ dfn:[コロン組込みコマンド]は何も行わない組込みコマンド
2727

2828
引数の{zwsp}link:expand.html[展開]と{zwsp}link:redir.html[リダイレクト]は他のコマンドと同様に行います。
2929

30-
link:_true.html[True コマンド]はコロンコマンドと同様に何も行いませんが、コロンコマンドは特殊組込みコマンドであるのに対し true コマンドは必須組込みコマンドです
30+
link:_true.html[True コマンド]はコロンコマンドと同様に何も行いませんが、コロンコマンドは特殊組込みコマンドであるのに対し true コマンドは代替組込みコマンドです
3131

3232
// vim: set filetype=asciidoc expandtab:

doc/ja/_false.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,6 @@ False コマンドの終了ステータスは非 0 です。
2323
[[notes]]
2424
== 補足
2525

26-
False コマンドは{zwsp}link:builtin.html#types[必須組込みコマンド]です。
26+
False コマンドは{zwsp}link:builtin.html#types[代替組込みコマンド]です。
2727

2828
// vim: set filetype=asciidoc expandtab:

doc/ja/_pwd.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,6 @@ link:params.html#sv-pwd[+PWD+ 変数]の値が現在の作業ディレクトリ
3636
[[notes]]
3737
== 補足
3838

39-
Pwd コマンドは{zwsp}link:builtin.html#types[必須組込みコマンド]です。
39+
Pwd コマンドは{zwsp}link:builtin.html#types[代替組込みコマンド]です。
4040

4141
// vim: set filetype=asciidoc expandtab:

doc/ja/_true.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ True コマンドの終了ステータスは 0 です。
2323
[[notes]]
2424
== 補足
2525

26-
True コマンドは{zwsp}link:builtin.html#types[必須組込みコマンド]です。
26+
True コマンドは{zwsp}link:builtin.html#types[代替組込みコマンド]です。
2727

28-
link:_colon.html[コロンコマンド]は true コマンドと同様に何も行いませんが、true コマンドは必須組込みコマンドであるのに対しコロンコマンドは特殊組込みコマンドです
28+
link:_colon.html[コロンコマンド]は true コマンドと同様に何も行いませんが、true コマンドは代替組込みコマンドであるのに対しコロンコマンドは特殊組込みコマンドです
2929

3030
// vim: set filetype=asciidoc expandtab:

doc/ja/index.txt.in

+7-7
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ v{yashversion},
4343
- link:_exec.html[+exec+] (S)
4444
- link:_exit.html[+exit+] (S)
4545
- link:_export.html[+export+] (S)
46-
- link:_false.html[+false+] (M)
46+
- link:_false.html[+false+]
4747
- link:_fc.html[+fc+] (M)
4848
- link:_fg.html[+fg+] (M)
4949
- link:_getopts.html[+getopts+] (M)
@@ -56,7 +56,7 @@ v{yashversion},
5656
- link:_popd.html[+popd+] (L)
5757
- link:_printf.html[+printf+]
5858
- link:_pushd.html[+pushd+] (L)
59-
- link:_pwd.html[+pwd+] (M)
59+
- link:_pwd.html[+pwd+]
6060
- link:_read.html[+read+] (M)
6161
- link:_readonly.html[+readonly+] (S)
6262
- link:_return.html[+return+] (S)
@@ -66,7 +66,7 @@ v{yashversion},
6666
- link:_test.html[+test+]
6767
- link:_times.html[+times+] (S)
6868
- link:_trap.html[+trap+] (S)
69-
- link:_true.html[+true+] (M)
69+
- link:_true.html[+true+]
7070
- link:_type.html[+type+] (M)
7171
- link:_typeset.html[+typeset+] (L)
7272
- link:_ulimit.html[+ulimit+] (M)
@@ -102,7 +102,7 @@ v{yashversion},
102102
- link:_umask.html[+umask+] (M)
103103
- link:_trap.html[+trap+] (S)
104104
- link:_cd.html[+cd+] (M)
105-
- link:_pwd.html[+pwd+] (M)
105+
- link:_pwd.html[+pwd+]
106106
- link:_times.html[+times+] (S)
107107

108108
[[g-job]]
@@ -137,7 +137,7 @@ v{yashversion},
137137

138138
[role="list-group"]
139139
- link:_cd.html[+cd+] (M)
140-
- link:_pwd.html[+pwd+] (M)
140+
- link:_pwd.html[+pwd+]
141141
- link:_pushd.html[+pushd+] (L)
142142
- link:_popd.html[+popd+] (L)
143143
- link:_dirs.html[+dirs+] (L)
@@ -176,8 +176,8 @@ v{yashversion},
176176
[role="list-group"]
177177
- link:_help.html[+help+] (L)
178178
- link:_colon.html[+:+ (コロン)] (S)
179-
- link:_true.html[+true+] (M)
180-
- link:_false.html[+false+] (M)
179+
- link:_true.html[+true+]
180+
- link:_false.html[+false+]
181181
- link:_test.html[+[+ (括弧), +test+]
182182
- link:_type.html[+type+] (M)
183183

0 commit comments

Comments
 (0)