From: David Bremner <david@tethera.net>
To: notmuch@notmuchmail.org
Subject: [PATCH 16/16] WIP: start manual page for notmuch-git
Date: Sat, 23 Apr 2022 10:38:48 -0300 [thread overview]
Message-ID: <20220423133848.3852688-17-david@tethera.net> (raw)
In-Reply-To: <20220423133848.3852688-1-david@tethera.net>
---
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 ... <command> --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
+ <tree-ish>, 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
next prev parent reply other threads:[~2022-04-23 13:39 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-04-23 13:38 WIP: promote nmbug to user sync tool David Bremner
2022-04-23 13:38 ` [PATCH 01/16] nmbug: promote to user tool "notmuch-git" David Bremner
2022-04-23 13:38 ` [PATCH 02/16] notmuch-git: add --git-dir argument David Bremner
2022-04-23 13:38 ` [PATCH 03/16] notmuch-git: add --tag-prefix argument David Bremner
2022-04-23 13:38 ` [PATCH 04/16] test: initial tests for notmuch-git David Bremner
2022-04-23 13:38 ` [PATCH 05/16] nmbug: Add an 'init' command David Bremner
2022-04-23 13:38 ` [PATCH 06/16] CLI/git: suppress warnings about initial branch name David Bremner
2022-04-23 13:38 ` [PATCH 07/16] test: use "notmuch git init" for tests David Bremner
2022-04-23 13:38 ` [PATCH 08/16] CLI/git: make existance of config branch optional on clone David Bremner
2022-04-23 13:38 ` [PATCH 09/16] test/git: add known broken test for tag with quotes David Bremner
2022-04-23 13:38 ` [PATCH 10/16] CLI/git: replace enumeration of tags with sexp query David Bremner
2022-04-23 13:38 ` [PATCH 11/16] CLI/git: add @timed decorator, time a few functions David Bremner
2022-04-23 13:38 ` [PATCH 12/16] CLI/git: rename private index file David Bremner
2022-04-23 13:38 ` [PATCH 13/16] CLI/git: create PrivateIndex class David Bremner
2022-04-23 13:38 ` [PATCH 14/16] CLI/git: create CachedIndex class David Bremner
2022-04-23 13:38 ` [PATCH 15/16] debian: install notmuch-git David Bremner
2022-04-23 13:38 ` David Bremner [this message]
2022-04-23 18:49 ` WIP: promote nmbug to user sync tool David Bremner
2022-04-30 17:33 ` Sean Whitton
2022-05-08 0:01 ` David Bremner
2022-05-20 23:05 ` Sean Whitton
2022-05-29 11:00 ` David Bremner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://notmuchmail.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220423133848.3852688-17-david@tethera.net \
--to=david@tethera.net \
--cc=notmuch@notmuchmail.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://yhetil.org/notmuch.git/
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).