From bc393eefa1d80e7e85735d9ccbde13fb52144fcd Mon Sep 17 00:00:00 2001
From: Andrew Kelley <andrew@ziglang.org>
Date: Thu, 10 Oct 2019 19:21:56 -0400
Subject: [PATCH 1/3] generated docs: better rendering of unknown decls

---
 lib/std/special/docs/index.html | 15 +++++++++++----
 lib/std/special/docs/main.js    | 25 ++++++++++++++++++++-----
 2 files changed, 31 insertions(+), 9 deletions(-)

diff --git a/lib/std/special/docs/index.html b/lib/std/special/docs/index.html
index 181b101e0e..83032d87da 100644
--- a/lib/std/special/docs/index.html
+++ b/lib/std/special/docs/index.html
@@ -289,6 +289,17 @@
       <pre id="fnProtoCode"></pre>
     </div>
     <h1 id="hdrName" class="hidden"></h1>
+    <div id="fnExamples" class="hidden"></div>
+    <div id="fnNoExamples" class="hidden">
+      <p>This function is not tested or referenced.</p>
+    </div>
+    <div id="declNoRef" class="hidden">
+      <p>
+      This declaration is not tested or referenced, and it has therefore not been included in
+      semantic analysis, which means the only documentation available is whatever is in the
+      doc comments.
+      </p>
+    </div>
     <div id="fnDocs" class="hidden"></div>
     <div id="sectFnErrors" class="hidden">
       <h2>Errors</h2>
@@ -297,10 +308,6 @@
       </div>
       <div id="tableFnErrors"><dl id="listFnErrors"></dl></div>
     </div>
-    <div id="fnExamples" class="hidden"></div>
-    <div id="fnNoExamples" class="hidden">
-      <p>This function is not tested or referenced.</p>
-    </div>
     <div id="sectSearchResults" class="hidden">
       <h2>Search Results</h2>
       <ul id="listSearchResults"></ul>
diff --git a/lib/std/special/docs/main.js b/lib/std/special/docs/main.js
index 7e5a9c4c0e..0ef30f49e4 100644
--- a/lib/std/special/docs/main.js
+++ b/lib/std/special/docs/main.js
@@ -27,6 +27,7 @@
     var domFnErrorsAnyError = document.getElementById("fnErrorsAnyError");
     var domFnExamples = document.getElementById("fnExamples");
     var domFnNoExamples = document.getElementById("fnNoExamples");
+    var domDeclNoRef = document.getElementById("declNoRef");
     var domSearch = document.getElementById("search");
     var domSectSearchResults = document.getElementById("sectSearchResults");
     var domListSearchResults = document.getElementById("listSearchResults");
@@ -112,6 +113,7 @@
         domSectFnErrors.classList.add("hidden");
         domFnExamples.classList.add("hidden");
         domFnNoExamples.classList.add("hidden");
+        domDeclNoRef.classList.add("hidden");
         domFnErrorsAnyError.classList.add("hidden");
         domTableFnErrors.classList.add("hidden");
         domSectGlobalVars.classList.add("hidden");
@@ -160,7 +162,12 @@
         renderNav();
 
         var lastDecl = curNav.declObjs[curNav.declObjs.length - 1];
-        if (lastDecl.kind === 'var') {
+        if (lastDecl.pubDecls != null) {
+            renderContainer(lastDecl);
+        }
+        if (lastDecl.kind == null) {
+            return renderUnknownDecl(lastDecl);
+        } else if (lastDecl.kind === 'var') {
             return renderVar(lastDecl);
         } else if (lastDecl.kind === 'const' && lastDecl.type != null) {
             var typeObj = zigAnalysis.types[lastDecl.type];
@@ -169,13 +176,21 @@
             } else {
                 return renderValue(lastDecl);
             }
-        }
-        if (lastDecl.kind != null) {
+        } else {
             renderType(lastDecl);
         }
-        if (lastDecl.pubDecls != null) {
-            renderContainer(lastDecl);
+    }
+
+    function renderUnknownDecl(decl) {
+        domDeclNoRef.classList.remove("hidden");
+
+        var docs = zigAnalysis.astNodes[decl.src].docs;
+        if (docs != null) {
+            domFnDocs.innerHTML = markdown(docs);
+        } else {
+            domFnDocs.innerHTML = '<p>There are no doc comments for this declaration.</p>';
         }
+        domFnDocs.classList.remove("hidden");
     }
 
     function typeIsErrSet(typeIndex) {

From fa47172841b2da986d49bf37d92459b335468f98 Mon Sep 17 00:00:00 2001
From: Andrew Kelley <andrew@ziglang.org>
Date: Thu, 10 Oct 2019 19:22:15 -0400
Subject: [PATCH 2/3] better debug info for integers

now we use ABI size * 8 instead of size_in_bits which makes
gdb work instead of hang
---
 src/analyze.cpp | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/src/analyze.cpp b/src/analyze.cpp
index baeaedf8d9..a38766bc25 100644
--- a/src/analyze.cpp
+++ b/src/analyze.cpp
@@ -8304,7 +8304,8 @@ static void resolve_llvm_types_integer(CodeGen *g, ZigType *type) {
         }
     }
 
-    type->llvm_di_type = ZigLLVMCreateDebugBasicType(g->dbuilder, buf_ptr(&type->name), type->size_in_bits, dwarf_tag);
+    type->llvm_di_type = ZigLLVMCreateDebugBasicType(g->dbuilder, buf_ptr(&type->name),
+            type->abi_size * 8, dwarf_tag);
     type->llvm_type = LLVMIntType(type->size_in_bits);
 }
 

From 6082c147533cbefe9f27d8f32b6485c8c43a738f Mon Sep 17 00:00:00 2001
From: Andrew Kelley <andrew@ziglang.org>
Date: Thu, 10 Oct 2019 20:32:17 -0400
Subject: [PATCH 3/3] generated docs: add optional type support

---
 lib/std/os.zig               | 5 +++++
 lib/std/special/docs/main.js | 2 ++
 src/dump_analysis.cpp        | 5 +++++
 3 files changed, 12 insertions(+)

diff --git a/lib/std/os.zig b/lib/std/os.zig
index c05c911148..13cb4bf587 100644
--- a/lib/std/os.zig
+++ b/lib/std/os.zig
@@ -537,7 +537,12 @@ pub const OpenError = error{
     SystemFdQuotaExceeded,
     NoDevice,
     FileNotFound,
+
+    /// Insufficient kernel memory was available, or
+    /// the named file is a FIFO and per-user hard limit on
+    /// memory allocation for pipes has been reached.
     SystemResources,
+
     NoSpaceLeft,
     NotDir,
     PathAlreadyExists,
diff --git a/lib/std/special/docs/main.js b/lib/std/special/docs/main.js
index 0ef30f49e4..7bc8bb0e97 100644
--- a/lib/std/special/docs/main.js
+++ b/lib/std/special/docs/main.js
@@ -438,6 +438,8 @@
                 name += "]";
                 name += typeIndexName(typeObj.elem, wantHtml, wantSubLink, null);
                 return name;
+            case typeKinds.Optional:
+                return "?" + typeIndexName(typeObj.child, wantHtml, wantSubLink, fnDecl, linkFnNameDecl);
             case typeKinds.Pointer:
                 var name = "";
                 switch (typeObj.len) {
diff --git a/src/dump_analysis.cpp b/src/dump_analysis.cpp
index 6a3593ed58..6e84095dfd 100644
--- a/src/dump_analysis.cpp
+++ b/src/dump_analysis.cpp
@@ -991,6 +991,11 @@ static void anal_dump_type(AnalDumpCtx *ctx, ZigType *ty) {
             }
             break;
         }
+        case ZigTypeIdOptional: {
+            jw_object_field(jw, "child");
+            anal_dump_type_ref(ctx, ty->data.maybe.child_type);
+            break;
+        }
         case ZigTypeIdPointer: {
             switch (ty->data.pointer.ptr_len) {
                 case PtrLenSingle: