Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-12-27 05:13:10 +00:00
Code Issues Projects Releases Packages Wiki Activity
fish-shell/doc_src/cmds/fish_hg_prompt.rst

68 lines
2.1 KiB
ReStructuredText
Raw Normal View History

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_hg_prompt:
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 15:51:00 +00:00
fish_hg_prompt - output Mercurial information for use in a prompt
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
=================================================================
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance.
2019-09-17 09:59:04 +00:00
Synopsis
--------
docs synopsis: add HTML highlighing and automate manpage markup Recent synopsis changes move from literal code blocks to [RST line blocks]. This does not translate well to HTML: it's not rendered in monospace, so aligment is lost. Additionally, we don't get syntax highlighting in HTML, which adds differences to our code samples which are highlighted. We hard-wrap synopsis lines (like code blocks). To align continuation lines in manpages we need [backslashes in weird places]. Combined with the **, *, and `` markup, it's a bit hard to get the alignment right. Fix these by moving synopsis sources back to code blocks and compute HTML syntax highlighting and manpage markup with a custom Sphinx extension. The new Pygments lexer can tokenize a synopsis and assign the various highlighting roles, which closely matches fish's syntax highlighing: - command/keyword (dark blue) - parameter (light blue) - operator like and/or/not/&&/|| (cyan) - grammar metacharacter (black) For manpage output, we don't project the fish syntax highlighting but follow the markup convention in GNU's man(1): bold text type exactly as shown. italic text replace with appropriate argument. To make it easy to separate these two automatically, formalize that (italic) placeholders must be uppercase; while all lowercase text is interpreted literally (so rendered bold). This makes manpages more consistent, see string-join(1) and and(1). Implementation notes: Since we want manpage formatting but Sphinx's Pygments highlighing plugin does not support manpage output, add our custom "synopsis" directive. This directive parses differently when manpage output is specified. This means that the HTML and manpage build processes must not share a cache, because the parsed doctrees are cached. Work around this by using separate cache locations for build targets "sphinx-docs" (which creates HTML) and "sphinx-manpages". A better solution would be to only override Sphinx's ManualPageBuilder but that would take a bit more code (ideally we could override ManualPageWriter but Sphinx 4.3.2 doesn't really support that). --- Alternative solution: stick with line blocks but use roles like :command: or :option: (or custom ones). While this would make it possible to produce HTML that is consistent with code blocks (by adding a bit of CSS), the source would look uglier and is harder to maintain. (Let's say we want to add custom formatting to the [|] metacharacters in HTML. This is much easier with the proposed patch.) --- [RST line blocks]: https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#line-blocks [backslashes in weird places]: https://github.com/fish-shell/fish-shell/pull/8626#discussion_r782837750
2022-01-09 14:09:46 +00:00
.. synopsis::
fish_hg_prompt
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance.
2019-09-17 09:59:04 +00:00
::
function fish_prompt
Synopses examples for vcs services now function as intended
2020-10-02 21:36:29 +00:00
printf '%s' $PWD (fish_hg_prompt) ' $ '
docs: update all command synopsis formatting Adds synopses for those commands missing them. Moves all synopsis sections to code blocks. This improves the appearance, although highlighting as fish code may not be the ideal appearance.
2019-09-17 09:59:04 +00:00
end
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
Description
-----------
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 15:51:00 +00:00
The fish_hg_prompt function displays information about the current Mercurial repository, if any.
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 15:51:00 +00:00
`Mercurial <https://www.mercurial-scm.org/>`_ (``hg``) must be installed.
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
Fixed sentence in `fish_hg_prompt` docs
2020-12-28 14:11:53 +00:00
By default, only the current branch is shown because ``hg status`` can be slow on a large repository. You can enable a more informative prompt by setting the variable ``$fish_prompt_hg_show_informative_status``, for example::
Make default hg prompt leaner The default hg prompt is slow on large repositories (hg status takes 2-3 seconds on mozilla-central) which is unacceptable as a default. Mimick our git prompt: by default, only show the current branch. If the new variable $fish_prompt_hg_show_informative_status is set, then use the old behavior. [ci skip]
2020-03-07 12:01:03 +00:00
math.rst: use 4 spaces instead of a tab for indentation I personally prefer tabs but we always use spaces, so this is much less surprising.
2022-01-09 11:26:18 +00:00
set --universal fish_prompt_hg_show_informative_status
Make default hg prompt leaner The default hg prompt is slow on large repositories (hg status takes 2-3 seconds on mozilla-central) which is unacceptable as a default. Mimick our git prompt: by default, only show the current branch. If the new variable $fish_prompt_hg_show_informative_status is set, then use the old behavior. [ci skip]
2020-03-07 12:01:03 +00:00
If you enabled the informative status, there are numerous customization options, which can be controlled with fish variables.
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 15:51:00 +00:00
- ``$fish_color_hg_clean``, ``$fish_color_hg_modified`` and ``$fish_color_hg_dirty`` are colors used when the repository has the respective status.
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
Some colors for status symbols:
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 15:51:00 +00:00
- ``$fish_color_hg_added``
- ``$fish_color_hg_renamed``
- ``$fish_color_hg_copied``
- ``$fish_color_hg_deleted``
- ``$fish_color_hg_untracked``
- ``$fish_color_hg_unmerged``
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 15:51:00 +00:00
The status symbols themselves:
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 15:51:00 +00:00
- ``$fish_prompt_hg_status_added``, default '✚'
- ``$fish_prompt_hg_status_modified``, default '*'
- ``$fish_prompt_hg_status_copied``, default '⇒'
- ``$fish_prompt_hg_status_deleted``, default '✖'
- ``$fish_prompt_hg_status_untracked``, default '?'
- ``$fish_prompt_hg_status_unmerged``, default '!'
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
docs: update the VCS prompt function documentation Edited for clarity and formatting. [ci skip]
2019-04-11 15:51:00 +00:00
Finally, ``$fish_prompt_hg_status_order``, which can be used to change the order the status symbols appear in. It defaults to ``added modified copied deleted untracked unmerged``.
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
docs: Use :doc: role when linking to commands 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.
2022-09-23 17:57:49 +00:00
See also :doc:`fish_vcs_prompt <fish_vcs_prompt>`, which will call all supported version control prompt functions, including git, Mercurial and Subversion.
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
Example
-------
A simple prompt that displays hg info::
function fish_prompt
...
Make default hg prompt leaner The default hg prompt is slow on large repositories (hg status takes 2-3 seconds on mozilla-central) which is unacceptable as a default. Mimick our git prompt: by default, only show the current branch. If the new variable $fish_prompt_hg_show_informative_status is set, then use the old behavior. [ci skip]
2020-03-07 12:01:03 +00:00
set -g fish_prompt_hg_show_informative_status
Add the vcs prompts to sphinx docs
2019-02-25 00:20:25 +00:00
printf '%s %s$' $PWD (fish_hg_prompt)
end
Reference in a new issue Copy permalink