From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp10.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 qG1dBYEBZGJ6FQAAbAwnHQ (envelope-from ) for ; Sat, 23 Apr 2022 15:39:13 +0200 Received: from aspmx1.migadu.com ([2001:41d0:2:4a6f::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp10.migadu.com with LMTPS id sJR/BIEBZGIdZgAAG6o9tA (envelope-from ) for ; Sat, 23 Apr 2022 15:39:13 +0200 Received: from mail.notmuchmail.org (yantan.tethera.net [135.181.149.255]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 343789F72 for ; Sat, 23 Apr 2022 15:39:12 +0200 (CEST) Received: from yantan.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 8E3F65F75F; Sat, 23 Apr 2022 13:39:03 +0000 (UTC) Received: from fethera.tethera.net (fethera.tethera.net [IPv6:2607:5300:60:c5::1]) by mail.notmuchmail.org (Postfix) with ESMTP id 9C8D15F758 for ; Sat, 23 Apr 2022 13:39:00 +0000 (UTC) Received: by fethera.tethera.net (Postfix, from userid 1001) id B6B235FBD7; Sat, 23 Apr 2022 09:38:59 -0400 (EDT) Received: (nullmailer pid 3856587 invoked by uid 1000); Sat, 23 Apr 2022 13:38:57 -0000 From: David Bremner To: notmuch@notmuchmail.org Subject: [PATCH 16/16] WIP: start manual page for notmuch-git Date: Sat, 23 Apr 2022 10:38:48 -0300 Message-Id: <20220423133848.3852688-17-david@tethera.net> X-Mailer: git-send-email 2.35.2 In-Reply-To: <20220423133848.3852688-1-david@tethera.net> References: <20220423133848.3852688-1-david@tethera.net> MIME-Version: 1.0 Message-ID-Hash: C5ZCDNUNBO4QPEH5CWZY4B5P32WLU7D2 X-Message-ID-Hash: C5ZCDNUNBO4QPEH5CWZY4B5P32WLU7D2 X-MailFrom: bremner@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.3 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Flow: FLOW_IN X-Migadu-To: larch@yhetil.org X-Migadu-Country: DE ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1650721152; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-owner:list-unsubscribe:list-subscribe:list-post; bh=EM/qzoAV2/8jPiKfwsv9kwmmQs8P1O9HKop+erGfrRs=; b=TxWJwa8O7qRTopyv/ccomUx6B3VE81mTIiEXqHmL+gEApGfX8YlzsfsRXsbiSmEP34KIo7 qLRM6ZUgMJUwWXBq+GhD7RQ4wLMRUhYhTVrpHJ7UvEaX9ULbWyZtPoaKgPe9StJ+zXWUwn svqfr3PkbHGIpvuKZXqnWYUllgpeNyekIB8FufNau1Go+QRH6pEGSUzeO8tjXWBw94ajIL OoFC60XrXWh0x2iNT32wFsYg7Un8jOkuZRHyhk2IQJdrqXdSWDgNZv+Ty7Wt44WsP6Mm4k FgNxhU2Q0Z32MEdjeEWq7gvjBYHs4gBljKECVjajrmYRJ9aR5yzvjDxUpKp7Kw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1650721152; a=rsa-sha256; cv=none; b=lR1CljczmSwocZiQcfZpo3mYQXiX891jWHYpU6K7ZydS2S5xIHzIvzQaxoIsmrQVj9ld/p SrZdYc4pnzAQ9PE3SA/UuUUDjXdyJdY3R2+B7iGPGl9lrMjpByvETQSf2Wlk2RKTxQM6eA kjbxlQwTX0CCzYTCAWOvDJHRiJEeT528nbq62ElRpZBwMzROG4u04Au3eugz5lEyrsx35P +wqRI/Pl8NXJIxn2g+EpoFZMoRK8CJY3nJprTl6W7Hj5dnNoBhhruqQRej/RQL8sHCTUNB B4yXdbSptaWXFKwEtXdcr1S0DORDTpXjBL3JZf//9P2470S+aqDP17KjHGEk+A== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 135.181.149.255 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Spam-Score: 0.21 Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 135.181.149.255 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org X-Migadu-Queue-Id: 343789F72 X-Spam-Score: 0.21 X-Migadu-Scanner: scn0.migadu.com X-TUID: YCKbdc/+WhR9 --- doc/conf.py | 4 ++ doc/index.rst | 1 + doc/man1/notmuch-git.rst | 106 +++++++++++++++++++++++++++++++++++++++ 3 files changed, 111 insertions(+) create mode 100644 doc/man1/notmuch-git.rst diff --git a/doc/conf.py b/doc/conf.py index e46e1d4e..da0635bb 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -123,6 +123,10 @@ man_pages = [ u'send mail with notmuch and emacs', [notmuch_authors], 1), + ('man1/notmuch-git', 'notmuch-git', + u'manage notmuch tags with git', + [notmuch_authors], 1), + ('man5/notmuch-hooks', 'notmuch-hooks', u'hooks for notmuch', [notmuch_authors], 5), diff --git a/doc/index.rst b/doc/index.rst index fbdcf779..c380ee1d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -15,6 +15,7 @@ Contents: man1/notmuch-dump notmuch-emacs man1/notmuch-emacs-mua + man1/notmuch-git man5/notmuch-hooks man1/notmuch-insert man1/notmuch-new diff --git a/doc/man1/notmuch-git.rst b/doc/man1/notmuch-git.rst new file mode 100644 index 00000000..4877f22d --- /dev/null +++ b/doc/man1/notmuch-git.rst @@ -0,0 +1,106 @@ +.. _notmuch-git(1): + +============ +notmuch-git +============ + +SYNOPSIS +======== + +**notmuch** **git** [-h] [-C REPO] [-p PREFIX] [-v] [-l *log level*] *subcommand* + +DESCRIPTION +=========== + +Manage notmuch tags with Git. + +Options +------- + +Supported options for **notmuch-git** include + +.. program:: notmuch-git + +.. option:: -h, --help + + show help message and exit + +.. option:: -C repo, --git-dir repo + + Operate on git repository *repo* + +.. option:: -p prefix, --tag-prefix prefix + + Operate only on tags with prefix *prefix* + +.. option:: -v, --version + + show notmuch-git's version number and exit + +.. option:: -l *level*, --log-level *level* {critical,error,warning,info,debug} + + Log verbosity. Defaults to 'warning'. + +Subcommands +----------- + +For help on a particular subcommand, run: 'notmuch-git ... --help'. + +.. option:: archive [TREE-ISH] [ARG ...] + +Dump a tar archive of the current nmbug tag set using 'git archive'. + +For each tag *tag* for message with Message-Id *id* an empty file + + tags/encode(*id*)/encode(*tag*) + +is written to the output. + +The encoding preserves alphanumerics, and the characters +"+-_@=.:," (not the quotes). All other octets are replaced with +'%%' followed by a two digit hex number. + +positional arguments: + TREE-ISH The tree or commit to produce an archive for. Defaults to + 'HEAD'. + ARG Argument passed through to 'git archive'. Set anything before + , see any:`git-archive(1)` for details. + +.. option:: checkout + +Update the notmuch database from Git. + +This is mainly useful to discard your changes in notmuch relative +to Git. +Create a local nmbug repository from a remote source. + +.. option:: clone repository + +This wraps 'git clone', adding some options to avoid creating a +working tree while preserving remote-tracking branches and +upstreams. + +positional arguments: + repository The (possibly remote) repository to clone from. See the URLS section of git-clone(1) for more information on specifying repositories. + + clone Create a local nmbug repository from a remote source. + commit Commit prefix-matching tags from the notmuch database to Git. + fetch Fetch changes from the remote repository. + help Show help for an nmbug command. + init Create an empty nmbug repository. + log A simple wrapper for 'git log'. + merge Merge changes from 'reference' into HEAD and load the result into notmuch. + pull Pull (merge) remote repository changes to notmuch. + push Push the local nmbug Git state to a remote repository. + status Show pending updates in notmuch or git repo. + + + + +SEE ALSO +======== + +:any:`notmuch(1)`, +:any:`notmuch-dump(1)`, +:any:`notmuch-restore(1)`, +:any:`notmuch-tag(1)` -- 2.35.2