From 996ce03f0b9e9407c0164e4a3c4f341ed91cc817 Mon Sep 17 00:00:00 2001 From: Mitchell Hashimoto Date: Tue, 17 Mar 2026 17:39:25 -0700 Subject: [PATCH] example: rename some examples --- example/{c-vt-key-encode => c-vt-encode-key}/README.md | 0 example/{c-vt-key-encode => c-vt-encode-key}/build.zig | 2 +- .../{c-vt-key-encode => c-vt-encode-key}/build.zig.zon | 0 example/{c-vt-key-encode => c-vt-encode-key}/src/main.c | 0 .../{c-vt-mouse-encode => c-vt-encode-mouse}/README.md | 0 .../{c-vt-mouse-encode => c-vt-encode-mouse}/build.zig | 2 +- .../build.zig.zon | 0 .../{c-vt-mouse-encode => c-vt-encode-mouse}/src/main.c | 0 include/ghostty/vt.h | 8 ++++---- include/ghostty/vt/key.h | 4 ++-- include/ghostty/vt/mouse.h | 4 ++-- 11 files changed, 10 insertions(+), 10 deletions(-) rename example/{c-vt-key-encode => c-vt-encode-key}/README.md (100%) rename example/{c-vt-key-encode => c-vt-encode-key}/build.zig (97%) rename example/{c-vt-key-encode => c-vt-encode-key}/build.zig.zon (100%) rename example/{c-vt-key-encode => c-vt-encode-key}/src/main.c (100%) rename example/{c-vt-mouse-encode => c-vt-encode-mouse}/README.md (100%) rename example/{c-vt-mouse-encode => c-vt-encode-mouse}/build.zig (97%) rename example/{c-vt-mouse-encode => c-vt-encode-mouse}/build.zig.zon (100%) rename example/{c-vt-mouse-encode => c-vt-encode-mouse}/src/main.c (100%) diff --git a/example/c-vt-key-encode/README.md b/example/c-vt-encode-key/README.md similarity index 100% rename from example/c-vt-key-encode/README.md rename to example/c-vt-encode-key/README.md diff --git a/example/c-vt-key-encode/build.zig b/example/c-vt-encode-key/build.zig similarity index 97% rename from example/c-vt-key-encode/build.zig rename to example/c-vt-encode-key/build.zig index b4b759744..de878a7ad 100644 --- a/example/c-vt-key-encode/build.zig +++ b/example/c-vt-encode-key/build.zig @@ -29,7 +29,7 @@ pub fn build(b: *std.Build) void { // Exe const exe = b.addExecutable(.{ - .name = "c_vt_key_encode", + .name = "c_vt_encode_key", .root_module = exe_mod, }); b.installArtifact(exe); diff --git a/example/c-vt-key-encode/build.zig.zon b/example/c-vt-encode-key/build.zig.zon similarity index 100% rename from example/c-vt-key-encode/build.zig.zon rename to example/c-vt-encode-key/build.zig.zon diff --git a/example/c-vt-key-encode/src/main.c b/example/c-vt-encode-key/src/main.c similarity index 100% rename from example/c-vt-key-encode/src/main.c rename to example/c-vt-encode-key/src/main.c diff --git a/example/c-vt-mouse-encode/README.md b/example/c-vt-encode-mouse/README.md similarity index 100% rename from example/c-vt-mouse-encode/README.md rename to example/c-vt-encode-mouse/README.md diff --git a/example/c-vt-mouse-encode/build.zig b/example/c-vt-encode-mouse/build.zig similarity index 97% rename from example/c-vt-mouse-encode/build.zig rename to example/c-vt-encode-mouse/build.zig index 350d0a89e..4fdb353c0 100644 --- a/example/c-vt-mouse-encode/build.zig +++ b/example/c-vt-encode-mouse/build.zig @@ -29,7 +29,7 @@ pub fn build(b: *std.Build) void { // Exe const exe = b.addExecutable(.{ - .name = "c_vt_mouse_encode", + .name = "c_vt_encode_mouse", .root_module = exe_mod, }); b.installArtifact(exe); diff --git a/example/c-vt-mouse-encode/build.zig.zon b/example/c-vt-encode-mouse/build.zig.zon similarity index 100% rename from example/c-vt-mouse-encode/build.zig.zon rename to example/c-vt-encode-mouse/build.zig.zon diff --git a/example/c-vt-mouse-encode/src/main.c b/example/c-vt-encode-mouse/src/main.c similarity index 100% rename from example/c-vt-mouse-encode/src/main.c rename to example/c-vt-encode-mouse/src/main.c diff --git a/include/ghostty/vt.h b/include/ghostty/vt.h index 5b670f80a..c6ab35fa3 100644 --- a/include/ghostty/vt.h +++ b/include/ghostty/vt.h @@ -45,8 +45,8 @@ * * Complete working examples: * - @ref c-vt/src/main.c - OSC parser example - * - @ref c-vt-key-encode/src/main.c - Key encoding example - * - @ref c-vt-mouse-encode/src/main.c - Mouse encoding example + * - @ref c-vt-encode-key/src/main.c - Key encoding example + * - @ref c-vt-encode-mouse/src/main.c - Mouse encoding example * - @ref c-vt-paste/src/main.c - Paste safety check example * - @ref c-vt-sgr/src/main.c - SGR parser example * - @ref c-vt-formatter/src/main.c - Terminal formatter example @@ -58,12 +58,12 @@ * extract command information, and retrieve command-specific data like window titles. */ -/** @example c-vt-key-encode/src/main.c +/** @example c-vt-encode-key/src/main.c * This example demonstrates how to use the key encoder to convert key events * into terminal escape sequences using the Kitty keyboard protocol. */ -/** @example c-vt-mouse-encode/src/main.c +/** @example c-vt-encode-mouse/src/main.c * This example demonstrates how to use the mouse encoder to convert mouse events * into terminal escape sequences using the SGR mouse format. */ diff --git a/include/ghostty/vt/key.h b/include/ghostty/vt/key.h index 305cffe87..61b954753 100644 --- a/include/ghostty/vt/key.h +++ b/include/ghostty/vt/key.h @@ -27,12 +27,12 @@ * changing its properties. * 4. Free the encoder with ghostty_key_encoder_free() when done * - * For a complete working example, see example/c-vt-key-encode in the + * For a complete working example, see example/c-vt-encode-key in the * repository. * * ## Example * - * @snippet c-vt-key-encode/src/main.c key-encode + * @snippet c-vt-encode-key/src/main.c key-encode * * ## Example: Encoding with Terminal State * diff --git a/include/ghostty/vt/mouse.h b/include/ghostty/vt/mouse.h index c4489d3e4..4ba5f52e3 100644 --- a/include/ghostty/vt/mouse.h +++ b/include/ghostty/vt/mouse.h @@ -24,12 +24,12 @@ * - Free the event with ghostty_mouse_event_free() or reuse it. * 4. Free the encoder with ghostty_mouse_encoder_free() when done. * - * For a complete working example, see example/c-vt-mouse-encode in the + * For a complete working example, see example/c-vt-encode-mouse in the * repository. * * ## Example * - * @snippet c-vt-mouse-encode/src/main.c mouse-encode + * @snippet c-vt-encode-mouse/src/main.c mouse-encode * * ## Example: Encoding with Terminal State *