From: Maciej Barć <xgqt@gentoo.org>

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>
---
eclass/nuget.eclass | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)

diff --git a/eclass/nuget.eclass b/eclass/nuget.eclass
index 4efbeb909f..3ad22fda2b 100644
--- a/eclass/nuget.eclass
+++ b/eclass/nuget.eclass
@@ -71,6 +71,24 @@ 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
+# 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),

On Wed, 2024-11-20 at 22:50 +0100, xgqt@gentoo.org wrote:

From: Maciej Barć <xgqt@gentoo.org>

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>
---
eclass/nuget.eclass | 18 ++++++++++++++++++
1 file changed, 18 insertions(+)

diff --git a/eclass/nuget.eclass b/eclass/nuget.eclass
index 4efbeb909f..3ad22fda2b 100644
--- a/eclass/nuget.eclass
+++ b/eclass/nuget.eclass
@@ -71,6 +71,24 @@ 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
+# 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
+#
+# When formatting the "NUGETS" list it is better to not indent it,
+# but it can be indented with single tab.
+#
# Used by "_nuget_uris".
#
# Example:

Nice! I did this once, and then totally forgot how to do it the next time.

-----BEGIN PGP SIGNATURE-----

iQJFBAABCAAvFiEEPxcZ3tkwcedKm2a8EiZBXQDdMTcFAmc+ZsgRHGNoZXdpQGdl bnRvby5vcmcACgkQEiZBXQDdMTcHGhAApjb9l8vJYTBzhFjIKS57pLW195HOYjSJ 7bvQu20gC1+kqF7rfsr5VQd6gW8N6XccFHXSAAyo6xDWU2rEeEwXPck+59yiGcdQ QyoDkIxk3PyYANPYzwXturaTyM3AFQvrbs9z1q7DX+xIaF7uowsCU26ScgMoeqkX SRZKh5E66l2GV6/9pujjxrl0AZr0qGH4HA+VAjWno7MpEBB68YYfS5/wV4dc17zZ TfjNKIe7wGzlhauoBZ7s5hVDuPICQK9MT/7YK4Y2WL6pscii8hUTnpuwxd+DOcTV zGfsWaaDgrylb+s+RNY0Ou6SBafbDN+OJioM3bHXz1HS1ZHHlmpH06nUxeHixrMc YuOriYu9XRvcvZ7YtnkQZFyxtwSOfEy8mWr6V0C34P14wr73j4O+li/cIRSfZdBs TNO8/d2FGhV4f8REfvc5igJx0KZW2K3mmxDH1D+NKIdmF5v89ffpRzt9sBb9RSZ2 aoBkWRGmgCuQaKc6kxM8whWB6FkOcW+WI9pcINj8G2JYNhJdDLJBkr61CDnHc9bQ sipXr0ZvhM/Sw4MhXqw7Q67GKjydwQMI55o4MbuvY+aaAaRv8j2BLfgsgKeb4IHZ SPZYN4fnLQOxNCw5lxnmT5F1Rwbwl6bYoJWKPgMgd5MgoSskVvb8hug3xFzZ8pVC
Qc9euyKAb8A=
=zGlt
-----END PGP SIGNATURE-----

--- SoupGate-Win32 v1.05
* Origin: fsxNet Usenet Gateway (21:1/5)

Hi,

On 21/11/24 07:50, xgqt@gentoo.org wrote:

+# When formatting the "NUGETS" list it is better to not indent it,
+# but it can be indented with single tab.

This seems at-odds with the general style of ebuilds in ::gentoo.
Looking at CRATES as an example of a similar variable, this is
almost always indented, as is the content of any other multiline
string (e.g. SRC_URI). The now-deprecated EGO_SUM var was also
by-convention indented (though it was an array...).

Is there any existing policy that favours one of these over the
other?

LGTM otherwise; better documentation is always good!

Cheers,

Matt

--- SoupGate-Win32 v1.05
* Origin: fsxNet Usenet Gateway (21:1/5)