summaryrefslogtreecommitdiff
path: root/docs/typ/reference.typ
diff options
context:
space:
mode:
Diffstat (limited to 'docs/typ/reference.typ')
-rw-r--r--docs/typ/reference.typ22
1 files changed, 17 insertions, 5 deletions
diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ
index d3210814..a7db9e2d 100644
--- a/docs/typ/reference.typ
+++ b/docs/typ/reference.typ
@@ -254,7 +254,16 @@ A line written to #file("exec") is #word("Exec"):
- A line starting with `#` is a comment, as in a shell: it runs as nothing,
silently, here and in every ctl.
- The language server's words ask about a file pane's text at its cursor
- (set it with #file("addr") and `dot=addr` first): #word("Hover") fills
+ (set it with #file("addr") and `dot=addr` first). Each asks the nearest
+ `index.scip` above the file first (a SCIP index an indexer wrote, read
+ again once it changes; #word("Index") runs the file's indexer at its
+ project's root in a command pane) and the file's language server only
+ when the index has nothing to say: none above the file, a file it does
+ not hold, nothing indexed at the cursor, a symbol it does not know, a
+ pane with unsaved changes, or a word only a server answers (declaration,
+ #word("Diagnostics"), #word("Rename"), #word("CodeAction"), format,
+ completion). An index older than the file still answers, and says so
+ once on the message row. #word("Hover") fills
`+Hover`; #word("Def") and #word("Refs"), in the tag of a file a server
speaks for, are `gd` and `gr`, and given a symbol (a 2-1 chord's
selection) ask at its occurrence nearest the cursor; #word("Rename") `new` renames the symbol in the file and says how many
@@ -275,10 +284,13 @@ A line written to #file("exec") is #word("Exec"):
#word("Callers") and #word("Callees") keep their short
lists and single-result jumps.
#word("Diagnostics") and #word("Symbols") list the file's in `+Search`;
- #word("Lspinfo") fills `+Lsp`, the pane its write answers, with which
- server serves the file and its state (`not started yet` until its first
- query starts it, `<server> failed recently; retry in Ns` while it backs
- off);
+ #word("Lspinfo") fills `+Lsp`, the pane its write answers, with the
+ index the file asks (`scip: <path>, <size>, <documents>, <symbols>,
+ indexed <when>, <n> files newer`, or `scip: no index.scip above <dir>;
+ Index runs <indexer>`), which server serves it and its state (`not
+ started yet` until its first query starts it, `<server> failed recently;
+ retry in Ns` while it backs off), and what answered each query lately
+ (`scip`, or the server);
#word("Lspwhy") narrates the last query step by step (in `+Lsp`). The
write returns once the answer is in; a pane with no file is refused.
- acme's words run as pardes's where it has one (`Put` is #word("Save"),