docs: complete the documentation for extern struct

closes #1522
2026-02-13 12:59:04 +00:00 · 2019-04-04 01:23:41 -04:00 · 2019-04-04 01:23:41 -04:00 · 90b6eab05a
commit 90b6eab05a
parent e4d595a8ba
1 changed files with 2 additions and 0 deletions
--- 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#}