Skip to content

Commit cd984ba

Browse files
committed
Update docs re: git dependencies
1 parent e1c76c0 commit cd984ba

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

lib/mix/tasks/deps.nix.ex

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,12 @@ defmodule Mix.Tasks.Deps.Nix do
4242
4343
`deps_nix` supports git dependencies.
4444
45-
`builtins.fetchGit` is used, which doesn't require any prefetching and relies
46-
on the git SHA as a unique identifier.
45+
For open-source GitHub dependencies, `pkgs.fetchFromGitHub` is used. Hashes
46+
are prefetched using [Mint](https://hexdocs.pm/mint) and hashed using `nix hash path`.
47+
48+
`builtins.fetchGit` is used for non-GitHub projects, which doesn't require
49+
any prefetching and relies on the git SHA as a unique identifier. However, it
50+
suffers from [several disadvantages](https://discourse.nixos.org/t/fetchgit-vs-fetchgit/23325).
4751
"""
4852

4953
@shortdoc "Produce nix derivations for mix dependencies"

0 commit comments

Comments
 (0)