From patchwork Sat Sep 28 21:28:51 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Nicolas Graves X-Patchwork-Id: 31540 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 8EFD727BBEA; Sat, 28 Sep 2024 23:02:11 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-6.4 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_DNSWL_BLOCKED, RCVD_IN_VALIDITY_CERTIFIED,RCVD_IN_VALIDITY_RPBL,RCVD_IN_VALIDITY_SAFE, SPF_HELO_PASS,URIBL_BLOCKED autolearn=ham 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 C414A27BBE2 for ; Sat, 28 Sep 2024 23:02:10 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sufVP-0000dS-AH; Sat, 28 Sep 2024 18:01:35 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sufVN-0000cr-GC for guix-patches@gnu.org; Sat, 28 Sep 2024 18:01:33 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sufVN-0004va-6Q for guix-patches@gnu.org; Sat, 28 Sep 2024 18:01:33 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:Date:From:To:Subject; bh=/fF+Y4eFHJDZaETfEhePW7jjp0ZCQrjCUvsfVR5hnuI=; b=KGKgr1p95gjBWhlOdgLbjyZkExodirehSngsCBxCkJ0qOJycdbXcDUtlYZj3WXgodlW092SX48F3xEgg0O4HUkf6Sx2qW/Hpwy8drNojoYsGjN1bA7aF5TIMtdBQv8kOSb1Cxx1zH60/iX1ntQRHlwVrBUeXixr+eNgTRcAA6CIql2jY4uHCuDbVfUWmlfkFbNSHog2lIs/T0KD46fwTluq2cQiML9E/v+Sy39YJDdJr4uJrRCiLgn73OexIFkzS+CQp6v3Mb3+F+c15iGe6lm9PGRP4Rv1T1GdIQnfYvmijbtATd5ilAxLd2EnwUv8KMamJ3C1by8yaROrxBoqn6A==; Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sufVr-00035F-H2 for guix-patches@gnu.org; Sat, 28 Sep 2024 18:02:03 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#73535] [PATCH] doc: Update snippets documentation. Resent-From: Nicolas Graves Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 28 Sep 2024 22:02:03 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 73535 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 73535@debbugs.gnu.org Cc: Nicolas Graves X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.172756090911766 (code B ref -1); Sat, 28 Sep 2024 22:02:03 +0000 Received: (at submit) by debbugs.gnu.org; 28 Sep 2024 22:01:49 +0000 Received: from localhost ([127.0.0.1]:49301 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sufVc-00033c-Iu for submit@debbugs.gnu.org; Sat, 28 Sep 2024 18:01:49 -0400 Received: from lists.gnu.org ([209.51.188.17]:41694) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sufVW-00032B-RT for submit@debbugs.gnu.org; Sat, 28 Sep 2024 18:01:43 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1suezu-0005Zf-GN for guix-patches@gnu.org; Sat, 28 Sep 2024 17:29:02 -0400 Received: from 10.mo576.mail-out.ovh.net ([46.105.73.241]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1suezs-0000hl-Fs for guix-patches@gnu.org; Sat, 28 Sep 2024 17:29:02 -0400 Received: from director3.ghost.mail-out.ovh.net (unknown [10.108.9.150]) by mo576.mail-out.ovh.net (Postfix) with ESMTP id 4XGL7F454pz1s8K for ; Sat, 28 Sep 2024 21:28:57 +0000 (UTC) Received: from ghost-submission-55b549bf7b-scq9d (unknown [10.108.54.28]) by director3.ghost.mail-out.ovh.net (Postfix) with ESMTPS id 2D8581FD6A; Sat, 28 Sep 2024 21:28:56 +0000 (UTC) Received: from ngraves.fr ([37.59.142.109]) by ghost-submission-55b549bf7b-scq9d with ESMTPSA id naGbJRh1+Ga1vigApQbqFA (envelope-from ); Sat, 28 Sep 2024 21:28:56 +0000 Authentication-Results: garm.ovh; auth=pass (GARM-109S003fa84c6bc-0c30-47eb-ac28-b37467378391, 3FED962507A27B83C54448C18F2AB3741116F08E) smtp.auth=ngraves@ngraves.fr X-OVh-ClientIp: 86.246.19.221 Date: Sat, 28 Sep 2024 23:28:51 +0200 Message-ID: <20240928212853.29502-1-ngraves@ngraves.fr> X-Mailer: git-send-email 2.46.0 MIME-Version: 1.0 X-Ovh-Tracer-Id: 8437775379253879522 X-VR-SPAMSTATE: OK X-VR-SPAMSCORE: 49 X-VR-SPAMCAUSE: gggruggvucftvghtrhhoucdtuddrgeeftddrvdduuddgudeflecutefuodetggdotefrodftvfcurfhrohhfihhlvgemucfqggfjpdevjffgvefmvefgnecuuegrihhlohhuthemucehtddtnecuogfuuhhsphgvtghtffhomhgrihhnucdlgeelmdenucfjughrpefhvfevufffkffoggfgsedtkeertdertddtnecuhfhrohhmpefpihgtohhlrghsucfirhgrvhgvshcuoehnghhrrghvvghssehnghhrrghvvghsrdhfrheqnecuggftrfgrthhtvghrnhepffduveejleejheehieduteduvdeugeevieetjeekgfeutefftefhieffheelleelnecuffhomhgrihhnpehgihhthhhusgdrihhopdhgihhthhhusgdrtghomhdpmhgrghhithdrvhgtnecukfhppeduvdejrddtrddtrddupdekiedrvdegiedrudelrddvvddupdefjedrheelrddugedvrddutdelnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehinhgvthepuddvjedrtddrtddruddpmhgrihhlfhhrohhmpehnghhrrghvvghssehnghhrrghvvghsrdhfrhdpnhgspghrtghpthhtohepuddprhgtphhtthhopehguhhigidqphgrthgthhgvshesghhnuhdrohhrghdpoffvtefjohhsthepmhhoheejiedpmhhouggvpehsmhhtphhouhht DKIM-Signature: a=rsa-sha256; bh=/fF+Y4eFHJDZaETfEhePW7jjp0ZCQrjCUvsfVR5hnuI=; c=relaxed/relaxed; d=ngraves.fr; h=From; s=ovhmo4487190-selector1; t=1727558937; v=1; b=qYy/Hjypv/jM32DwjPXe2zLTZg1MousLlAQKUPlFI6gXo55GxvTBAyBhyKLeBebD4OgQ1BnV kWBRgiLI/0B6gcgLtaVkZJ7Hytd5AC/Y7hfDLNvzU7ygLmp9R6jvBnXNT9yLYbHJ0Xfx6XkDdQq 3JN5qhs1hRE1Q9LDHOMSee9FaqgmvP6OLzk6AWSL6RMu/9Gp1TPPDFEIGk4CAV3iuavTdsDI/xM GjrOA3s79TTqRbicSnYRDyhSqp4ldY5Xj2I15w9ZMHxxyCrkUCq64YPGiqTb6Qm5Vy7jVQYPu3s DtLisXrwzb4O8qaaCcI4CqQDM9+aK9pm9GRmJCrhOOPMQ== Received-SPF: pass client-ip=46.105.73.241; envelope-from=ngraves@ngraves.fr; helo=10.mo576.mail-out.ovh.net X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_MSPIKE_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action 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: , Reply-to: Nicolas Graves X-ACL-Warn: , Nicolas Graves via Guix-patches X-Patchwork-Original-From: Nicolas Graves via Guix-patches via From: Nicolas Graves Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * doc/contributing.texi: Both tempel and yasnippets have been integrated to .dir-locals.el, this source snippet is not necessary anymore. --- doc/contributing.texi | 23 ++++++----------------- 1 file changed, 6 insertions(+), 17 deletions(-) diff --git a/doc/contributing.texi b/doc/contributing.texi index 1b9a3b7beb..bfcbac1fca 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -552,26 +552,15 @@ s-expression, etc. @cindex reducing boilerplate We also provide templates for common git commit messages and package definitions in the @file{etc/snippets} directory. These templates can -be used to expand short trigger strings to interactive text snippets. If -you use @url{https://joaotavora.github.io/yasnippet/, YASnippet}, you -may want to add the @file{etc/snippets/yas} snippets directory to the +be used to expand short trigger strings to interactive text snippets. +They are used automatically if @file{.dir-locals.el} is allowed to +execute. Otherwise, if you use +@url{https://joaotavora.github.io/yasnippet/, YASnippet}, you may want +to add the @file{etc/snippets/yas} snippets directory to the @var{yas-snippet-dirs} variable. If you use @url{https://github.com/minad/tempel/, Tempel}, you may want to add the @file{etc/snippets/tempel/*} path to the @var{tempel-path} variable in -Emacs. - -@lisp -;; @r{Assuming the Guix checkout is in ~/src/guix.} -;; @r{Yasnippet configuration} -(with-eval-after-load 'yasnippet - (add-to-list 'yas-snippet-dirs "~/src/guix/etc/snippets/yas")) -;; @r{Tempel configuration} -(with-eval-after-load 'tempel - ;; Ensure tempel-path is a list -- it may also be a string. - (unless (listp 'tempel-path) - (setq tempel-path (list tempel-path))) - (add-to-list 'tempel-path "~/src/guix/etc/snippets/tempel/*")) -@end lisp +Emacs. See @file{.dir-locals.el} in Guix checkout for more details. The commit message snippets depend on @url{https://magit.vc/, Magit} to display staged files. When editing a commit message type @code{add}