zig

commit 741fb8d30675f85316f7df100801e7cf8c2b3194 (tree)
parent 15bcfcd36865fca75b93dc6ce52c904292b62a81
Author: Isaac Freund <ifreund@ifreund.xyz>
Date:   Tue, 18 Aug 2020 10:54:54 +0200

stage2/link: clarify comments on calling order

Diffstat:
M
src-self-hosted/link.zig
 | 
7
++++++-

1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/src-self-hosted/link.zig b/src-self-hosted/link.zig
@@ -110,6 +110,8 @@ pub const File = struct {
         }
     }
 
+    /// May be called before or after updateDeclExports but must be called
+    /// after allocateDeclIndexes for any given Decl.
     pub fn updateDecl(base: *File, module: *Module, decl: *Module.Decl) !void {
         switch (base.tag) {
             .elf => return @fieldParentPtr(Elf, "base", base).updateDecl(module, decl),
@@ -127,6 +129,8 @@ pub const File = struct {
         }
     }
 
+    /// Must be called before any call to updateDecl or updateDeclExports for
+    /// any given Decl.
     pub fn allocateDeclIndexes(base: *File, decl: *Module.Decl) !void {
         switch (base.tag) {
             .elf => return @fieldParentPtr(Elf, "base", base).allocateDeclIndexes(decl),
@@ -200,7 +204,8 @@ pub const File = struct {
         };
     }
 
-    /// Must be called only after a successful call to `updateDecl`.
+    /// May be called before or after updateDecl, but must be called after
+    /// allocateDeclIndexes for any given Decl.
     pub fn updateDeclExports(
         base: *File,
         module: *Module,