fish-shell/doc_src/cmds
Ethel Morgan 5a0aa7824f Saturate exit codes to 255 for all builtins
After commit 6dd6a57c60, 3 remaining
builtins were affected by uint8_t overflow: `exit`, `return`, and
`functions --query`.

This commit:
- Moves the overflow check from `builtin_set_query` to `builtin_run`.
- Removes a conflicting int -> uint8_t conversion in `builtin_return`.
- Adds tests for the 3 remaining affected builtins.
- Simplifies the wording for the documentation for `set --query`.
- Does not change documentation for `functions --query`, because it does
  not state the exit code in its API.
- Updates the CHANGELOG to reflect the change to all builtins.
2021-02-13 08:41:51 +01:00
..
_.rst Add an "_" builtin to call into gettext (#7036) 2020-05-29 20:53:44 +02:00
abbr.rst Update docs for multi-erase in abbr and set 2020-10-04 12:39:32 +02:00
alias.rst docs: Make more code lines shorter 2021-02-02 08:35:38 +01:00
and.rst doc: add interlinks between true ←→ false and and ←→ or cmds 2020-02-23 23:41:16 -08:00
argparse.rst Fix sphinx doc warning 2021-02-05 11:07:58 +01:00
begin.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
bg.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
bind.rst docs: Fix link in bind 2021-02-05 20:19:28 +01:00
block.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
break.rst doc: add interlinks between break and continue commands 2020-03-09 19:24:38 +01:00
breakpoint.rst doc: homogenize commands titles 2020-04-04 10:44:53 +02:00
builtin.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
case.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
cd.rst doc: add section about directory history / stack 2020-04-18 10:40:48 +02:00
cdh.rst doc: add section about directory history / stack 2020-04-18 10:40:48 +02:00
command.rst Let command, jobs and type take --query instead of --quiet 2020-09-04 16:55:09 +02:00
commandline.rst docs: use monospace for inline code snippets more consistently 2020-10-26 19:25:41 +01:00
complete.rst docs: Fix markup for code blocks 2020-10-10 21:49:33 +02:00
contains.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
continue.rst doc: add interlinks between break and continue commands 2020-03-09 19:24:38 +01:00
count.rst docs: Make more code lines shorter 2021-02-02 08:35:38 +01:00
dirh.rst doc: add section about directory history / stack 2020-04-18 10:40:48 +02:00
dirs.rst doc: add section about directory history / stack 2020-04-18 10:40:48 +02:00
disown.rst docs: Link builtins 2020-03-21 15:31:25 +01:00
echo.rst docs: Use \ instead of \\ in examples (#7286) 2020-08-26 18:29:03 +02:00
else.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
emit.rst doc: homogenize commands titles 2020-04-04 10:44:53 +02:00
end.rst doc: homogenize commands titles 2020-04-04 10:44:53 +02:00
eval.rst doc: add links to 'source' command from 'eval' and 'functions' 2020-03-21 13:21:38 +01:00
exec.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
exit.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
false.rst doc: add interlinks between true ←→ false and and ←→ or cmds 2020-02-23 23:41:16 -08:00
fg.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
fish.rst Add a separate --profile-startup option to profile startup 2021-01-29 20:46:34 +01:00
fish_add_path.rst docs: Fix markup for code blocks 2020-10-10 21:49:33 +02:00
fish_breakpoint_prompt.rst docs: Less "the user", more "you" 2020-09-18 16:53:59 +02:00
fish_command_not_found.rst Call "fish_command_not_found" if a command wasn't found 2020-09-06 11:15:54 +02:00
fish_config.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
fish_git_prompt.rst docs: use monospace for inline code snippets more consistently 2020-10-26 19:25:41 +01:00
fish_greeting.rst docs: Add fish_title and fish_greeting 2020-10-28 17:44:45 +01:00
fish_hg_prompt.rst Fixed sentence in fish_hg_prompt docs 2020-12-28 19:39:27 +01:00
fish_indent.rst fish_indent: Change --debug-level to --debug with flog categories 2020-12-14 19:36:18 +01:00
fish_is_root_user.rst Fix paste-o that duplicated documentation header. 2020-06-30 23:45:41 +02:00
fish_key_reader.rst docs: Add completions for fish_key_reader 2020-04-19 07:06:31 +02:00
fish_mode_prompt.rst docs: link and explicit instructions on creating a blank fish_mode_prompt 2020-06-06 22:52:13 +08:00
fish_opt.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
fish_prompt.rst docs: Update example prompt in fish_prompt docs 2020-10-02 19:02:10 +02:00
fish_right_prompt.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
fish_status_to_signal.rst Remove dunderscores from __fish_status_to_signal (#7597) 2021-01-03 15:15:57 +01:00
fish_svn_prompt.rst Synopses examples for vcs services now function as intended 2020-10-02 23:45:38 +02:00
fish_title.rst docs: Add fish_title and fish_greeting 2020-10-28 17:44:45 +01:00
fish_update_completions.rst doc: homogenize commands titles 2020-04-04 10:44:53 +02:00
fish_vcs_prompt.rst Synopses examples for vcs services now function as intended 2020-10-02 23:45:38 +02:00
for.rst doc: homogenize commands titles 2020-04-04 10:44:53 +02:00
funced.rst docs: Fix spacing on key combinations 2020-03-21 13:20:34 +01:00
funcsave.rst Funcsave with --directory option (#7041) 2020-05-27 20:13:44 +02:00
function.rst Call "fish_command_not_found" if a command wasn't found 2020-09-06 11:15:54 +02:00
functions.rst correct description of -a param regarding _(\w*) 2020-09-08 18:02:50 +02:00
help.rst docs: Link builtins 2020-03-21 15:31:25 +01:00
history.rst history.rst: clarify that "history search" is the default command 2020-08-04 21:44:26 +02:00
if.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
isatty.rst docs/isatty: Mention default value for FILE DESCRIPTOR 2020-09-05 15:54:48 +02:00
jobs.rst Let command, jobs and type take --query instead of --quiet 2020-09-04 16:55:09 +02:00
math.rst math: Add --base option 2020-11-27 19:33:27 +01:00
nextd.rst doc: add section about directory history / stack 2020-04-18 10:40:48 +02:00
not.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
open.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
or.rst doc: add interlinks between true ←→ false and and ←→ or cmds 2020-02-23 23:41:16 -08:00
popd.rst doc: add section about directory history / stack 2020-04-18 10:40:48 +02:00
prevd.rst doc: add section about directory history / stack 2020-04-18 10:40:48 +02:00
printf.rst docs: use monospace for inline code snippets more consistently 2020-10-26 19:25:41 +01:00
prompt_pwd.rst doc: homogenize commands titles 2020-04-04 10:44:53 +02:00
psub.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
pushd.rst doc: add section about directory history / stack 2020-04-18 10:40:48 +02:00
pwd.rst doc: add section about directory history / stack 2020-04-18 10:40:48 +02:00
random.rst docs: Reword random 2020-09-10 20:48:13 +02:00
read.rst docs: Remove references to read history 2021-02-02 09:42:57 +01:00
realpath.rst fish_add_path: Don't resolve symlinks 2020-09-12 19:28:01 +02:00
return.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
set.rst Saturate exit codes to 255 for all builtins 2021-02-13 08:41:51 +01:00
set_color.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
source.rst docs: don't quote code snippets 2020-04-13 22:56:22 +02:00
status.rst Add status dirname and status basename convenience commands 2020-06-04 18:23:32 +02:00
string-collect.rst Fix string collect examples 2020-06-07 19:33:27 +02:00
string-escape.rst docs: Use \ instead of \\ in examples (#7286) 2020-08-26 18:29:03 +02:00
string-join.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string-join0.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string-length.rst Fix example in string length docs 2020-09-27 21:59:15 +02:00
string-lower.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string-match.rst string match: reword the named capture group documentation 2021-01-08 21:16:07 +08:00
string-pad.rst Improve string pad examples and add a cross-reference 2020-09-28 18:42:02 +02:00
string-repeat.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string-replace.rst docs: Use \ instead of \\ in examples (#7286) 2020-08-26 18:29:03 +02:00
string-split.rst docs: Use \ instead of \\ in examples (#7286) 2020-08-26 18:29:03 +02:00
string-split0.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string-sub.rst Add string sub --end (#6765) 2020-03-22 15:53:09 +01:00
string-trim.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string-unescape.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string-upper.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
string.rst string: Quit early if --quiet is satisfied 2020-12-01 18:55:01 +01:00
suspend.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
switch.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
test.rst Doc: Fix dead link to POSIX man page "test". 2020-04-19 04:25:04 +02:00
time.rst docs: use monospace for inline code snippets more consistently 2020-10-26 19:25:41 +01:00
trap.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
true.rst doc: add interlinks between true ←→ false and and ←→ or cmds 2020-02-23 23:41:16 -08:00
type.rst Let command, jobs and type take --query instead of --quiet 2020-09-04 16:55:09 +02:00
ulimit.rst docs: Link builtins 2020-03-21 15:31:25 +01:00
umask.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
vared.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
wait.rst We no longer have two doc systems, move sphinx_doc_src back to doc_src 2020-02-19 17:00:35 -08:00
while.rst docs: Make more code lines shorter 2021-02-02 08:35:38 +01:00