Unverified Commit 97b0ae26 authored Nov 09, 2023 by Arnout Engelen Committed by GitHub Nov 09, 2023

doc: avoid 'simply' (#266434)

While the word 'simply' is usually added to encourage readers, it often has the
opposite effect and may even appear condescending, especially when the reader
runs into trouble trying to apply the suggestions from the documentation. It is
almost always an improvement to simply drop the word from the sentence.

(there are more possible improvements like this, we can apply those in separate
PRs)

parent 3dc0248d

doc/hooks/autopatchelf.section.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -6,6 +6,6 @@ You can also specify a `runtimeDependencies` variable which lists dependencies t

		In certain situations you may want to run the main command (`autoPatchelf`) of the setup hook on a file or a set of directories instead of unconditionally patching all outputs. This can be done by setting the `dontAutoPatchelf` environment variable to a non-empty value.

		By default `autoPatchelf` will fail as soon as any ELF file requires a dependency which cannot be resolved via the given build inputs. In some situations you might prefer to just leave missing dependencies unpatched and continue to patch the rest. This can be achieved by setting the `autoPatchelfIgnoreMissingDeps` environment variable to a non-empty value. `autoPatchelfIgnoreMissingDeps` can be set to a list like `autoPatchelfIgnoreMissingDeps = [ "libcuda.so.1" "libcudart.so.1" ];` or to simply `[ "*" ]` to ignore all missing dependencies.
		By default `autoPatchelf` will fail as soon as any ELF file requires a dependency which cannot be resolved via the given build inputs. In some situations you might prefer to just leave missing dependencies unpatched and continue to patch the rest. This can be achieved by setting the `autoPatchelfIgnoreMissingDeps` environment variable to a non-empty value. `autoPatchelfIgnoreMissingDeps` can be set to a list like `autoPatchelfIgnoreMissingDeps = [ "libcuda.so.1" "libcudart.so.1" ];` or to `[ "*" ]` to ignore all missing dependencies.

		The `autoPatchelf` command also recognizes a `--no-recurse` command line flag, which prevents it from recursing into subdirectories.

doc/languages-frameworks/agda.section.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -146,7 +146,7 @@ agdaPackages.mkDerivation {

		### Building Agda packages {#building-agda-packages}

		The default build phase for `agdaPackages.mkDerivation` simply runs `agda` on the `Everything.agda` file.
		The default build phase for `agdaPackages.mkDerivation` runs `agda` on the `Everything.agda` file.
		If something else is needed to build the package (e.g. `make`) then the `buildPhase` should be overridden.
		Additionally, a `preBuild` or `configurePhase` can be used if there are steps that need to be done prior to checking the `Everything.agda` file.
		`agda` and the Agda libraries contained in `buildInputs` are made available during the build phase.
		@@ -250,7 +250,7 @@ Usually, the maintainers will answer within a week or two with a new release.
		Bumping the version of that reverse dependency should be a further commit on your PR.

		In the rare case that a new release is not to be expected within an acceptable time,
		simply mark the broken package as broken by setting `meta.broken = true;`.
		mark the broken package as broken by setting `meta.broken = true;`.
		This will exclude it from the build test.
		It can be added later when it is fixed,
		and does not hinder the advancement of the whole package set in the meantime.

doc/languages-frameworks/beam.section.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -44,7 +44,7 @@ There is also a `buildMix` helper, whose behavior is closer to that of `buildErl

		## How to Install BEAM Packages {#how-to-install-beam-packages}

		BEAM builders are not registered at the top level, simply because they are not relevant to the vast majority of Nix users.
		BEAM builders are not registered at the top level, because they are not relevant to the vast majority of Nix users.
		To use any of those builders into your environment, refer to them by their attribute path under `beamPackages`, e.g. `beamPackages.rebar3`:

		::: {.example #ex-beam-ephemeral-shell}

doc/languages-frameworks/dart.section.md

+1 −1

Original line number	Diff line number	Diff line
		@@ -8,7 +8,7 @@ It fetches its Dart dependencies automatically through `fetchDartDeps`, and (thr

		If you are packaging a Flutter desktop application, use [`buildFlutterApplication`](#ssec-dart-flutter) instead.

		`vendorHash`: is the hash of the output of the dependency fetcher derivation. To obtain it, simply set it to `lib.fakeHash` (or omit it) and run the build ([more details here](#sec-source-hashes)).
		`vendorHash`: is the hash of the output of the dependency fetcher derivation. To obtain it, set it to `lib.fakeHash` (or omit it) and run the build ([more details here](#sec-source-hashes)).

		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.

doc/languages-frameworks/haskell.section.md

+2 −2

Original line number	Diff line number	Diff line
		@@ -177,7 +177,7 @@ exactly one version. Those versions need to satisfy all the version constraints
		given in the `.cabal` file of your package and all its dependencies.

		The [Haskell builder in nixpkgs](#haskell-mkderivation) does no such thing.
		It will simply take as input packages with names off the desired dependencies
		It will take as input packages with names off the desired dependencies
		and just check whether they fulfill the version bounds and fail if they don’t
		(by default, see `jailbreak` to circumvent this).

		@@ -780,7 +780,7 @@ there instead.
		The top level `pkgs.haskell-language-server` attribute is just a convenience
		wrapper to make it possible to install HLS for multiple GHC versions at the
		same time. If you know, that you only use one GHC version, e.g., in a project
		specific `nix-shell` you can simply use
		specific `nix-shell` you can use
		`pkgs.haskellPackages.haskell-language-server` or
		`pkgs.haskell.packages.*.haskell-language-server` from the package set you use.