From 53cbb6d0cba6c4763b18f76467e73be21081daae Mon Sep 17 00:00:00 2001 From: Michael J Gruber <git@grubix.eu> Date: Mon, 24 Feb 2025 11:20:03 +0100 Subject: [PATCH] docs: avoid nmbug in notmuch-git.1 These days, `nmbug` is `notmuch-git` with special defaults, so avoid the term `nmbug` in the doc when we talk about `notmuch-git` in general. Also, spell git in lower case (as we do for notmuch) except for the one case where we name the beast. --- doc/man1/notmuch-git.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/man1/notmuch-git.rst b/doc/man1/notmuch-git.rst index 33a46f84..ae393ca1 100644 --- a/doc/man1/notmuch-git.rst +++ b/doc/man1/notmuch-git.rst @@ -75,10 +75,10 @@ Dump a tar archive of a committed tag set using 'git archive'. See .. option:: checkout [-f|--force] -Update the notmuch database from Git. +Update the notmuch database from git. This is mainly useful to discard your changes in notmuch relative -to Git. +to git. .. describe:: [-f|--force] @@ -101,7 +101,7 @@ upstreams. .. option:: commit [-f|--force] [message] -Commit prefix-matching tags from the notmuch database to Git. +Commit prefix-matching tags from the notmuch database to git. .. describe:: message @@ -166,7 +166,7 @@ Merge changes from 'reference' into HEAD and load the result into notmuch. Pull (merge) remote repository changes to notmuch. **pull** is equivalent to **fetch** followed by **merge**. We use the -Git-configured repository for your current branch +git-configured repository for your current branch (`branch.<name>.repository`, likely `origin`, and `branch.<name>.merge`, likely `master` or `main`). @@ -184,7 +184,7 @@ likely `master` or `main`). .. option:: push [repository] [refspec] -Push the local `notmuch git` Git state to a remote repository. +Push the local `notmuch git` git state to a remote repository. .. describe:: repository @@ -210,13 +210,13 @@ where n is a single character representing notmuch database status .. describe:: A - Tag is present in notmuch database, but not committed to nmbug - (equivalently, tag has been deleted in nmbug repo, e.g. by a + Tag is present in notmuch database, but not committed to git + (equivalently, tag has been deleted in git repo, e.g. by a pull, but not restored to notmuch database). .. describe:: D - Tag is present in nmbug repo, but not restored to notmuch + Tag is present in git repo, but not restored to notmuch database (equivalently, tag has been deleted in notmuch). .. describe:: U @@ -229,11 +229,11 @@ run to update this. .. describe:: a - Tag is present in upstream, but not in the local Git branch. + Tag is present in upstream, but not in the local git branch. .. describe:: d - Tag is present in local Git branch, but not upstream. + Tag is present in local git branch, but not upstream. .. _format: