zig

commit 95f0dce7dae258fc2cf9947fdaad26d768902373 (tree)
parent b32aa99b8704efd892567c8a716fb6c9f4e48a36
Author: Andrew Kelley <andrew@ziglang.org>
Date:   Wed,  5 Jun 2024 15:45:51 -0700

seriously people, don't put "zig-" in your package names

related #20178

Diffstat:
M
doc/build.zig.zon.md
 | 
8
++++++++
M
lib/init/build.zig.zon
 | 
8
++++++++

2 files changed, 16 insertions(+), 0 deletions(-)
diff --git a/doc/build.zig.zon.md b/doc/build.zig.zon.md
@@ -12,6 +12,14 @@ build.zig.
 
 String. Required.
 
+This is the default name used by packages depending on this one. For example,
+when a user runs `zig fetch --save <url>`, this field is used as the key in the
+`dependencies` table. Although the user can choose a different name, most users
+will stick with this provided value.
+
+It is redundant to include "zig" in this name because it is already within the
+Zig package namespace.
+
 ### `version`
 
 String. Required.
diff --git a/lib/init/build.zig.zon b/lib/init/build.zig.zon
@@ -1,5 +1,13 @@
 .{
+    // This is the default name used by packages depending on this one. For
+    // example, when a user runs `zig fetch --save <url>`, this field is used
+    // as the key in the `dependencies` table. Although the user can choose a
+    // different name, most users will stick with this provided value.
+    //
+    // It is redundant to include "zig" in this name because it is already
+    // within the Zig package namespace.
     .name = "$",
+
     // This is a [Semantic Version](https://semver.org/).
     // In a future version of Zig it will be used for package deduplication.
     .version = "0.0.0",