From 018569888fd08d59acc6fb1aa6eea4cf71bfdbc9 Mon Sep 17 00:00:00 2001
From: Techarix <19954306+Techatrix@users.noreply.github.com>
Date: Tue, 14 Feb 2023 22:53:05 +0100
Subject: [PATCH] explain how AstGen will diverge from zig codebase

---
 src/stage2/AstGen.zig |  7 +++++++
 src/stage2/Zir.zig    | 11 ++++++-----
 2 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/src/stage2/AstGen.zig b/src/stage2/AstGen.zig
index e6e2d70..a71fdc1 100644
--- a/src/stage2/AstGen.zig
+++ b/src/stage2/AstGen.zig
@@ -1,4 +1,11 @@
 //! Ingests an AST and produces ZIR code.
+//!
+//! TODO
+//! In contrast to the upstream zig codebase, generating Zir
+//! will not fail after encountering compile errors but will
+//! instead try to ignore or patch these errors.
+//! If this is not possible, an `unknown` instructions will be emitted.
+
 const AstGen = @This();
 
 const std = @import("std");
diff --git a/src/stage2/Zir.zig b/src/stage2/Zir.zig
index e3cf276..19009f2 100644
--- a/src/stage2/Zir.zig
+++ b/src/stage2/Zir.zig
@@ -2065,10 +2065,6 @@ pub const Inst = struct {
     /// The tag type is specified so that it is safe to bitcast between `[]u32`
     /// and `[]Ref`.
     pub const Ref = enum(u32) {
-        /// This Ref does not correspond to any ZIR instruction or constant
-        /// value and may instead be used as a sentinel to indicate null.
-        none,
-
         u1_type,
         u8_type,
         i8_type,
@@ -2130,6 +2126,7 @@ pub const Inst = struct {
         const_slice_u8_type,
         anyerror_void_error_union_type,
         generic_poison_type,
+        unknown_type,
 
         /// `undefined` (untyped)
         undef,
@@ -2160,9 +2157,13 @@ pub const Inst = struct {
         /// Used for generic parameters where the type and value
         /// is not known until generic function instantiation.
         generic_poison,
+        unknown,
 
         ref_start_index,
 
+        /// This Ref does not correspond to any ZIR instruction or constant
+        /// value and may instead be used as a sentinel to indicate null.
+        none = std.math.maxInt(u32),
         _,
     };
 
@@ -3839,7 +3840,7 @@ pub fn getFnInfo(zir: Zir, fn_inst: Inst.Index) FnInfo {
     };
 }
 
-const ref_start_index: u32 = @enumToInt(Inst.Ref.ref_start_index);
+pub const ref_start_index: u32 = @enumToInt(Inst.Ref.ref_start_index);
 
 pub fn indexToRef(inst: Inst.Index) Inst.Ref {
     return @intToEnum(Inst.Ref, ref_start_index + inst);