From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 908B21581EC for ; Wed, 20 Nov 2024 21:53:15 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id DC2D9E085B; Wed, 20 Nov 2024 21:52:49 +0000 (UTC) Received: from smtp.gentoo.org (woodpecker.gentoo.org [140.211.166.183]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 8DF77E0856 for ; Wed, 20 Nov 2024 21:52:49 +0000 (UTC) From: xgqt@gentoo.org To: gentoo-dev@lists.gentoo.org Cc: dotnet@gentoo.org, =?UTF-8?q?Maciej=20Bar=C4=87?= Subject: [gentoo-dev] [PATCH 2/2] eclass/nuget: add eclassdoc that describes how to generate the NUGETS list Date: Wed, 20 Nov 2024 22:50:59 +0100 Message-ID: <20241120215226.86454-2-xgqt@gentoo.org> X-Mailer: git-send-email 2.45.2 In-Reply-To: <20241120215226.86454-1-xgqt@gentoo.org> References: <20241120215226.86454-1-xgqt@gentoo.org> Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Archives-Salt: 29508890-5012-4555-a708-91a76b2e3742 X-Archives-Hash: 9fe0f90c846dd9f5d1282761b73c0720 From: Maciej Barć Some users asked for it. Also add a link to the Gentoo Wiki with more specific examples. Signed-off-by: Maciej Barć --- 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: -- 2.45.2