fluffos/docs/efun
Yucong Sun c5f3c3bdc7
docs: document call_out handle validity and mid-compile valid_read behavior (#1252)
Follow-up to reviewing PRs #1068 and #932, both of whose bugs are already
fixed on master:

- #1068 (call_out handles below the allocation counter rejected as
  invalid) was fixed by #1220 with a regression test in
  testsuite/single/tests/efuns/remove_call_out.lpc. Document the
  guaranteed semantics in call_out.md / remove_call_out.md: a handle
  stays valid until it fires or is removed, regardless of newer
  call_outs; 0 is never a valid handle.

- #932 (an error thrown from valid_read during #include handling left
  compile_file's reentrancy guard set, wedging all future loads) is
  fixed by the compiler front-end rewrite: compile_file's scope guard
  restores all compiler state and clears the guard on exception
  unwinding. Document in valid_read.md that the apply runs mid-compile
  for #include checks, must not trigger another compile, and that a
  thrown error aborts only that compilation.


Claude-Session: https://claude.ai/code/session_01JRvUnh3x5MYPWPk2MiiUS2

Co-authored-by: Claude <noreply@anthropic.com>
2026-07-12 02:02:56 -04:00
..
arrays docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251) 2026-07-12 01:09:17 -04:00
async docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
buffers vm: string foreach/ref fixes, buffers as byte arrays (foreach, strict bytes, to_buffer), thorough ref tests; #1196 docs follow-up (#1250) 2026-07-12 01:39:30 -04:00
calls docs: document call_out handle validity and mid-compile valid_read behavior (#1252) 2026-07-12 02:02:56 -04:00
contrib docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
crypto docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
db docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
ed docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
external docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
ffi docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
filesystem docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
floats docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251) 2026-07-12 01:09:17 -04:00
functions docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251) 2026-07-12 01:09:17 -04:00
general docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251) 2026-07-12 01:09:17 -04:00
interactive docs: flesh out 31 TBW efun reference pages (#1248) 2026-07-11 22:07:47 -04:00
internals docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251) 2026-07-12 01:09:17 -04:00
jsbridge docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
mappings docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251) 2026-07-12 01:09:17 -04:00
mudlib docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
numbers docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251) 2026-07-12 01:09:17 -04:00
objects docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251) 2026-07-12 01:09:17 -04:00
parsing docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
pcre docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
sockets docs: fully-expandable generated sidebar + Chinese docs via Docusaurus i18n (#1246) 2026-07-11 17:20:25 -04:00
strings docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251) 2026-07-12 01:09:17 -04:00
system docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251) 2026-07-12 01:09:17 -04:00