summaryrefslogtreecommitdiff
path: root/eclass
diff options
context:
space:
mode:
authorMaciej Barć <xgqt@gentoo.org>2024-11-20 22:43:10 +0100
committerMaciej Barć <xgqt@gentoo.org>2024-11-26 02:44:57 +0100
commit19097e3b12aef083f542c88bafe01303f5d61fbf (patch)
tree72cc17d6e7dde0712e7a0d9d02c3e6f025d80fab /eclass
parenteclass/dotnet-pkg-base: disable MSBUILDTERMINALLOGGER from .NET 9.0 (diff)
downloadgentoo-19097e3b12aef083f542c88bafe01303f5d61fbf.tar.gz
gentoo-19097e3b12aef083f542c88bafe01303f5d61fbf.tar.bz2
gentoo-19097e3b12aef083f542c88bafe01303f5d61fbf.zip
eclass/nuget: add eclassdoc that describes how to generate the NUGETS list
Some users asked for it. Also add a link to the Gentoo Wiki with more specific examples. Signed-off-by: Maciej Barć <xgqt@gentoo.org>
Diffstat (limited to 'eclass')
-rw-r--r--eclass/nuget.eclass15
1 files changed, 15 insertions, 0 deletions
diff --git a/eclass/nuget.eclass b/eclass/nuget.eclass
index 4efbeb909f43..3fa732e79b5f 100644
--- a/eclass/nuget.eclass
+++ b/eclass/nuget.eclass
@@ -71,6 +71,21 @@ export NUGET_PACKAGES
# @DESCRIPTION:
# String containing all NuGet packages that need to be downloaded.
#
+# To generate the "NUGETS" list use the "gdmt restore" tool from the
+# "dev-dotnet/gentoo-dotnet-maintainer-tools" package. To see all "gdmt restore"
+# options invoke it with the "--help" flag. The Gentoo Wiki page
+# Dotnet/Devguide (https://wiki.gentoo.org/wiki/Dotnet/Devguide) contains some
+# examples and special cases to be beware of.
+#
+# Generally you will want to invoke "gdmt restore" form within a (clean) tagged
+# checkout of a given .NET-based project. The invocation will look something
+# like this: gdmt restore --sdk-ver SDK-VER --cache "$(pwd)/.cache" --project PROJECT
+# Where:
+# * "SDK-VER" is a .NET version (6.0, 8.0), mind the full version, "8" is not allowed,
+# * "PROJECT" is a given project file (.csproj or .fsproj) or a directory containing it.
+# So, for example:
+# gdmt restore --sdk-ver 8.0 --cache "$(pwd)/.cache" --project src/App/App.csproj
+#
# Used by "_nuget_uris".
#
# Example: