summary refs log tree commit diff
path: root/doc/languages-frameworks
diff options
context:
space:
mode:
authorhacker1024 <hacker1024@users.sourceforge.net>2023-10-21 22:30:23 +1100
committerhacker1024 <hacker1024@users.sourceforge.net>2023-10-21 22:30:23 +1100
commit6298ac27745cbab2dd3895c2c25ad3a795310f78 (patch)
tree6a03d7c50993c52243eb0a35dd4a82bb58b4998e /doc/languages-frameworks
parent234b63b0f0668770f9136eb06c718787aed4d342 (diff)
downloadnixpkgs-6298ac27745cbab2dd3895c2c25ad3a795310f78.tar
nixpkgs-6298ac27745cbab2dd3895c2c25ad3a795310f78.tar.gz
nixpkgs-6298ac27745cbab2dd3895c2c25ad3a795310f78.tar.bz2
nixpkgs-6298ac27745cbab2dd3895c2c25ad3a795310f78.tar.lz
nixpkgs-6298ac27745cbab2dd3895c2c25ad3a795310f78.tar.xz
nixpkgs-6298ac27745cbab2dd3895c2c25ad3a795310f78.tar.zst
nixpkgs-6298ac27745cbab2dd3895c2c25ad3a795310f78.zip
buildDartApplication: Use package override mechanism from buildFlutterApplication
This allows Dart applications to benefit from the package override system, which is useful for things like FFI dependencies.
Diffstat (limited to 'doc/languages-frameworks')
-rw-r--r--doc/languages-frameworks/dart.section.md7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/languages-frameworks/dart.section.md b/doc/languages-frameworks/dart.section.md
index b00327b78eb..8d9c062f422 100644
--- a/doc/languages-frameworks/dart.section.md
+++ b/doc/languages-frameworks/dart.section.md
@@ -12,6 +12,8 @@ If you are packaging a Flutter desktop application, use [`buildFlutterApplicatio
 
 If the upstream source is missing a `pubspec.lock` file, you'll have to vendor one and specify it using `pubspecLockFile`. If it is needed, one will be generated for you and printed when attempting to build the derivation.
 
+The `depsListFile` must always be provided when packaging in Nixpkgs. It will be generated and printed if the derivation is attempted to be built without one. Alternatively, `autoDepsList` may be set to `true` only when outside of Nixpkgs, as it relies on import-from-derivation.
+
 The `dart` commands run can be overridden through `pubGetScript` and `dartCompileCommand`, you can also add flags using `dartCompileFlags` or `dartJitFlags`.
 
 Dart supports multiple [outputs types](https://dart.dev/tools/dart-compile#types-of-output), you can choose between them using `dartOutputType` (defaults to `exe`). If you want to override the binaries path or the source path they come from, you can use `dartEntryPoints`. Outputs that require a runtime will automatically be wrapped with the relevant runtime (`dartaotruntime` for `aot-snapshot`, `dart run` for `jit-snapshot` and `kernel`, `node` for `js`), this can be overridden through `dartRuntimeCommand`.
@@ -31,6 +33,7 @@ buildDartApplication rec {
   };
 
   pubspecLockFile = ./pubspec.lock;
+  depsListFile = ./deps.json;
   vendorHash = "sha256-Atm7zfnDambN/BmmUf4BG0yUz/y6xWzf0reDw3Ad41s=";
 }
 ```
@@ -39,9 +42,7 @@ buildDartApplication rec {
 
 The function `buildFlutterApplication` builds Flutter applications.
 
-The deps.json file must always be provided when packaging in Nixpkgs. It will be generated and printed if the derivation is attempted to be built without one. Alternatively, `autoDepsList` may be set to `true` when outside of Nixpkgs, as it relies on import-from-derivation.
-
-A `pubspec.lock` file must be available. See the [Dart documentation](#ssec-dart-applications) for more details.
+See the [Dart documentation](#ssec-dart-applications) for more details on required files and arguments.
 
 ```nix
 {  flutter, fetchFromGitHub }: