From 06dc36ffb7cde821a4762b299d1c95b3788ba110 Mon Sep 17 00:00:00 2001
From: Maxim Cournoyer <maxim.cournoyer@gmail.com>
Date: Tue, 26 Sep 2023 14:02:24 -0400
Subject: doc: Update bug-reference configuration snippet.

* doc/contributing.texi (The Perfect Setup)
<Viewing Bugs within Emacs>: Properly quote Elisp functions.  Add 'require'
directives.  Set BUG-REFERENCE-URL-FORMAT so the configuration is
self-contained.

Suggested-by: Mekeor Melire <mekeor@posteo.de>
---
 doc/contributing.texi | 13 +++++++++----
 1 file changed, 9 insertions(+), 4 deletions(-)

(limited to 'doc')

diff --git a/doc/contributing.texi b/doc/contributing.texi
index 11fd7c3778..0de47a403b 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -397,13 +397,12 @@ configuration file:
 
 @lisp
 ;;; Bug references.
+(require 'bug-reference)
 (add-hook 'prog-mode-hook #'bug-reference-prog-mode)
 (add-hook 'gnus-mode-hook #'bug-reference-mode)
 (add-hook 'erc-mode-hook #'bug-reference-mode)
-(add-hook 'bug-reference-mode-hook 'debbugs-browse-mode)
-(add-hook 'bug-reference-prog-mode-hook 'debbugs-browse-mode)
-(add-hook 'gnus-summary-mode-hook 'bug-reference-mode)
-(add-hook 'gnus-article-mode-hook 'bug-reference-mode)
+(add-hook 'gnus-summary-mode-hook #'bug-reference-mode)
+(add-hook 'gnus-article-mode-hook #'bug-reference-mode)
 
 ;;; This extends the default expression (the top-most, first expression
 ;;; provided to 'or') to also match URLs such as
@@ -431,6 +430,12 @@ configuration file:
                      (seq "<https://bugs.gnu.org/"
                           (group-n 2 (one-or-more (char "0-9")))
                           ">")))))
+(setq bug-reference-url-format "https://issues.guix.gnu.org/%s")
+
+(require 'debbugs)
+(require 'debbugs-browse)
+(add-hook 'bug-reference-mode-hook #'debbugs-browse-mode)
+(add-hook 'bug-reference-prog-mode-hook #'debbugs-browse-mode)
 
 ;; The following allows Emacs Debbugs user to open the issue directly within
 ;; Emacs.
-- 
cgit v1.2.3