2019-03-31 17:05:09 +08:00
.. _cmd-begin:
2018-12-17 09:39:33 +08:00
begin - start a new block of code
2019-01-03 12:10:47 +08:00
=================================
2018-12-17 09:39:33 +08:00
2018-12-18 09:58:24 +08:00
Synopsis
--------
2018-12-17 05:08:41 +08:00
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 22:09:46 +08:00
.. synopsis ::
begin; [COMMANDS ...]; end
2018-12-17 05:08:41 +08:00
2018-12-19 10:44:30 +08:00
Description
2019-01-03 12:10:47 +08:00
-----------
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
`` begin `` is used to create a new block of code.
2018-12-17 05:08:41 +08:00
2022-03-12 00:18:41 +08:00
A block allows the introduction of a new :ref: `variable scope <variables-scope>` , redirection of the input or output of a set of commands as a group, or to specify precedence when using the conditional commands like `` and `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
The block is unconditionally executed. `` begin; ...; end `` is equivalent to `` if true; ...; end `` .
2018-12-17 05:08:41 +08:00
2018-12-20 04:02:45 +08:00
`` begin `` does not change the current exit status itself. After the block has completed, `` $status `` will be set to the status returned by the most recent command.
2018-12-17 05:08:41 +08:00
2022-03-12 00:18:41 +08:00
The **-h** or **--help** option displays help about using this command.
2018-12-19 10:44:30 +08:00
Example
2019-01-03 12:10:47 +08:00
-------
2018-12-17 05:08:41 +08:00
The following code sets a number of variables inside of a block scope. Since the variables are set inside the block and have local scope, they will be automatically deleted when the block ends.
2018-12-19 11:14:04 +08:00
::
begin
set -l PIRATE Yarrr
...
end
echo $PIRATE
# This will not output anything, since the PIRATE variable
# went out of scope at the end of the block
2018-12-17 05:08:41 +08:00
In the following code, all output is redirected to the file out.html.
2018-12-19 11:14:04 +08:00
::
begin
echo $xml_header
echo $html_header
if test -e $file
...
end
2018-12-17 05:08:41 +08:00
...
2018-12-19 11:14:04 +08:00
end > out.html
