backport :doc in repl #27

New issue

Closed

opened 2024-03-13 18:40:57 +00:00 by jade · 6 comments

jade commented

2024-03-13 18:40:57 +00:00

Owner

hmmm there's two? https://github.com/NixOS/nix/pull/9054
https://github.com/NixOS/nix/pull/8778

also might depend on parser work..... anyway. filing this nonetheless.

hmmm there's two? https://github.com/NixOS/nix/pull/9054 https://github.com/NixOS/nix/pull/8778 also might depend on parser work..... anyway. filing this nonetheless.

jade commented

2024-03-13 18:42:42 +00:00

Author

Owner

(cc @pennae as it's parser related)

jade added the

label 2024-03-13 18:43:56 +00:00

pennae commented

2024-03-13 19:36:03 +00:00

Owner

oof

*oof*

jade added this to the v2.91 milestone 2024-03-14 06:34:42 +00:00

jade commented

2024-03-14 06:34:54 +00:00

Author

Owner

Blocked on parser rewrite so marked as v2.91 at minimum

jade commented

2024-03-14 18:58:36 +00:00

Author

Owner

OK plan devised on matrix with @lunaphied and @puck: simply statically or shared-link the rust side of nix-doc, which we compile with nix, into nix, to avoid fucking with the make build system. Then invoke it with :doc in the repl.

This is a very silly solution because it is literally adding a second Nix parser to Nix, but it is an extremely easy win with extremely deletable code (the API surface we use is two functions) when we solve it properly and basically no actual disadvantages aside from being ugly.

OK plan devised on matrix with @lunaphied and @puck: simply statically or shared-link the *rust side of* nix-doc, which we compile with nix, into nix, to avoid fucking with the make build system. Then invoke it with `:doc` in the repl. This is a very silly solution because it is literally adding a second Nix parser to Nix, but it is an extremely easy win with extremely deletable code (the API surface we use is two functions) when we solve it properly and basically no actual disadvantages aside from being ugly.

jade commented

2024-03-14 19:27:14 +00:00

Author

Owner

Implementation steps:

Yoink lf-/nix-doc into a subdir in here
Make this into a staticlib output, build it with nix: fff1c0b3cc/plugin/src/lib.rs (L1-L20)
Tree-shake the entire rest of the program into nothingness
Static link our forked nix-doc in lix
Make :doc in repl invoke this function.
Write some tests

Implementation steps: * Yoink lf-/nix-doc into a subdir in here * Make this into a staticlib output, build it with nix: https://github.com/lf-/nix-doc/blob/fff1c0b3cce58383599195d5628f4abf009e9ba9/plugin/src/lib.rs#L1-L20 * Tree-shake the entire rest of the program into nothingness * Static link our forked nix-doc in lix * Make `:doc` in repl invoke this function. * Write some tests

jade commented

2024-04-08 03:48:27 +00:00

Author

Owner

https://gerrit.lix.systems/c/lix/+/564

jade closed this issue

2024-04-08 03:48:27 +00:00