docs: update a bunch of since lines to new macro

zummenix · Mar 21, 2023 · 40081cb · 40081cb
1 parent 3b8551e
commit 40081cb
Show file tree

Hide file tree

Showing 381 changed files with 519 additions and 494 deletions.
diff --git a/ci/generate-docs.py b/ci/generate-docs.py
@@ -279,7 +279,7 @@ def scheme_link(name):
                         idx.write(f"Source: <{origin_url}><br/>\n")
                     version = scheme["metadata"].get("wezterm_version", None)
                     if version and version != "Always":
-                        idx.write(f"Since: *{version}*<br/>\n")
+                        idx.write(f"{{{{since('{version}')}}}}<br/>\n")
 
                     aliases = scheme["metadata"]["aliases"]
                     if len(aliases) > 1:

diff --git a/ci/update-doc-versions.py b/ci/update-doc-versions.py
@@ -0,0 +1,25 @@
+#!/usr/bin/env python3
+import glob
+import os
+import re
+import sys
+
+NIGHTLY = '20230320-124340-559cb7b0'
+
+NIGHTLY_UPDATE = re.compile('[Ss]ince: nightly builds only', re.MULTILINE)
+OLD_SINCE = re.compile('^\*[Ss]ince: (\\S+)\*', re.MULTILINE)
+OLD_SINCE_INLINE = re.compile('\(?\*?[Ss]ince: (\\S+)\*?\)?', re.MULTILINE)
+
+for p in ["docs/**/*.md", "docs/**/*.markdown"]:
+    for filename in glob.glob(p, recursive=True):
+        with open(filename, "r") as f:
+            content = f.read()
+
+        adjusted = NIGHTLY_UPDATE.sub(f"Since: {NIGHTLY}", content)
+        adjusted = OLD_SINCE.sub("{{since('\\1')}}", adjusted)
+        adjusted = OLD_SINCE_INLINE.sub("{{since('\\1', inline=True)}}", adjusted)
+        if content != adjusted:
+            print(filename)
+            with open(filename, "w") as f:
+                f.truncate()
+                f.write(adjusted)
diff --git a/docs/cli/cli/activate-pane-direction.md b/docs/cli/cli/activate-pane-direction.md
@@ -1,6 +1,6 @@
 # `wezterm cli activate-pane-direction DIRECTION`
 
-*Since: 20221119-145034-49b9839f*
+{{since('20221119-145034-49b9839f')}}
 
 *Run `wezterm cli activate-pane-direction --help` to see more help*
 

diff --git a/docs/cli/cli/list-clients.md b/docs/cli/cli/list-clients.md
@@ -20,7 +20,7 @@ The meanings of the fields are:
 * `WORKSPACE` - shows the active workspace for that session
 * `FOCUS` - shows the pane id of the pane that has focus in that session
 
-*Since: 20220624-141144-bd1b7c5d*
+{{since('20220624-141144-bd1b7c5d')}}
 
 You may request JSON output:
 

diff --git a/docs/cli/cli/list.md b/docs/cli/cli/list.md
@@ -22,7 +22,7 @@ Each row describes a pane.  The meaning of the fields are:
 * `TITLE` - the pane title
 * `CWD` - the current working directory associated with the pane
 
-*Since: 20220624-141144-bd1b7c5d*
+{{since('20220624-141144-bd1b7c5d')}}
 
 You may request JSON output:
 

diff --git a/docs/cli/cli/move-pane-to-new-tab.md b/docs/cli/cli/move-pane-to-new-tab.md
@@ -1,6 +1,6 @@
 # `wezterm cli move-pane-to-new-tab`
 
-*Since: 20220624-141144-bd1b7c5d*
+{{since('20220624-141144-bd1b7c5d')}}
 
 *Run `wezterm cli move-pane-to-new-tab --help` to see more help*
 

diff --git a/docs/cli/cli/send-text.md b/docs/cli/cli/send-text.md
@@ -21,5 +21,5 @@ $ echo hello there | wezterm cli send-text
 
 The following arguments modify the behavior:
 
