From patchwork Sun Jan 9 19:10:03 2022 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: M X-Patchwork-Id: 36186 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id C5F1827BBEA; Sun, 9 Jan 2022 19:11:51 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,FREEMAIL_FROM,MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H3, RCVD_IN_MSPIKE_WL,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 7277D27BBE9 for ; Sun, 9 Jan 2022 19:11:51 +0000 (GMT) Received: from localhost ([::1]:40082 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1n6dbZ-00028c-12 for patchwork@mira.cbaines.net; Sun, 09 Jan 2022 14:11:49 -0500 Received: from eggs.gnu.org ([209.51.188.92]:54294) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1n6dao-0001Zy-7I for guix-patches@gnu.org; Sun, 09 Jan 2022 14:11:02 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:58429) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1n6dan-00068A-V6 for guix-patches@gnu.org; Sun, 09 Jan 2022 14:11:01 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1n6dan-0007lu-QV for guix-patches@gnu.org; Sun, 09 Jan 2022 14:11:01 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#53144] [PATCH 01/13] doc: Give some tips on Minetest packaging. References: <0498a1400cfa72db28da35e46d64bf6e1267b3d7.camel@telenet.be> In-Reply-To: <0498a1400cfa72db28da35e46d64bf6e1267b3d7.camel@telenet.be> Resent-From: Maxime Devos Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sun, 09 Jan 2022 19:11:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 53144 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 53144@debbugs.gnu.org Cc: Maxime Devos Received: via spool by 53144-submit@debbugs.gnu.org id=B53144.164175542029682 (code B ref 53144); Sun, 09 Jan 2022 19:11:01 +0000 Received: (at 53144) by debbugs.gnu.org; 9 Jan 2022 19:10:20 +0000 Received: from localhost ([127.0.0.1]:51286 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n6da7-0007ib-Jw for submit@debbugs.gnu.org; Sun, 09 Jan 2022 14:10:19 -0500 Received: from xavier.telenet-ops.be ([195.130.132.52]:49144) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1n6da6-0007iQ-Ih for 53144@debbugs.gnu.org; Sun, 09 Jan 2022 14:10:19 -0500 Received: from localhost.localdomain ([188.188.180.65]) by xavier.telenet-ops.be with bizsmtp id gjAG2600J1R3YAc01jAHrm; Sun, 09 Jan 2022 20:10:17 +0100 From: Maxime Devos Date: Sun, 9 Jan 2022 19:10:03 +0000 Message-Id: <20220109191015.33058-1-maximedevos@telenet.be> X-Mailer: git-send-email 2.34.0 MIME-Version: 1.0 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=telenet.be; s=r22; t=1641755417; bh=e71yQUMfNEbdomYy27kIuF7SCJpK6wgxM+AZ31AwVgE=; h=From:To:Cc:Subject:Date; b=oUUN2HaU441kfjTPWwqI26E8fLlQ93uPORSzg6VBI8AoV3TU6G7Y5C9WFaFPrGugl c6/sSjX5OUaeqvtSYXTrdzB9mIo9O756aAbNS8dLU8Sm4ZdjCfpbwBSEnz/99mZ0fm fITtK00L4iVrVo+WlVz/8ozc6+FkJidAxFQ2Wa3du1oKUm55NVatsULHIoBfXuGHAP E6Y7JF71RsXa0wfpG7EiqOig9eQsZr1KXKUjHR+V9oru/2Mygl04CSMAjtOcrezDGR 5r84atigyj1BkBrl6Thtf7tN36HCqHHcJAnaGcWJwwety41c0bCa8nVX5fQnbFbdwK LrmHQzl57aQQQ== X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: "Guix-patches" X-getmail-retrieved-from-mailbox: Patches * doc/contributing.texi (Minetest Packages): New section. * doc/guix.texi: Copyright update. --- doc/contributing.texi | 42 ++++++++++++++++++++++++++++++++++++++++++ doc/guix.texi | 2 +- 2 files changed, 43 insertions(+), 1 deletion(-) base-commit: 9fd4f4b09cc0495d6b1418f171ff738a1086cc00 diff --git a/doc/contributing.texi b/doc/contributing.texi index 72f5ce1e0e..5b91fc7867 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -394,6 +394,7 @@ needed is to review and apply the patch. * Synopses and Descriptions:: Helping users find the right package. * Snippets versus Phases:: Whether to use a snippet, or a build phase. * Emacs Packages:: Your Elisp fix. +* Minetest Packages:: Building blocks. * Python Modules:: A touch of British comedy. * Perl Modules:: Little pearls. * Java Packages:: Coffee break. @@ -703,6 +704,47 @@ When encountering problems, it is wise to check for the presence of the file, and whether any dependencies and their versions listed therein are satisfied. +@node Minetest Packages +@subsection Minetest Packages +@cindex minetest, packaging + +A Minetest mod @code{foo} is named @code{minetest-foo} -- the author +name from ContentDB is not included, unless required to resolve a name +collision. + +Sometimes, it might be unclear what the version of a Minetest mod is. +For example, ContentDB and the importer reports 2020-01-01, but +according to the forums the version is 2.1. Usually, in these cases the +version on ContentDB is the newest and intended for distribution. As +such, you can use the version from ContentDB without any special +comments. + +@c Currently it's always checked out from git, but in principle +@c tarballs could be used. + +Even though the source code is often checked out from version control, +it is not necessary to use @code{git-version} or @code{hg-version}: the +releases on ContentDB are formal releases; in fact they are upstream's +official source of Minetest packages and they are not mutated in-place. + +@c Example (zip): mods by TenPlus1 +@c Example (git): basic_materials, ethereal +While ContentDB provides the source code of packages in zip form, it is +recommended not to use these, because users can and do delete old +versions. Likewise, sometimes the maintainer initially did tag versions +but later stops doing so, breaking @command{guix refresh -u}. As such, +it is recommended not to use git tags in @code{origin} records and +instead refer to the commit directly. + +The dependency information from ContentDB is usually correct. However, +sometimes to actually use a Minetest mod, an additional non-declared +Minetest mod is required. For example, to craft an item from a mod +@code{minetest-basic-materials} in non-creative mode, an item from the +mod @code{minetest-moreores} is required. In such situations, it is +recommended to add @code{minetest-moreores} to the inputs of +@code{minetest-basic-materials}. The dependencies go into +@code{propagated-inputs}. + @node Python Modules @subsection Python Modules diff --git a/doc/guix.texi b/doc/guix.texi index 08e5bfa111..0e19285c1c 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -88,7 +88,7 @@ Copyright @copyright{} 2020 Daniel Brooks@* Copyright @copyright{} 2020 John Soo@* Copyright @copyright{} 2020 Jonathan Brielmaier@* Copyright @copyright{} 2020 Edgar Vincent@* -Copyright @copyright{} 2021 Maxime Devos@* +Copyright @copyright{} 2021, 2022 Maxime Devos@* Copyright @copyright{} 2021 B. Wilson@* Copyright @copyright{} 2021 Xinglu Chen@* Copyright @copyright{} 2021 Raghav Gururajan@*