mirror of
https://github.com/fluffos/fluffos
synced 2026-08-12 18:26:06 -04:00
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>
74 lines
1.9 KiB
Markdown
74 lines
1.9 KiB
Markdown
---
|
|
title: Troubleshooting
|
|
---
|
|
# Troubleshooting
|
|
|
|
### Where To File
|
|
|
|
Please creates a [New Issue on GitHub](https://github.com/fluffos/fluffos/issues?direction=desc&milestone=none&sort=popularity&state=open).
|
|
|
|
### Bug Report content
|
|
|
|
Please be sure to include these in your bug report.
|
|
|
|
- The version number, driver will output this on start.
|
|
|
|
- The full output, the driver will at least print out some backtrace or error message. Include those.
|
|
|
|
- If you can, try to narrow down to a small LPC program that reproduce the
|
|
problem easily. If you can not, Try using Valgrind method first.
|
|
|
|
## GDB
|
|
|
|
If you have met an crash, the driver should automatically print out an list of backtrace, but sometime that doesn't really contain enough information.
|
|
|
|
If you want to catch the crash, try running driver under GDB directly
|
|
|
|
```shell
|
|
$ gdb --args driver <arguments>
|
|
|
|
then in GDB prompt
|
|
> handle SIGPIPE nostop noprint pass
|
|
> run
|
|
```
|
|
|
|
Or all at once
|
|
|
|
```shell
|
|
$ gdb -ex "handle SIGPIPE nostop noprint pass" -ex "run" --args driver <arguments>
|
|
```
|
|
|
|
and when you met an crash, do this
|
|
|
|
```shell
|
|
> bt
|
|
> info locals
|
|
```
|
|
|
|
and paste the result to your issue!
|
|
|
|
### Sanitizer
|
|
|
|
Most of the crashing bug is actually caused by previous silent memory corruption, which it is very hard to detect.
|
|
|
|
The currently preferred way to detect any sort of memory corruption is to use Sanitizer, that way you catch the
|
|
problem when it happens, not when it causes other problems. However it mostly only works under Linux.
|
|
|
|
Here is how you should generate a bug report with Sanitizer.
|
|
|
|
Build driver in sanitizer enabled mode
|
|
|
|
```shell
|
|
cmake .. -DENABLE_SANITIZER=ON
|
|
```
|
|
|
|
Launch driver as usual
|
|
|
|
```shell
|
|
./driver <args>
|
|
```
|
|
|
|
Login to your lib as usual, do something fishy.
|
|
|
|
(it will be slow, that is okay) You may also have to relax your `maximum eval cost` setting, if necessary. When
|
|
Valgrind halts and prints out a backtrace with `Invalid read of size 1`, or `Invalid write of size 1`, save the entire stack trace.
|