docs: complete the documentation for extern struct

closes #1522
ziglang · Apr 4, 2019 · 90b6eab · 90b6eab
1 parent e4d595a
commit 90b6eab
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/doc/langref.html.in b/doc/langref.html.in
@@ -2127,6 +2127,8 @@ test "linked list" {
       {#header_open|extern struct#}
       <p>An {#syntax#}extern struct{#endsyntax#} has in-memory layout guaranteed to match the
       C ABI for the target.</p>
+      <p>This kind of struct should only be used for compatibility with the C ABI. Every other
+      use case should be solved with {#link|packed struct#} or normal {#link|struct#}.</p>
       {#see_also|extern union|extern enum#}
       {#header_close#}