fish-shell/doc_src/cmds/fish_breakpoint_prompt.rst

.. _cmd-fish_breakpoint_prompt:

fish_breakpoint_prompt - define the prompt when stopped at a breakpoint
=======================================================================

Synopsis
--------

| **function** *fish_breakpoint_prompt*
|   ...
| end


Description
-----------

``fish_breakpoint_prompt`` is the prompt function when asking for input in response to a :ref:`breakpoint <cmd-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
docs: Add labels to all commands This allows us to use :ref: references, which don't require hardcoding it as html [ci skip] 2019-03-31 09:05:09 +00:00			`.. _cmd-fish_breakpoint_prompt:`

Clean up fish_breakpoint_prompt sphinx docs 2019-02-25 00:11:07 +00:00			`fish_breakpoint_prompt - define the prompt when stopped at a breakpoint`
			`=======================================================================`
Switch command docs from \section to reStructuredText 2018-12-17 01:39:33 +00:00
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00			`Synopsis`
			`--------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Commit doc_src progress. This is continuing the work I've been doing to remove the :: formatting for the synopsis sections of our manual pages. 2021-12-17 21:58:38 +00:00			`\| function fish_breakpoint_prompt`
			`\| ...`
			`\| end`
Migrate the 'synopsis' sections to .rst format 2018-12-18 01:58:24 +00:00
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Description`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-----------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
docs: Less "the user", more "you" The person reading this is "you". It's completely okay and sounds better to address them directly. When we're talking about OS users or users of fish script the reader writes, "the user" is still okay. [ci skip] 2020-09-18 14:51:14 +00:00			``fish_breakpoint_prompt`` is the prompt function when asking for input in response to a :ref:`breakpoint <cmd-breakpoint>` command.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Fix broken links to index.html in cmd docs 2020-01-31 03:38:56 +00:00			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.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Switch backticks to double backticks for rst compatibility 2018-12-19 20:02:45 +00:00			``fish`` ships with a default version of this function that displays the function name and line number of the current execution context.
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00

Convert \\subsection sections into rst format 2018-12-19 02:44:30 +00:00			`Example`
Fix command section separator line lengths 2019-01-03 04:10:47 +00:00			`-------`
Copy doc_src to sphinx_doc_src and add a TOC 2018-12-16 21:08:41 +00:00
Clean up fish_breakpoint_prompt sphinx docs 2019-02-25 00:11:07 +00:00			`A simple prompt that is a simplified version of the default debugging prompt::`
Switch \fish sections to rst format 2018-12-19 03:14:04 +00:00
			`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`