Skip to content

Commit 182082d

Browse files
committed
update documentation for the minimum build Zig version
See #2497
1 parent 67177e3 commit 182082d

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-12
lines changed

build.zig

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,6 @@ const builtin = @import("builtin");
33

44
const zls_version = std.SemanticVersion.parse(@import("build.zig.zon").version) catch unreachable;
55

6-
/// Specify the minimum Zig version that is required to compile and test ZLS:
7-
/// Add error bundle support to `translate-c`, unify `cmdTranslateC` and `cImport`
8-
///
9-
/// If you do not use Nix, a ZLS maintainer can take care of this.
10-
/// Whenever this version is increased, run the following command:
11-
/// ```bash
12-
/// nix flake update --commit-lock-file
13-
/// ```
146
const minimum_build_zig_version = @import("build.zig.zon").minimum_zig_version;
157

168
/// Specify the minimum Zig version that is usable with ZLS:
@@ -646,7 +638,7 @@ const Build = blk: {
646638
\\ ZLS version: {[current_version]s}
647639
\\ minimum Zig version: {[minimum_version]s}
648640
\\
649-
\\This is a developer error. Set `minimum_build_zig_version` in `build.zig` and `minimum_zig_version` in `build.zig.zon` to {[current_version]s}.
641+
\\This is a developer error. Set `minimum_zig_version` in `build.zig.zon` to {[current_version]s}.
650642
, .{ .current_version = zls_version_simple_str, .minimum_version = minimum_build_zig_version });
651643
@compileError(message);
652644
}

build.zig.zon

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
.{
22
.name = .zls,
3-
// Used by build.zig.
43
// Remove `-dev` when tagging a new ZLS release and add it back on the next development cycle.
54
.version = "0.16.0-dev",
6-
// Used by build.zig.
7-
// Should be a Zig version that is downloadable from https://ziglang.org/download/ or a mirror.
5+
// Specifies the minimum Zig version that is required to compile and test ZLS.
6+
// Must be a Zig version that is downloadable from https://ziglang.org/download/ or a mirror.
7+
//
8+
// Whenever this version is increased, run the following command:
9+
// ```bash
10+
// nix flake update --commit-lock-file
11+
// ```
12+
// If you do not use Nix, a ZLS maintainer can take care of this.
813
.minimum_zig_version = "0.16.0-dev.728+87c18945c",
914
// If you do not use Nix, a ZLS maintainer can take care of this.
1015
// Whenever the dependencies are updated, run the following command:

0 commit comments

Comments
 (0)