diff options
| author | blasty <blasty@local> | 2026-08-07 15:29:37 +0200 |
|---|---|---|
| committer | blasty <blasty@local> | 2026-08-07 15:29:49 +0200 |
| commit | 8fef561903e9501281ebcc58cdb33ee4d9116fd0 (patch) | |
| tree | 0edd3a430134fdddd5a4826b835360591e632507 /README.md | |
| parent | README: pure markdown, and a logo sized for a README (diff) | |
| download | ida-tui-8fef561903e9501281ebcc58cdb33ee4d9116fd0.tar.gz ida-tui-8fef561903e9501281ebcc58cdb33ee4d9116fd0.tar.xz ida-tui-8fef561903e9501281ebcc58cdb33ee4d9116fd0.zip | |
docs: drop two stale files, correct the two the README links, cut sharp edges
README: "Known sharp edges" removed.
docs/GRAPH_VIEW.md pointed the graph's one backend call at
server/patch_server.py, a file the port deleted. It is
idatui/codemode_client.py now. This matters because GRAPH_VIEW.md is one of
only two docs the README links -- a wrong path in a linked doc is worse than
no doc.
docs/RPC.md was missing five verbs rpc.py serves: ping/methods/quit (now a
Session table) and trace/binaries/switch (with the semantic verbs). The trace
verb drives a whole feature the README advertises, so its absence was the real
gap. Every verb in rpc.py's METHODS table is now documented, checked
mechanically -- the remainder of what looked missing turned out to be values
of the "move" verb's dir parameter, not verbs.
Deleted:
- docs/CODEMODE_PORT.md. Written mid-port, and its Result section claims the
port covered "the complete current TUI feature set". It did not: the graph
view was dead, the operand-format keys were dead, pseudocode comments never
appeared, and bulk rename was broken. Keeping a doc that states the opposite
of what we found is worse than having none, and docs/CODEMODE_UPSTREAM.md
carries the accurate account of the API limits.
- docs/TUI_DRIVING_BLUEPRINT.md. A design sketch for generalizing the
drive-a-TUI-over-a-socket pattern to other programs, with gdb as the main
example -- which now exists for real in ~/dev/gdb-driver. Superseded by the
thing it proposed.
Nothing linked either file. Both remain in git history.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 10 |
1 files changed, 0 insertions, 10 deletions
@@ -161,16 +161,6 @@ flake, and the four ways a test here wastes minutes. - [`docs/RPC.md`](docs/RPC.md) — the RPC protocol, verb by verb - [`docs/GRAPH_VIEW.md`](docs/GRAPH_VIEW.md) — how the graph is laid out -## Known sharp edges - -- PLT/import stubs: following a libc symbol lands on `extrn X:near`, which - Hex-Rays can't decompile. No pretty-printing yet. -- Xref-select can land on the wrong line in the `x` popup. -- No "discard changes and quit": a managed worker saves when its last lease - closes, so the TUI can't promise your edits weren't persisted. -- A GUI user editing the same database won't invalidate our caches — Code Mode - has no change feed yet (see `docs/CODEMODE_UPSTREAM.md`). - — [sl0p.foo](https://sl0p.foo) |
