fluffos/docs/efun/internals/debug_info.md
gesslar 1ad5953549
docs: validate "See Also" references, drop dead ones, document valid_ffi (#1251)
* empty

* docs: validate "See Also" references, drop dead ones, document valid_ffi

Reviewed the "See Also" section of every doc and dropped man-page
cross-references whose target page does not exist (verified against the
driver source, not just the docs tree):

  - errorp, each, opcprof, dump_socket_status, extract, shadowp,
    destruct_env_of, move, inventory_visible, inventory_accessible

These name efuns/applies that no longer exist in FluffOS. keys/values now
point at the `for` construct in place of the defunct `each` efun.

valid_ffi was the one "referenced but undocumented" case: it is a real
master apply (APPLY_VALID_FFI) gating every ffi_load/symbol/prepare/
callback, so it gets a proper apply page rather than having its references
removed. Sidebar regenerated to include it.

The 13 modern markdown-link "See Also" sections were already clean.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-07-12 01:09:17 -04:00

1.7 KiB
Raw Permalink Blame History

title
internals / debug_info

debug_info

NAME

debug_info() - display debug information

SYNOPSIS

mixed debug_info( int operation, ... );
mixed debug_info( 0, object ob );
mixed debug_info( 1, object ob );

DESCRIPTION

debug_info()  is  a general-purpose facility which may be used to debug
the MudOS driver.  The debugging information requested is determined by
the  first  argument.  Successive arguments are determine by the opera
tion selected.

The existing operations (0 and 1) require a second  object  type  argu
ment, and may be used to display the various fields of the MudOS object
structure.

The following LPC code was used to generate the sample output:

/* di0.c */
create() {
    debug_info(0, this_object());
}

    O_HEART_BEAT      : FALSE
    O_IS_WIZARD       : FALSE
    O_ENABLE_COMMANDS : FALSE
    O_CLONE           : FALSE
    O_DESTRUCTED      : FALSE
    O_SWAPPED         : FALSE
    O_ONCE_INTERACTIVE: FALSE
    O_RESET_STATE     : FALSE
    O_WILL_CLEAN_UP   : FALSE
    O_WILL_RESET: TRUE
    total light : 0
    next_reset  : 720300560
    time_of_ref : 720299416
    ref         : 2
    swap_num    : -1
    name        : 'u/c/cynosure/di0'
    next_all    : OBJ(bin/dev/_update)
    This object is the head of the object list.

/* di1.c */
create() {
    debug_info(1, this_object());
}

    program ref's 1
    Name u/c/cynosure/di1.c
    program size 10
    num func's 1 (16)
    num strings 0
    num vars 0 (0)
    num inherits 0 (0)
    total size 104

SEE ALSO

dump_file_descriptors(3)