c914f03d66
* docs: add local full-text search and a contributor README Add @easyops-cn/docusaurus-search-local to the Docusaurus site so the docs get an offline search bar (index built at build time, no external service). English and zh-CN pages are both indexed, and matched terms are highlighted on the target page. Add docs/README.md describing the Docusaurus setup, local dev/build commands, search behavior, directory layout, and gotchas; exclude it from the published site alongside CLAUDE.md. Point the root README's docs/ entry at it. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE * docs: remove dead framework leftovers, fix index generation, complete the nav Delete the VitePress (.vitepress/) and Jekyll (_layouts/, css/) leftovers, the one-shot migration scripts (fix_md_header.py, fix_seealso.py), and the stale keywords.json snapshot; prune the matching .gitignore entries and docusaurus exclude patterns. Rewrite gen_index.py for Docusaurus: it emitted dead .html links and legacy 'layout: doc' frontmatter, choked on non-markdown entries, and dropped nested categories — regenerating an index would have broken it. It now emits the extension-less links the site actually uses, links nested category indexes (restoring apply/* on the zh-CN index), and refuses to run on the docs root. Fix update_index.sh's copy-paste titles (zh-CN efun/build were titled 'APPLY'), stop it clobbering the hand-written lpc/index.md, and cover cli/. Regenerated indexes pick up the missing driver/ffi-plan entry. add_missing_efuns.py now takes the keywords.json path as an argument instead of requiring a stale copy. Move CNAME and the Google site-verification file into static/ so they actually reach the published build output. Complete the sidebar: link the CLI category to cli/index and add the missing portbind/symbol/generate_keywords pages, and expose the previously orphaned stdlib section under Reference. Promote onBrokenLinks to 'throw' now the build is warning-free, and drop the empty Demo section from the landing page. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE * docs: strip legacy 'layout: doc' frontmatter from all pages Mechanical sweep removing the Jekyll-era 'layout: doc' line from every doc page's frontmatter (Docusaurus ignores it), and the matching line from the templates in docs/CLAUDE.md so new pages don't reintroduce it. No content changes. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TSzcESzU9947zkGzQ6SMmE --------- Co-authored-by: Claude <noreply@anthropic.com>
2.4 KiB
| title |
|---|
| compiler diagnostics |
Reading compiler diagnostics
The LPC compiler reports errors and warnings clang-style: a
file:line:column header, the offending source line with a gutter, a
caret marking the position (with ~~~ ranges for operands where they
apply), and follow-up notes.
/cmds/ftpd.lpc:12:5: error: Undefined variable 'mudinfo'
12 | mudinfo = query_mud_info();
| ^~~~~~~
Macro expansion notes
When the error position is inside a macro expansion, the diagnostic
carries one note: expanded from macro '...' per expansion level,
each with the macro's definition site and its definition line:
/obj/board.lpc:44:13: error: Illegal type to +
44 | total = SUM_OF(a, b);
| ^~~~~~~~~~~~
/include/board.h:7:9: note: expanded from macro 'SUM_OF'
7 | #define SUM_OF(x, y) ((x) + (y))
| ^
Include chains and load reasons
Errors inside an #included file print the chain of includes that got
there, and errors while loading an inherited file record why the file
was being compiled:
In file included from /cmds/ftpd.lpc:3:
/include/ftpdconf.h:15:1: error: ...
note: while loading '/std/container' inherited by '/std/chest'
Warnings
Warnings use the same format with warning: severity. They do not
fail the compile. #pragma no_warnings suppresses them for the rest
of the file (see pragma). Notable warnings:
- Macro redefinition —
#define-ing an existing macro with a different body warns (with a note pointing at the previous definition) and the new definition takes effect. Redefining with an identical body is silent. See define.
Fix-it hints
Some diagnostics carry a replacement suggestion rendered under the caret when the fix is unambiguous — for example an unknown escape sequence in a string literal, where the character stands for itself and the backslash should be dropped:
/obj/sign.lpc:9:20: warning: Unknown escape sequence '\m'.
9 | write("Read \me!");
| ^~
| m
Legacy error context
#pragma show_error_context is a legacy flag that predates these
clang-style diagnostics. The output shown above always includes the
source snippet and caret, so the pragma no longer changes how
compiler diagnostics are rendered — it survives only for the
driver's older runtime error-logging path.