Write some docs #76

jade · 2025-03-31T23:27:58Z

jade commented

2025-03-31 23:27:58 +00:00

Also corrects the given default.nix to correctly follow the flake
schema. Previously it didn't understand that the root node's
flake-compat might not be called flake-compat if there exists a
flake-compat in the lock file as a dependency of some other flake.

Also corrects the given `default.nix` to correctly follow the flake schema. Previously it didn't understand that the root node's flake-compat might not be called `flake-compat` if there exists a `flake-compat` in the lock file as a dependency of some other flake.

👍 1

jade added 1 commit

2025-03-31 23:27:59 +00:00

Write some docs 2b02dc4d97

Also corrects the given `default.nix` to correctly follow the flake
schema. Previously it didn't understand that the root node's
flake-compat might not be called `flake-compat` if there exists a
`flake-compat` in the lock file as a dependency of some other flake.

requested review from winter

2025-03-31 23:28:04 +00:00

winter reviewed

2025-04-09 18:37:17 +00:00

winter left a comment

Overall good, just a few questions/nits.

README.md Outdated

					
				@ -7,3 +7,3 @@

				```nix

				inputs.flake-compat = {

				  url = "git+https://git.lix.systems/lix-project/flake-compat";

				  url = "https://git.lix.systems/lix-project/flake-compat/archive/main.tar.gz";

winter commented

2025-04-09 18:35:24 +00:00

Curious: why?

jalil-salame commented

2025-04-13 10:53:23 +00:00

First-time contributor

My assumption is that its because it uses the Lockable HTTP Tarball Protocol if you do this, which is a much more efficient way of downloading the source of a repo.

My assumption is that its because it uses the [Lockable HTTP Tarball Protocol](https://docs.lix.systems/manual/lix/stable/protocols/tarball-fetcher.html) if you do this, which is a much more efficient way of downloading the source of a repo.

👍 1

winter marked this conversation as resolved

README.md Outdated

					
				@ -27,0 +30,4 @@

				      # to the store (but not obey gitignore anymore and possibly leak paths in

				      # your eval directory into things!). We strongly recommend nix-diff after

				      # setting this to false.

				      copySourceTreeToStore = true;

winter commented

2025-04-09 18:36:23 +00:00

Since the default is true, perhaps we should just drop this here and move it to the options reference, for simplicity? This options enables dragons, after all.

Since the default is `true`, perhaps we should just drop this here and move it to the options reference, for simplicity? This options enables dragons, after all.

jade marked this conversation as resolved

README.md Outdated

					
				@ -34,0 +53,4 @@

				  See [Copying to the store](#copying-to-the-store).

				  Default: `true`.

				- `useBuiltinsFetchTree` - whether to use `builtins.fetchTree` in place of flake-compat's Nix language implementation of it.

				  If enabled and if `builtins.fetchTree` is present, it will be used.