diff options
author | YoshiRulz | 2024-06-25 00:15:29 +1000 |
---|---|---|
committer | YoshiRulz | 2024-06-26 06:17:53 +1000 |
commit | 5c3f56c32a4c0897b88db692866ec2575332adc5 (patch) | |
tree | 5a177d792ac05ce03c74c9b060418e471f3ceb95 /doc | |
parent | 3da824d0b1fcc874bfb26412139949fb47cc10f4 (diff) |
doc: Update note under `buildDotnetModule` to reflect actual behaviour
Diffstat (limited to 'doc')
-rw-r--r-- | doc/languages-frameworks/dotnet.section.md | 15 |
1 files changed, 9 insertions, 6 deletions
diff --git a/doc/languages-frameworks/dotnet.section.md b/doc/languages-frameworks/dotnet.section.md index 7466c8cdc228..350cf33200bd 100644 --- a/doc/languages-frameworks/dotnet.section.md +++ b/doc/languages-frameworks/dotnet.section.md @@ -142,9 +142,7 @@ in buildDotnetModule rec { src = ./.; projectFile = "src/project.sln"; - # File generated with `nix-build -A package.passthru.fetch-deps`. - # To run fetch-deps when this file does not yet exist, set nugetDeps to null - nugetDeps = ./deps.nix; + nugetDeps = ./deps.nix; # see "Generating and updating NuGet dependencies" section for details projectReferences = [ referencedProject ]; # `referencedProject` must contain `nupkg` in the folder structure. @@ -220,6 +218,12 @@ buildDotnetGlobalTool { ``` ## Generating and updating NuGet dependencies {#generating-and-updating-nuget-dependencies} +When writing a new expression, you can use the generated `fetch-deps` script to initialise the lockfile. +After creating a blank `deps.nix` and pointing `nugetDeps` to it, +build the script with `nix-build -A package.fetch-deps` and then run the result. +(When the root attr is your package, it's simply `nix-build -A fetch-deps`.) + +There is also a manual method: First, restore the packages to the `out` directory, ensure you have cloned the upstream repository and you are inside it. @@ -255,6 +259,5 @@ Finally, you move the `deps.nix` file to the appropriate location to be used by If you ever need to update the dependencies of a package, you instead do * `nix-build -A package.fetch-deps` to generate the update script for `package` -* Run `./result deps.nix` to regenerate the lockfile to `deps.nix`, keep in mind if a location isn't provided, it will write to a temporary path instead -* Finally, move the file where needed and look at its contents to confirm it has updated the dependencies. - +* Run `./result` to regenerate the lockfile to the path passed for `nugetDeps` (keep in mind if it can't be resolved to a local path, the script will write to `$1` or a temporary path instead) +* Finally, ensure the correct file was written and the derivation can be built. |