Add comment to serialise() and mention a design decision.

ykjit · Nov 17, 2023 · b3bddfd · b3bddfd
1 parent b8da34b
commit b3bddfd
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/llvm/lib/YkIR/YkIRWriter.cpp b/llvm/lib/YkIR/YkIRWriter.cpp
@@ -489,6 +489,14 @@ class YkIRWriter {
   YkIRWriter(Module &M, MCStreamer &OutStreamer)
       : M(M), OutStreamer(OutStreamer) {}
 
+  // Entry point for IR serialisation.
+  //
+  // The order of serialisation matters.
+  //
+  // - Serialising functions can introduce new types and constants.
+  // - Serialising constants can introduce new types.
+  //
+  // So we must serialise functions, then constants, then types.
   void serialise() {
     // header:
     OutStreamer.emitInt32(Magic);