Commit Graph

35 Commits

Author SHA1 Message Date
Janne Heß
fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
Janne Heß
bc77c7a973 treewide: Mark Nix blocks in markdown as Nix
This should help us with highlighting and future formatting.
2024-03-28 09:28:12 +01:00
Anderson Torres
e671d3bbbd Nix docs: remove with lib; from example code
Following [Best Practices](https://nix.dev/guides/best-practices#with-scopes),
`with` is a problematic language construction and should be avoided.

Usually it is employed like a "factorization": `[ X.A X.B X.C X.D ]` is written
`with X; [ A B C D ]`.

However, as shown in the link above, the syntatical rules of `with` are not so
intuitive, and this "distributive rule" is very selective, in the sense that
`with X; [ A B C D ]` is not equivalent to `[ X.A X.B X.C X.D ]`.

However, this factorization is still useful to "squeeze" some code, especially
in lists like `meta.maintainers`.

On the other hand, it becomes less justifiable in bigger scopes. This is
especially true in cases like `with lib;` in the top of expression and in sets
like `meta = with lib; { . . . }`.

That being said, this patch removes most of example code in the current
documentation.

The exceptions are, for now
- doc/functions/generators.section.md
- doc/languages-frameworks/coq.section.md

because, well, they are way more complicated, and I couldn't parse them
mentally - yet another reason why `with` should be avoided!
2024-03-06 11:40:09 -03:00
lychee
38048e0fbe
doc: clarify usage of nuget-to-nix in dotnet.section.md
I believe it would be helpful to better explain how to use
`nuget-to-nix` for those who aren't familar with the .NET ecosystem as I
was personally stumped on how to use it.
2024-02-04 14:08:11 -06:00
Sam
1cbd2ac8f8
doc: Fix typo in dotnet.section.md (#282685)
It should be `dotnetCorePackages.sdk_6_0`, not `dotnetCorePackages.sdk_6.0`
2024-01-25 16:06:58 +01:00
mdarocha
f1cc116e3d buildDotnetModule: make docs more clear on how to generate nugetDeps for the first time 2023-09-30 13:21:36 +02:00
Peder Bergebakken Sundt
470614b671 treewide: Fix typos 2023-09-28 19:06:13 +02:00
mdarocha
a36883ddfe maintainers: add dotnet team 2023-08-16 08:49:08 +02:00
David McFarland
ee8ba995a7 buildDotnetModule: make fetch-deps find output path automatically 2023-06-24 19:13:16 -03:00
mdarocha
c51141d997 buildDotnetModule: pass runtimeId whenever possible and disable trimming when not allowed.
This fixes up some build errors
2023-06-21 17:06:30 +02:00
mdarocha
0d9142d4df buildDotnetGlobalTool: document dotnet global tools and their packaging 2023-06-20 17:20:52 +02:00
mdarocha
abf6081bc2 buildDotnetModule: add useDotnetFromEnv option
This causes an alternative wrapper to be used, that takes the dotnet
runtime from the environment.
2023-06-20 17:20:51 +02:00
mdarocha
43f7cc0df7 dotnet-sdk_3: remove
Also remove all reference to outdated .NET versions.
2023-03-26 14:24:49 +02:00
mdarocha
d093086a2b buildDotnetModule: add support for using combinePackages as dotnet-sdk
This allows packages that require several dotnet versions to build (like
BeatSaberModManager) to properly depend on the dotnet-sdk specific deps.
This in turns avoids having to regenerate the deps of those packages
after each dotnet-sdk update.

This also changes nuget-to-nix to accept a file with a list of
exclusions instead of a folder.
2023-03-19 20:53:39 +01:00
mdarocha
5234f4ce93 dotnet-sdk_5: remove package
It's EOL and not used in nixpkgs anymore
2023-01-23 19:16:58 +01:00
David McFarland
824d40aa04 build-dotnet-module: restore for current runtime by default 2022-12-19 15:36:25 -04:00
Ivar Scholten
8e00d6ac26
buildDotnetModule: move nugetDeps throw to when its actually needed
Previously we had an assert that would complain when nugetDeps wasnt set,
which also didnt allow any passthru attributes (like fetch-deps) to be
build. That causes a cycle where you need nugetDeps to fetch the nuget
deps, but arent able to build the script to do so.
2022-09-18 18:00:37 +02:00
Ivar Scholten
03a1b62cb3
buildDotnetModule: dont require specifing a projectFile
In a lot of cases dotnet can figure this out by itself, so we can just
invoke it without the project argument.
2022-09-18 18:00:37 +02:00
mdarocha
124fa63a88 buildDotnetModule: add documentation about selfContained flag 2022-07-26 18:03:03 +02:00
zimbatm
ba2f31b6db
buildDotnetModule: allow passing derivations to nugetDeps
Sometimes I want to pass a different implementation of `mkNugetDeps`.
For example in private repos, it can be handy to use `__noChroot = true`
and bypass the deps.nix generation altogether. Or some Nuget packages
ship with ELF binaries that need to be patched, and that's best done as
soon as possible.
2022-06-21 15:45:52 +02:00
IvarWithoutBones
fcbd429742 buildDotnetModule: wrap executables in preFixup
Not doing this used to break wrapGAppsHook as gappsWrapperArgs is set in preFixup, but it was used in installPhase
2022-01-12 00:23:53 +01:00
IvarWithoutBones
e0b652c3cb buildDotnetModule: restore and build testProjectFile 2021-12-20 22:31:18 +01:00
IvarWithoutBones
8e11dcca48 buildDotnetModule: add passthru.fetch-deps 2021-12-14 20:24:18 +01:00
Evgeny Zemtsov
06477cccf7 buildDotnetModule: support local project references 2021-12-13 19:14:44 +01:00
Evgeny Zemtsov
a6d02a5214 buildDotnetModule: support optional nupkg packing 2021-12-13 19:13:40 +01:00
IvarWithoutBones
1b366cb92b buildDotnetModule: support setting projectFile as an array && properly interpret disabledTests 2021-11-21 22:47:53 +01:00
IvarWithoutBones
af339c5cf8 buildDotnetModule: add support for running unit tests 2021-11-01 02:06:54 +01:00
Pavol Rusnak
eca667180b
dotnet: cleanup; point dotnet-sdk alias to 5_0; remove unsupported SDKs 2021-10-18 23:46:17 +02:00
IvarWithoutBones
a87e6645dd buildDotnetModule: add documentation 2021-10-06 22:14:24 +02:00
Jan Tojnar
6ecc641d08
doc: prepare for commonmark
We are still using Pandoc’s Markdown parser, which differs from CommonMark spec slightly.

Notably:
- Line breaks in lists behave differently.
- Admonitions do not support the simpler syntax https://github.com/jgm/commonmark-hs/issues/75
- The auto_identifiers uses a different algorithm – I made the previous ones explicit.
- Languages (classes) of code blocks cannot contain whitespace so we have to use “pycon” alias instead of Python “console” as GitHub’s linguist

While at it, I also fixed the following issues:
- ShellSesssion was used
- Removed some pointless docbook tags.
2021-06-07 06:34:59 +02:00
Jonas Chevalier
c6b62f2381
mkShell: introduce packages argument (#122180)
The distinction between the inputs doesn't really make sense in the
mkShell context.  Technically speaking, we should be using the
nativeBuildInputs most of the time.

So in order to make this function more beginner-friendly, add "packages"
as an attribute, that maps to nativeBuildInputs.

This commit also updates all the uses in nixpkgs.
2021-05-13 19:17:29 +02:00
Sandro Jäckel
2c143a4614 doc/languages-frameworks/*: add missing languages to code fences
convert shell -> ShellSession
2021-04-05 05:23:19 +02:00
Florian Engel
3329093c6a Remove repeating words from doc 2021-03-14 12:15:34 +01:00
Felix Tenley
a94cc8dc92 dotnet: document new net packages 2020-11-11 15:35:23 -08:00
Jonathan Ringer
519519b6fc dotnet: add framework doc 2020-02-09 19:26:15 -08:00