From patchwork Mon Jun 10 13:19:47 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Arun Isaac X-Patchwork-Id: 65273 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 CA80927BBEA; Mon, 10 Jun 2024 18:11:36 +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=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,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 DB83A27BBE2 for ; Mon, 10 Jun 2024 18:11:34 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sGiXv-0002QN-F1; Mon, 10 Jun 2024 13:11:03 -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 1sGiXe-0002Md-GH for guix-patches@gnu.org; Mon, 10 Jun 2024 13:10:47 -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 1sGiXd-0000XW-Bo; Mon, 10 Jun 2024 13:10:46 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sGiXt-0006eJ-Rf; Mon, 10 Jun 2024 13:11:01 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#71481] [PATCH 1/3] doc: Document mumi am, compose and www subcommands. Resent-From: Arun Isaac Original-Sender: "Debbugs-submit" Resent-CC: pelzflorian@pelzflorian.de, ludo@gnu.org, matt@excalamus.com, maxim.cournoyer@gmail.com, guix-patches@gnu.org Resent-Date: Mon, 10 Jun 2024 17:11:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 71481 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 71481@debbugs.gnu.org Cc: Arun Isaac , Florian Pelz , Ludovic =?utf-8?q?Court=C3=A8s?= , Matthew Trzcinski , Maxim Cournoyer X-Debbugs-Original-To: guix-patches@gnu.org X-Debbugs-Original-Xcc: Florian Pelz , Ludovic =?utf-8?q?Court=C3=A8s?= , Matthew Trzcinski , Maxim Cournoyer Received: via spool by submit@debbugs.gnu.org id=B.171803942825417 (code B ref -1); Mon, 10 Jun 2024 17:11:01 +0000 Received: (at submit) by debbugs.gnu.org; 10 Jun 2024 17:10:28 +0000 Received: from localhost ([127.0.0.1]:47341 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sGiXK-0006bn-0A for submit@debbugs.gnu.org; Mon, 10 Jun 2024 13:10:27 -0400 Received: from lists.gnu.org ([209.51.188.17]:42400) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sGhws-0004k3-6T for submit@debbugs.gnu.org; Mon, 10 Jun 2024 12:32:48 -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 1sGewb-0003xA-Q4 for guix-patches@gnu.org; Mon, 10 Jun 2024 09:20:18 -0400 Received: from mugam.systemreboot.net ([139.59.75.54]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sGewX-0008M4-Ja for guix-patches@gnu.org; Mon, 10 Jun 2024 09:20:16 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=systemreboot.net; s=default; h=Content-Transfer-Encoding:Content-Type: MIME-Version:Message-ID:Date:Subject:Cc:To:From:Sender:Reply-To:Content-ID: Content-Description:Resent-Date:Resent-From:Resent-Sender:Resent-To:Resent-Cc :Resent-Message-ID:In-Reply-To:References:List-Id:List-Help:List-Unsubscribe: List-Subscribe:List-Post:List-Owner:List-Archive; bh=60evXFMl9DBWMFoe9sQ7N1xje9Ok4oniw7dZ1bP+yok=; b=R4+Lj/4T7TTckjSuVZOqjolhGH 9DS+CWZYgw5gCg2Qz265wvFTKdMWw/1NVw6kkLjl24zjtzF06GWjZq0rackn3dtDC3mxzihzIdLUu z/4YZdJdMHFLWQZFP/i0Y1M/ibFtBYMwz/yh1oP1wbXVcE3H1lvWa9hU4MO3qI16P3ZI17AKPlYwm iHRx/E5NBu9sqbnN08tALIEyMU8tnq9blRvhd8p5ksYaW1vIOFWp8r1l/RkC1EFb+tRM46YehpZvK 4IyvdFjXKiHKcBN6328/D5zwVm/zgDZ1GDufgVkePs1aWPFcfpqnFbpM21kwnlsk9jYm5Bu469pVf M+cGpnXw==; Received: from [192.168.2.1] (port=54564 helo=localhost.localdomain) by systemreboot.net with esmtpsa (TLS1.3) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.96.1) (envelope-from ) id 1sGetC-00019k-2l; Mon, 10 Jun 2024 14:16:47 +0100 From: Arun Isaac Date: Mon, 10 Jun 2024 14:19:47 +0100 Message-ID: <64b211c1bcab088e6502df4c824f91a28a6aa9e5.1718025563.git.arunisaac@systemreboot.net> X-Mailer: git-send-email 2.45.1 MIME-Version: 1.0 Received-SPF: pass client-ip=139.59.75.54; envelope-from=arunisaac@systemreboot.net; helo=mugam.systemreboot.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, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: , 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 (Debbugs User Interfaces)[Command-line interface]: Document mumi am, compose and www subcommands. * doc/guix.texi: Bump copyright year. Change-Id: I28bde9454ad35115ed60fe4d6ffa35fad599b2d1 Reviewed-by: Maxim Cournoyer --- doc/contributing.texi | 70 ++++++++++++++++++++++++++++++++++++------- doc/guix.texi | 2 +- 2 files changed, 61 insertions(+), 11 deletions(-) base-commit: df5648daa1a5d097a430131bbff353b865b476b6 diff --git a/doc/contributing.texi b/doc/contributing.texi index b8adc169d8..1fdf9b4db5 100644 --- a/doc/contributing.texi +++ b/doc/contributing.texi @@ -2395,9 +2395,9 @@ Debbugs User Interfaces @subsubsection Command-line interface Mumi also comes with a command-line interface that can be used to search -existing issues, open new issues and send patches. You do not need to -use Emacs to use the mumi command-line client. You interact with it -only on the command-line. +existing issues, open new issues, compose replies, apply and send +patches. You do not need to use Emacs to use the mumi command-line +client. You interact with it only on the command-line. To use the mumi command-line interface, navigate to a local clone of the Guix git repository, and drop into a shell with mumi, git and @@ -2434,8 +2434,61 @@ Debbugs User Interfaces opened on 24 Jan 09:42 Z by Efraim Flashner @end example -Once an issue is the current issue, you can easily create and send -patches to it using +Once an issue is the current issue, you can open the issue in a web +browser, compose replies, apply patches, send patches, etc. with short +succinct commands. + +Open the issue in your web browser using + +@example +~/guix [env]$ mumi www +@end example + +Compose a reply using + +@example +~/guix [env]$ mumi compose +@end example + +Compose a reply and close the issue using + +@example +~/guix [env]$ mumi compose --close +@end example + +@command{mumi compose} opens your mail client by passing @samp{mailto:} +URIs to @command{xdg-open}. So, you need to have @command{xdg-open} set +up to open your mail client correctly. + +Apply the latest patchset from the issue using + +@example +~/guix [env]$ mumi am +@end example + +You may also apply a patchset of a specific version (say, v3) using + +@example +~/guix [env]$ mumi am v3 +@end example + +Or, you may apply a patch from a specific e-mail message. For example, +to apply the patch from the 4th message (message index starts from 0), +run + +@example +~/guix [env]$ mumi am @@4 +@end example + +@command{mumi am} is a wrapper around @command{git am}. You can pass +@command{git am} arguments to it after a @samp{--}. For example, to add +a Signed-off-by trailer, run + +@example +~/guix [env]$ mumi am -- -s +@end example + +Create and send patches to the issue using @example ~/guix [env]$ git format-patch origin/master @@ -2452,11 +2505,8 @@ Debbugs User Interfaces ~/guix [env]$ mumi new @end example -and send patches - -@example -~/guix [env]$ mumi send-email foo.patch bar.patch -@end example +and send an email (using @command{mumi compose}) or patches (using +@command{mumi send-email}). @command{mumi send-email} is really a wrapper around @command{git send-email} that automates away all the nitty-gritty of sending patches. diff --git a/doc/guix.texi b/doc/guix.texi index 769ca1399f..e1d1d4696c 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -53,7 +53,7 @@ Copyright @copyright{} 2017–2022 Tobias Geerinckx-Rice@* Copyright @copyright{} 2017 George Clemmer@* Copyright @copyright{} 2017 Andy Wingo@* -Copyright @copyright{} 2017, 2018, 2019, 2020, 2023 Arun Isaac@* +Copyright @copyright{} 2017, 2018, 2019, 2020, 2023, 2024 Arun Isaac@* Copyright @copyright{} 2017 nee@* Copyright @copyright{} 2018 Rutger Helling@* Copyright @copyright{} 2018, 2021, 2023 Oleg Pykhalov@*