mirror of
https://github.com/fish-shell/fish-shell
synced 2024-12-29 14:23:09 +00:00
38b24c2325
This makes it so we link to the very top of the document instead of a special anchor we manually include. So clicking e.g. :doc:`string <cmds/string>` will link you to cmds/string.html instead of cmds/string.html#cmd-string. I would love to have a way to say "this document from the root of the document path", but that doesn't appear to work, I tried `/cmds/string`. So we'll just have to use cmds/string in normal documents and plain `string` from other commands.
41 lines
1.1 KiB
ReStructuredText
41 lines
1.1 KiB
ReStructuredText
.. _cmd-fish_breakpoint_prompt:
|
|
|
|
fish_breakpoint_prompt - define the prompt when stopped at a breakpoint
|
|
=======================================================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
fish_breakpoint_prompt
|
|
|
|
::
|
|
|
|
function fish_breakpoint_prompt
|
|
...
|
|
end
|
|
|
|
|
|
Description
|
|
-----------
|
|
|
|
``fish_breakpoint_prompt`` is the prompt function when asking for input in response to a :doc:`breakpoint <breakpoint>` command.
|
|
|
|
The exit status of commands within ``fish_breakpoint_prompt`` will not modify the value of :ref:`$status <variables-status>` outside of the ``fish_breakpoint_prompt`` function.
|
|
|
|
``fish`` ships with a default version of this function that displays the function name and line number of the current execution context.
|
|
|
|
|
|
Example
|
|
-------
|
|
|
|
A simple prompt that is a simplified version of the default debugging prompt::
|
|
|
|
function fish_breakpoint_prompt -d "Write out the debug prompt"
|
|
set -l function (status current-function)
|
|
set -l line (status current-line-number)
|
|
set -l prompt "$function:$line >"
|
|
echo -ns (set_color $fish_color_status) "BP $prompt" (set_color normal) ' '
|
|
end
|
|
|