-* `--no-paste` - Send the text directly, rather than as a bracketed paste. (*Since: 20220624-141144-bd1b7c5d*)
+* `--no-paste` - Send the text directly, rather than as a bracketed paste. {{since('20220624-141144-bd1b7c5d', inline=True)}}
 * `--pane-id` - Specifies which pane to send the text to. See also [Targeting Panes](index.md#targeting-panes).
diff --git a/docs/cli/show-keys.md b/docs/cli/show-keys.md
@@ -1,6 +1,6 @@
 # `wezterm show-keys`
 
-*Since: 20220624-141144-bd1b7c5d*
+{{since('20220624-141144-bd1b7c5d')}}
 
 
 Prints the complete set of key assignments based on your config file.

diff --git a/docs/config/appearance.md b/docs/config/appearance.md
@@ -36,7 +36,7 @@ The `color_scheme` option takes precedence over the `colors` section below,
 and is mutually exclusive with it. If you want to merge/override colors
 you need to use [wezterm.color.get_default_colors()](lua/wezterm.color/get_default_colors.md) and explicitly merge them.
 
-*Since: 20220903-194523-3bb1ed61*
+{{since('20220903-194523-3bb1ed61')}}
 
 The behavior has been changed so that the `color_scheme` you have selected, if
 any, is used to define the colors, and then any colors you define in the
@@ -135,7 +135,7 @@ config.colors = {
 return config
 ```
 
-*Since: 20220101-133340-7edc5b5a*
+{{since('20220101-133340-7edc5b5a')}}
 
 You may specify colors in the HSL color space, if you prefer that over RGB, by using:
 
@@ -151,7 +151,7 @@ config.colors = {
 }
 ```
 
-*Since: 20220319-142410-0fcdea07*
+{{since('20220319-142410-0fcdea07')}}
 
 Colors now also accept the following CSS-style color specifications:
 
@@ -404,7 +404,7 @@ You may add padding around the edges of the terminal area.
 
 ## Styling Inactive Panes
 
-*since: 20201031-154415-9614e117*
+{{since('20201031-154415-9614e117')}}
 
 To make it easier to see which pane is active, the inactive panes are dimmed
 and de-saturated slightly.
@@ -443,7 +443,7 @@ reduce it by half, and 2.0 will double the value.
 
 ![Screenshot](../screenshots/wezterm-vday-screenshot.png)
 
-*since: 20201031-154415-9614e117*
+{{since('20201031-154415-9614e117')}}
 
 You can attach an image to the background of the wezterm window:
 
@@ -490,7 +490,7 @@ behavior and more, take a look at the more power
 
 ## Window Background Gradient
 
-*Since: 20210814-124438-54e29167*
+{{since('20210814-124438-54e29167')}}
 
 ![Gradient](../screenshots/radial-gradient.png)
 
@@ -499,7 +499,7 @@ for configuration information on gradients.
 
 ## Window Background Opacity
 
-*since: 20201031-154415-9614e117*
+{{since('20201031-154415-9614e117')}}
 
 If your Operating System provides Compositing support then WezTerm is able to
 specify the alpha channel value for the background content, rendering the
@@ -524,7 +524,7 @@ config.window_background_opacity = 1.0
 
 ## Text Background Opacity
 
-*since: 20201031-154415-9614e117*
+{{since('20201031-154415-9614e117')}}
 
 When using a background image or background opacity, the image content can
 have relatively low contrast with respect to the text you are trying to

diff --git a/docs/config/default-keys.md b/docs/config/default-keys.md
@@ -11,7 +11,7 @@ in a form that you can copy and paste into your own configuration.
 | `CTRL+SHIFT`     | `v`   | `PasteFrom="Clipboard"`  |
 |      | `Copy`   | `CopyTo="Clipboard"`  |
 |      | `Paste`   | `PasteFrom="Clipboard"`  |
-| `CTRL`     | `Insert` | `CopyTo="PrimarySelection"` (*since: 20210203-095643-70a364eb*) |
+| `CTRL`     | `Insert` | `CopyTo="PrimarySelection"` {{since('20210203-095643-70a364eb', inline=True)}} |
 | `SHIFT`     | `Insert` | `PasteFrom="PrimarySelection"` |
 | `SUPER`     | `m`      | `Hide`  |
 | `SUPER`     | `n`      | `SpawnWindow` |
@@ -61,13 +61,13 @@ in a form that you can copy and paste into your own configuration.
 | `SUPER`          | `h`    | `HideApplication` (macOS only) |
 | `SUPER`          | `k`    | `ClearScrollback="ScrollbackOnly"` |
 | `CTRL+SHIFT`     | `K`    | `ClearScrollback="ScrollbackOnly"` |
-| `CTRL+SHIFT`     | `L`    | `ShowDebugOverlay` (*Since: 20210814-124438-54e29167*)|
-| `CTRL+SHIFT`     | `P`    | `PaneSelect` (*Since: 20220903-194523-3bb1ed61*)|
-| `CTRL+SHIFT`     | `U`    | `CharSelect` (*Since: 20220903-194523-3bb1ed61*)|
+| `CTRL+SHIFT`     | `L`    | `ShowDebugOverlay` {{since('20210814-124438-54e29167', inline=True)}}|
+| `CTRL+SHIFT`     | `P`    | `PaneSelect` {{since('20220903-194523-3bb1ed61', inline=True)}}|
+| `CTRL+SHIFT`     | `U`    | `CharSelect` {{since('20220903-194523-3bb1ed61', inline=True)}}|
 | `SUPER`          | `f`    | `Search={CaseSensitiveString=""}` |
 | `CTRL+SHIFT`     | `F`    | `Search={CaseSensitiveString=""}` |
 | `CTRL+SHIFT`     | `X`    | `ActivateCopyMode` |
-| `CTRL+SHIFT`     | `Space`| `QuickSelect` (*since: 20210502-130208-bff6815d*) |
+| `CTRL+SHIFT`     | `Space`| `QuickSelect` {{since('20210502-130208-bff6815d', inline=True)}} |
 | `CTRL+SHIFT+ALT` | `"`    | `SplitVertical={domain="CurrentPaneDomain"}` |
 | `CTRL+SHIFT+ALT` | `%`    | `SplitHorizontal={domain="CurrentPaneDomain"}` |
 | `CTRL+SHIFT+ALT` | `LeftArrow`    | `AdjustPaneSize={"Left", 1}` |

diff --git a/docs/config/files.md b/docs/config/files.md
@@ -86,7 +86,7 @@ to force the configuration to be reloaded.
 
 ### Configuration Overrides
 
-*since: 20210314-114017-04b7cedd*
+{{since('20210314-114017-04b7cedd')}}
 
 `wezterm` allows overriding configuration values via the command line; here are
 a couple of examples:

diff --git a/docs/config/font-shaping.md b/docs/config/font-shaping.md
@@ -36,7 +36,7 @@ and you can set them in wezterm:
 config.harfbuzz_features = { 'zero' }
 ```
 
-*Since: 20220101-133340-7edc5b5a*
+{{since('20220101-133340-7edc5b5a')}}
 
 You can specify `harfbuzz_features` on a per-font basis, rather than
 globally for all fonts:

diff --git a/docs/config/key-encoding.md b/docs/config/key-encoding.md
@@ -17,7 +17,7 @@ keypresses like `Control-I` to be ASCII Tab, as an example.
 
 ## xterm `modifyOtherKeys`
 
-*Since: 20221119-145034-49b9839f*
+{{since('20221119-145034-49b9839f')}}
 
 When wezterm receives the sequence `CSI >4;Nm`, where `N` is `0`, `1` or `2`,
 the keyboard encoding is changed according to

diff --git a/docs/config/key-tables.md b/docs/config/key-tables.md
@@ -1,4 +1,4 @@
-*Since: 20220408-101518-b908e2dd*
+{{since('20220408-101518-b908e2dd')}}
 
 In addition to the default key table defined by the `keys` configuration
 option, `wezterm` supports defining additional named key tables using the
@@ -120,7 +120,7 @@ The stack is also cleared when the configuration is reloaded, so if you're
 working on a complex key table setup and get stuck, you may be able to unstick
 yourself by re-saving your wezterm configuration to trigger a reload.
 
-*Since: 20220624-141144-bd1b7c5d*
+{{since('20220624-141144-bd1b7c5d')}}
 
 When resolving a key assignment, the top of stack is first searched for a match,
 and if one is not found, the next entry on the stack is searched and so on until a match is found.

diff --git a/docs/config/keyboard-concepts.md b/docs/config/keyboard-concepts.md
@@ -102,7 +102,7 @@ enable
 
 ### macOS Left and Right Option Key
 
-*since: 20200620-160318-e00b076c*
+{{since('20200620-160318-e00b076c')}}
 
 The default behavior is to treat the left `Option` key as the `Alt` modifier
 with no composition effects, while the right `Option` key performs composition
@@ -115,7 +115,7 @@ config.send_composed_key_when_left_alt_is_pressed = false
 config.send_composed_key_when_right_alt_is_pressed = true
 ```
 
-*since: 20210203-095643-70a364eb*
+{{since('20210203-095643-70a364eb')}}
 
 WezTerm is now able to perform dead-key expansion when `use_ime = false`.  Dead
 keys are treated as composition effects, so with the default settings of
@@ -137,7 +137,7 @@ some operating systems.
 
 ### Dead Keys
 
-*since: 20201031-154415-9614e117*
+{{since('20201031-154415-9614e117')}}
 
 By default, if you are using a layout with *dead keys* (eg: US International
 layout, or a number of European layouts such as German or French) pressing

diff --git a/docs/config/keys.md b/docs/config/keys.md
@@ -64,7 +64,7 @@ Pay attention to the case of the text that you use and the state of the `SHIFT`
 
 ### Physical vs Mapped Key Assignments
 
-*Since: 20220319-142410-0fcdea07*
+{{since('20220319-142410-0fcdea07')}}
 
 The `key` value can refer either to the physical position of a key on an ANSI
 US keyboard or to the post-keyboard-layout-mapped value produced by a key
@@ -89,7 +89,7 @@ your config, you will need to change it to either
 `{key="N", mods="CMD|SHIFT", ..}` or `{key="mapped:N", mods="CMD", ..}`
 in order to continue to respect the `SHIFT` modifier.
 
-*Since: 20220408-101518-b908e2dd*
+{{since('20220408-101518-b908e2dd')}}
 
 A new `key_map_preference` option controls how keys without an explicit `phys:`
 or `mapped:` prefix are treated. If `key_map_preference = "Mapped"` (the
@@ -117,7 +117,7 @@ rather than one of the other key values.
 
 ### Leader Key
 
-*Since: 20201031-154415-9614e117*
+{{since('20201031-154415-9614e117')}}
 
 A *leader* key is a a modal modifier key.  If leader is specified in the
 configuration then pressing that key combination will enable a virtual `LEADER`
@@ -157,7 +157,7 @@ config.keys = {
 
 ### VoidSymbol
 
-*Since: 20210814-124438-54e29167*
+{{since('20210814-124438-54e29167')}}
 
 On X11 systems, If you decide to change certain keys on the keyboard to
 `VoidSymbol` (like `CapsLock`), then you can utilize it as a `LEADER` or any

diff --git a/docs/config/launch.md b/docs/config/launch.md
@@ -14,15 +14,15 @@ Your shell is determined by the following rules:
     a login shell.  A login shell generally loads additional startup files
     and sets up more environment than a non-login shell.
 
-    *Since: 20210502-154244-3f7122cb*: instead of passing `-l` to the shell, wezterm
+    {{since('20210502-154244-3f7122cb', inline=True)}}: instead of passing `-l` to the shell, wezterm
     will spawn the shell as `-$SHELL` to invoke it as a login shell.
 
     Note: if you have recently changed your shell using `chsh` and you
     have `$SHELL` set in the environment, you will need to sign out and
     sign back in again for the environment to pick up your new `$SHELL`
     value.
 
-    *Since: 20220903-194523-3bb1ed61*: wezterm will now always resolve the shell via the
+    {{since('20220903-194523-3bb1ed61', inline=True)}}: wezterm will now always resolve the shell via the
     password database.
 
 === "On Windows Systems"

diff --git a/docs/config/lua/ExecDomain.md b/docs/config/lua/ExecDomain.md
@@ -1,6 +1,6 @@
 # ExecDomain
 
-*Since: 20220807-113146-c2fee766*
+{{since('20220807-113146-c2fee766')}}
 
 An `ExecDomain` defines a local-execution multiplexer domain. In simple terms,
 rather than directly executing the requested program, an `ExecDomain` allows

diff --git a/docs/config/lua/LocalProcessInfo.md b/docs/config/lua/LocalProcessInfo.md
@@ -1,6 +1,6 @@
 # `LocalProcessInfo`
 
-*Since: 20220101-133340-7edc5b5a*
+{{since('20220101-133340-7edc5b5a')}}
 
 `LocalProcessInfo` represents a process running on the local machine.
 

diff --git a/docs/config/lua/MuxTab/get_title.md b/docs/config/lua/MuxTab/get_title.md
@@ -1,6 +1,6 @@
 # tab:get_title()
 
-*Since: 20220807-113146-c2fee766*
+{{since('20220807-113146-c2fee766')}}
 
 Returns the tab title as set by `tab:set_title()`.
 

diff --git a/docs/config/lua/MuxTab/index.markdown b/docs/config/lua/MuxTab/index.markdown
@@ -1,6 +1,6 @@
 # MuxTab
 
-*Since: 20220624-141144-bd1b7c5d*
+{{since('20220624-141144-bd1b7c5d')}}
 
 `MuxTab` represents a tab that is managed by the multiplexer.
 

diff --git a/docs/config/lua/MuxTab/panes.md b/docs/config/lua/MuxTab/panes.md
@@ -1,6 +1,6 @@
 # tab:panes()
 
-*Since: 20220807-113146-c2fee766*
+{{since('20220807-113146-c2fee766')}}
 
 Returns an array table containing the set of [Pane](../pane/index.md) objects
 contained by this tab.

diff --git a/docs/config/lua/MuxTab/panes_with_info.md b/docs/config/lua/MuxTab/panes_with_info.md
@@ -1,6 +1,6 @@
 # tab:panes_with_info()
 
-*Since: 20220807-113146-c2fee766*
+{{since('20220807-113146-c2fee766')}}
 
 Returns an array table containing an extended info entry for each of the panes
 contained by this tab.

diff --git a/docs/config/lua/MuxTab/set_title.md b/docs/config/lua/MuxTab/set_title.md
@@ -1,6 +1,6 @@
 # tab:set_title(TITLE)
 
-*Since: 20220807-113146-c2fee766*
+{{since('20220807-113146-c2fee766')}}
 
 Sets the tab title to the provided string.
 

diff --git a/docs/config/lua/MuxTab/set_zoomed.md b/docs/config/lua/MuxTab/set_zoomed.md
@@ -1,6 +1,6 @@
 # tab:set_zoomed(bool)
 
-*Since: 20220807-113146-c2fee766*
+{{since('20220807-113146-c2fee766')}}
 
 Sets the zoomed state for the active pane within this tab.
 

diff --git a/docs/config/lua/MuxTab/tab_id.md b/docs/config/lua/MuxTab/tab_id.md
@@ -1,6 +1,6 @@
 # `tab:tab_id()`
 
-*Since: 20220624-141144-bd1b7c5d*
+{{since('20220624-141144-bd1b7c5d')}}
 
 Returns the tab id
 
diff --git a/docs/config/lua/MuxTab/window.md b/docs/config/lua/MuxTab/window.md
@@ -1,6 +1,6 @@
 # tab:window()
 
-*Since: 20220807-113146-c2fee766*
+{{since('20220807-113146-c2fee766')}}
 
 Returns the [MuxWindow](../mux-window/index.md) object that contains this tab.