From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp12.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms5.migadu.com with LMTPS id YE85IWZz7GLSfgEAbAwnHQ (envelope-from ) for ; Fri, 05 Aug 2022 03:33:26 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp12.migadu.com with LMTPS id eFc3IWZz7GLTbQAAauVa8A (envelope-from ) for ; Fri, 05 Aug 2022 03:33:26 +0200 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 14692175FA for ; Fri, 5 Aug 2022 03:33:26 +0200 (CEST) Received: from localhost ([::1]:46304 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oJmDN-0007ak-3C for larch@yhetil.org; Thu, 04 Aug 2022 21:33:25 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:39464) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oJmD1-0007aN-8x for guix-patches@gnu.org; Thu, 04 Aug 2022 21:33:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:37452) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oJmD1-0008Mx-0X for guix-patches@gnu.org; Thu, 04 Aug 2022 21:33:03 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1oJmD0-00055J-K7 for guix-patches@gnu.org; Thu, 04 Aug 2022 21:33:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#56987] [PATCH] etc: guix-debbugs.el: new file. Resent-From: Joshua Branson Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Fri, 05 Aug 2022 01:33:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 56987 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 56987@debbugs.gnu.org Received: via spool by 56987-submit@debbugs.gnu.org id=B56987.165966314519486 (code B ref 56987); Fri, 05 Aug 2022 01:33:02 +0000 Received: (at 56987) by debbugs.gnu.org; 5 Aug 2022 01:32:25 +0000 Received: from localhost ([127.0.0.1]:55434 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oJmCO-00054D-Hx for submit@debbugs.gnu.org; Thu, 04 Aug 2022 21:32:25 -0400 Received: from mx1.dismail.de ([78.46.223.134]:35156) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oJmCM-00053v-8d for 56987@debbugs.gnu.org; Thu, 04 Aug 2022 21:32:23 -0400 Received: from mx1.dismail.de (localhost [127.0.0.1]) by mx1.dismail.de (OpenSMTPD) with ESMTP id 0e3ef8e5 for <56987@debbugs.gnu.org>; Fri, 5 Aug 2022 03:32:14 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed; d=dismail.de; h=from:to :subject:references:date:in-reply-to:message-id:mime-version :content-type; s=20190914; bh=PVrN8ZrqOVMolEBxR1T1w/4s/HBi0wvmNO Gf9dKyexQ=; b=jtIT+CkdmpX8QLhmVUbXGfPfa9230Z4f5bRxKWNTkPgkMaBB1q aHvxpIqPmJt966bZ+ijtLCSQqGIXjxXDM064aupAi2rXF40a3zy6+i1ueES7J45F LgEcUwJ1Aq7kth61rrMOIK5iBNlmyCuM0KlqhjMb5yKcIR+9VK3yq+cj4SJ1OYRf v131C4fYx3KcwFUddkOJfvLq0+SPJ5m/W3d8OODXpwrq1l1AzVR1Wjg2TLqyxfkl 4sRdCl925YAdORT5+ataZnww2haoqS8iPWUEGkRgQ0rSC20x/c5CLcQzeeRkdqAB D3DwT1WJnbD73tzt9lqVCk8yxQgAGvvDYsGw== Received: from smtp1.dismail.de ( [10.240.26.11]) by mx1.dismail.de (OpenSMTPD) with ESMTP id c40af04a for <56987@debbugs.gnu.org>; Fri, 5 Aug 2022 03:32:14 +0200 (CEST) Received: from smtp1.dismail.de (localhost [127.0.0.1]) by smtp1.dismail.de (OpenSMTPD) with ESMTP id 10bc3bad for <56987@debbugs.gnu.org>; Fri, 5 Aug 2022 03:32:14 +0200 (CEST) Received: by dismail.de (OpenSMTPD) with ESMTPSA id 1b76ca32 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO) for <56987@debbugs.gnu.org>; Fri, 5 Aug 2022 03:32:13 +0200 (CEST) References: <20220805012310.5999-1-jbranso@dismail.de> Date: Thu, 04 Aug 2022 21:32:09 -0400 In-Reply-To: <20220805012310.5999-1-jbranso@dismail.de> (Joshua Branson's message of "Thu, 4 Aug 2022 21:23:10 -0400") Message-ID: <87h72rv5k6.fsf@dismail.de> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.1 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain 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+larch=yhetil.org@gnu.org Sender: "Guix-patches" Reply-to: Joshua Branson X-ACL-Warn: , Joshua Branson via Guix-patches From: Joshua Branson via Guix-patches via X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: US ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1659663206; h=from:from:sender:sender:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:mime-version:mime-version: content-type:content-type:resent-cc:resent-from:resent-sender: resent-message-id:in-reply-to:in-reply-to:references:references: list-id:list-help:list-unsubscribe:list-subscribe:list-post: dkim-signature; bh=d56WsuL1Lp7zaSseqbhq+TRo28MXuB6gUfPAguiDAg4=; b=seyCW4nEEBrVwKLfl3IE28EP2AzetOuhnKY6Xe24tMdrpf5PL927HEe0EwwPWHI1ajApTQ 9hXQF5/Au5XkynvToX5RQ2rpGTnMXNh2bhnge/sA4K76wqnFoM7J60wgZgbEztiRjDbmc7 qpwP2esiWeE7SC6D+LPphwdTQUPnGLdMODVqK8ScgZFpAkNiLJCQeqqaWm4OcXmj5xu1Vu 5jeG0DxEP2JFWkWnwbKZPr+sfPcuHmKuirCQjCVrmV7F3Ut5+uaT1bnK1h3TWs780g7yi2 Ror6mG3QKGEwvsW1SaZJgDsunT/84cJCqWwmKzijlVS7i5V+nvgjD14PguRTjg== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1659663206; a=rsa-sha256; cv=none; b=HY9R9vMnnAzeCC00+BpmrDYOBpLv+xwrK0RxwhJwlyqB8BHG2MBsL+UOQfXIbh0AAmGunK Xqee7IBoSwQVGhGzap6qnEe332a/7k38h7mvp8N7eHPRr/hFVT4mmbdJ4Ni/S7md2oF/uk Om5dkoPp5NtbzOa+073sL4nUWqx5pOpoY18f4ZP5t0tfNnbhIpr66fk1db0T9E3X05pr4O +5NBdkGbpp2c8Jf3MeLCX+6buj5xDJfw7OWyMqzDqAEg21Sc1DdYYzxhUVMG2ZDQmbJnYH uTud3BfoGdyOVziFGD8p+fFV9xay4DpYx1TrLSpc1iDYRyCyjirAPsYm9Vptyg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=dismail.de header.s=20190914 header.b=jtIT+Ckd; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-Migadu-Spam-Score: -3.51 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=dismail.de header.s=20190914 header.b=jtIT+Ckd; dmarc=pass (policy=none) header.from=gnu.org; spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" X-Migadu-Queue-Id: 14692175FA X-Spam-Score: -3.51 X-Migadu-Scanner: scn1.migadu.com X-TUID: pWfDcwQNpH0G Joshua Branson writes: > New users may find the default debbugs commands a little awkward to use. > This patch provides three new functions and documentation that may ease > them into using debbugs and encourages them to close their open bug > reports. > This patch now has an acompany video! https://video.hardlimit.com/w/gDMR9y2jhB5SkSp8iqEyK8 The video is 13 minutes long, and it explains my motivations for submitting this patch. Namely that debbugs can be a little confusing and hard for new comers to set up. I also spotted some errors with my debbugs-guix-search function as I was making the video. I am not certain what the problem was. Basically debbugs-gnu-search found my open wterm related bug, bug debbugs-guix-search did not. Weird. The documentation also helps newbies set up sending email in Emacs, which is essential to use the emacs' debbugs interface as it was intended. I hope others find it helpful! > > * etc/guix-debbugs.el (debbugs-guix-search, debbugs-my-open-bugs, > debbugs-get-bug-by-id): new procedures. > * doc/contributing.texi (Debbugs User Interfaces): documented the new > emacs procedures and explained how to modify .emacs.d to use them. > --- > doc/contributing.texi | 57 +++++++++++++++++++++++++++++++++++-- > etc/guix-debbugs.el | 65 +++++++++++++++++++++++++++++++++++++++++++ > 2 files changed, 120 insertions(+), 2 deletions(-) > create mode 100644 etc/guix-debbugs.el > > diff --git a/doc/contributing.texi b/doc/contributing.texi > index 02c7c5ae59..683b9bd9d2 100644 > --- a/doc/contributing.texi > +++ b/doc/contributing.texi > @@ -1453,14 +1453,67 @@ issues using @file{debbugs.el}, which you can install with: > guix install emacs-debbugs > @end example > > -For example, to list all open issues on @code{guix-patches}, hit: > +Newcomers may find the default debbugs functions awkward to use. We > +provide three helper functions that will help you start contributing to > +guix sooner: > + > +@table @asis > +@item @code{M-x debbugs-guix-search} > +to search for guix bugs. > + > +@item @code{M-x debbugs-my-open-bugs} > +to search for your open bug reports. These are reports that you > +submitted. Once every six months, run this command, and try to close > +your open bugs. Or just update the bug report with something like, > +'This is still a bug. Please do not close this bug.' > + > +@item @code{M-x debbugs-get-bug-by-id} > +to search for bugs by the 5 digit bug number. > +@end table > + > +To start using these guix specific functions, define the variable > +@code{user-mail-address}, and put the following into your > +@code{.emacs.d} (assuming the guix source is located in ~/src/guix/): > + > +@lisp > +(setq user-mail-address "awesomecoder@@gnu.org") > + > +(load-file "~/src/guix/etc/guix-debbugs.el") > + > +(setq smtpmail-smtp-user user-mail-address > + message-send-mail-function 'smtpmail-send-it > + send-mail-function 'smtpmail-send-it > + ;; customize this variable to suit your smtp email server. > + smtpmail-smtp-server "smtp.gnu.org" > + ;; customize this variable to suit your email server's port. > + smtpmail-smtp-service 587) > +@end lisp > + > +Emacs' debbugs interface is awesome, but in order to use it to its > +fullest potential, you need to set up emacs to send email. Luckily, the > +previous lines of code set up Emacs to use email for you! Now, go ahead > +and test Emacs' email sending ablities via @code{C-x m}. For testing > +purposes, send a test email to a friend or to yourself. To send the > +message, type in @code{C-c C-c}. Emacs will ask you for your email > +password and optionally offer to save it in the unencrypted file > +@code{~/.authinfo}. If you would rather save the password to an > +encrypted file (@code{~/.authinfo.gpg}), then please see > +@xref{Overview,,, auth, Emacs auth-source} and optionally set up GPG > +@comment I cannot get the below link to work. Why? > +agent (@xref{gnupg, gnupg, gnupg, Invoking GPG-AGENT}). If you can send > +the email, then you should be all set to use Emacs's debbugs interface! > + > +Finally, we encourage all potential contributers to occassionally review > +some pending patches. There's quite a few! You can test to see if the > +patch works for you, and reply to the open bug report. Here is how you > +might get started finding the pending patches: > > @example > @kbd{C-u} @kbd{M-x} debbugs-gnu @kbd{RET} @kbd{RET} guix-patches @kbd{RET} n y > @end example > > @xref{Top,,, debbugs-ug, Debbugs User Guide}, for more information on > -this nifty tool! > +this nifty tool, like how to close, tag, and merge bug reports! > > @node Debbugs Usertags > @subsection Debbugs Usertags > diff --git a/etc/guix-debbugs.el b/etc/guix-debbugs.el > new file mode 100644 > index 0000000000..794489b671 > --- /dev/null > +++ b/etc/guix-debbugs.el > @@ -0,0 +1,65 @@ > +;;; package --- Summary -*- lexical-binding: t; -*- > +;;; guix-debbugs.el Helpful Debbugs Functions for guix > +;; > +;; Copyright (C) 2022 Joshua Branson > +;; > +;; Author: Joshua Branson > +;; Maintainer: Joshua Branson > +;; Created: August 04, 2022 > +;; Modified: August 04, 2022 > +;; Version: 0.0.1 > +;; Keywords: guix debbugs > +;; Homepage: https://git.savannah.gnu.org/git/guix.git > +;; Package-Requires: ((emacs "24.3")) > +;; > +;; This file is not part of GNU Emacs. > +;; > +;;; Commentary: > +;; > +;; The debbugs functions are a little awkward to use. This file provides > +;; better and easier to use functions for the guix project. Specifically it > +;; provides two new functions: > +;; > +;; M-x debbugs-guix-search to search for guix bugs > +;; M-x debbugs-my-open-bugs to search for my open bug reports. > +;; M-x debbugs-get-buy-by-id to open a specific bug by its ID. > +;; > +;;; Code: > + > +;; setting up debbugs > +(require 'debbugs-autoloads) > + > +;; Users need to set up send-mail-function. Otherwise "C" in debbugs-gnu-mode WILL NOT work. > +;; eg: > +;; > +;; (setq user-mail-address "awesomecoder@gnu.org") > +;; (load-file "~/src/guix/etc/guix-debbugs.el") > +;; (setq message-send-mail-function 'smtpmail-send-it > +;; smtpmail-smtp-user user-mail-address > +;; ;; customize this variable to suit your smtp email server. > +;; smtpmail-smtp-server "smtp.gnu.org" > +;; ;; customize this variable to suit your email server's port. > +;; smtpmail-smtp-service 587) > + > +;; TODO make this by default only search open bugs AND NOT closed bugs. > +(defun debbugs-guix-search () > + (interactive) > + (debbugs-gnu-search (read-string "Search String: ") nil nil '("guix" "guix-patches") nil)) > + > +;; the bugs that I submitted and that are still open > +;; The debbugs database runs once a day. So after I send a bug report > +;; and run this command, my latest bug report might not be here. No worries, > +;; just wait one day, and it will be there. :) > +;; > +;; I have noticed that this function works 80% of the time. But after I close bug reports, > +;; it seems to stop working for about 1/2 hour. I'm guessing the server's database > +;; resets itself after every time that I close a bug report... > +(defun debbugs-my-open-bugs () > + (require 'debbugs) > + (interactive) > + (apply #'debbugs-gnu-bugs (debbugs-get-bugs :submitter "me" :status "open"))) > + > +(defalias 'debbugs-get-bug-by-id 'debbugs-gnu-bugs) > + > +(provide 'guix-debbugs) > +;;; guix-debbugs.el ends here > > base-commit: d6be56cd09bb6286b51d1efc8981993be2525d87