unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [PATCH] CLI/git: replace most mentions of nmbug
@ 2022-07-04 15:33 David Bremner
  2022-07-05 16:35 ` Tomi Ollila
  0 siblings, 1 reply; 3+ messages in thread
From: David Bremner @ 2022-07-04 15:33 UTC (permalink / raw)
  To: notmuch

Particularly in help messages, nmbug is confusing for users who may
have never heard of it.
---
 notmuch-git.py | 40 ++++++++++++++++++++--------------------
 1 file changed, 20 insertions(+), 20 deletions(-)

diff --git a/notmuch-git.py b/notmuch-git.py
index eac24a46..42de074e 100644
--- a/notmuch-git.py
+++ b/notmuch-git.py
@@ -40,7 +40,7 @@ from urllib.parse import quote as _quote
 from urllib.parse import unquote as _unquote
 import json as _json
 
-_LOG = _logging.getLogger('nmbug')
+_LOG = _logging.getLogger('notmuch-git')
 _LOG.setLevel(_logging.WARNING)
 _LOG.addHandler(_logging.StreamHandler())
 
@@ -260,7 +260,7 @@ def get_tags(prefix=None):
 
 def archive(treeish='HEAD', args=()):
     """
-    Dump a tar archive of the current nmbug tag set.
+    Dump a tar archive of the current notmuch-git tag set.
 
     Using 'git archive'.
 
@@ -278,13 +278,13 @@ def archive(treeish='HEAD', args=()):
 
 def clone(repository):
     """
-    Create a local nmbug repository from a remote source.
+    Create a local notmuch-git repository from a remote source.
 
     This wraps 'git clone', adding some options to avoid creating a
     working tree while preserving remote-tracking branches and
     upstreams.
     """
-    with _tempfile.TemporaryDirectory(prefix='nmbug-clone.') as workdir:
+    with _tempfile.TemporaryDirectory(prefix='notmuch-git-clone.') as workdir:
         _spawn(
             args=[
                 'git', 'clone', '--no-checkout', '--separate-git-dir', NOTMUCH_GIT_DIR,
@@ -454,7 +454,7 @@ def fetch(remote=None):
 
 def init(remote=None,format_version=None):
     """
-    Create an empty nmbug repository.
+    Create an empty notmuch-git repository.
 
     This wraps 'git init' with a few extra steps to support subsequent
     status and commit commands.
@@ -542,9 +542,9 @@ def _insist_committed():
         _LOG.error('\n'.join([
             'Uncommitted changes to {prefix}* tags in notmuch',
             '',
-            "For a summary of changes, run 'nmbug status'",
-            "To save your changes,     run 'nmbug commit' before merging/pull",
-            "To discard your changes,  run 'nmbug checkout'",
+            "For a summary of changes, run 'notmuch-git status'",
+            "To save your changes,     run 'notmuch-git commit' before merging/pull",
+            "To discard your changes,  run 'notmuch-git checkout'",
             ]).format(prefix=TAG_PREFIX))
         _sys.exit(1)
 
@@ -566,7 +566,7 @@ def pull(repository=None, refspecs=None):
         args.append(repository)
     if refspecs:
         args.extend(refspecs)
-    with _tempfile.TemporaryDirectory(prefix='nmbug-pull.') as workdir:
+    with _tempfile.TemporaryDirectory(prefix='notmuch-git-pull.') as workdir:
         for command in [
                 ['reset', '--hard'],
                 args]:
@@ -584,7 +584,7 @@ def merge(reference='@{upstream}'):
     The default reference is '@{upstream}'.
     """
     _insist_committed()
-    with _tempfile.TemporaryDirectory(prefix='nmbug-merge.') as workdir:
+    with _tempfile.TemporaryDirectory(prefix='notmuch-git-merge.') as workdir:
         for command in [
                 ['reset', '--hard'],
                 ['merge', reference]]:
@@ -599,8 +599,8 @@ def log(args=()):
     """
     A simple wrapper for 'git log'.
 
-    After running 'nmbug fetch', you can inspect the changes with
-    'nmbug log HEAD..@{upstream}'.
+    After running 'notmuch-git fetch', you can inspect the changes with
+    'notmuch-git log HEAD..@{upstream}'.
     """
     # we don't want output trapping here, because we want the pager.
     args = ['log', '--name-status', '--no-renames'] + list(args)
@@ -609,7 +609,7 @@ def log(args=()):
 
 
 def push(repository=None, refspecs=None):
-    "Push the local nmbug Git state to a remote repository."
+    "Push the local notmuch-git Git state to a remote repository."
     if refspecs and not repository:
         repository = _get_remote()
     args = ['push']
@@ -632,13 +632,13 @@ def status():
 
     * 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 notmuch-git
+      (equivalently, tag has been deleted in notmuch-git repo, e.g. by a
       pull, but not restored to notmuch database).
 
     * D
 
-      Tag is present in nmbug repo, but not restored to notmuch
+      Tag is present in notmuch-git repo, but not restored to notmuch
       database (equivalently, tag has been deleted in notmuch).
 
     * U
@@ -646,7 +646,7 @@ def status():
       Message is unknown (missing from local notmuch database).
 
     The second character (if present) represents a difference between
-    local and upstream branches. Typically 'nmbug fetch' needs to be
+    local and upstream branches. Typically 'notmuch-git fetch' needs to be
     run to update this.
 
     * a
@@ -939,15 +939,15 @@ def _unpack_diff_lines(stream):
 
 def _help(parser, command=None):
     """
-    Show help for an nmbug command.
+    Show help for an notmuch-git command.
 
     Because some folks prefer:
 
-      $ nmbug help COMMAND
+      $ notmuch-git help COMMAND
 
     to
 
-      $ nmbug COMMAND --help
+      $ notmuch-git COMMAND --help
     """
     if command:
         parser.parse_args([command, '--help'])
-- 
2.35.2

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] CLI/git: replace most mentions of nmbug
  2022-07-04 15:33 [PATCH] CLI/git: replace most mentions of nmbug David Bremner
@ 2022-07-05 16:35 ` Tomi Ollila
  2022-07-07  9:36   ` David Bremner
  0 siblings, 1 reply; 3+ messages in thread
From: Tomi Ollila @ 2022-07-05 16:35 UTC (permalink / raw)
  To: David Bremner, notmuch

On Mon, Jul 04 2022, David Bremner wrote:

> Particularly in help messages, nmbug is confusing for users who may
> have never heard of it.

Good Progress! LGTM!

Tomi

> ---
>  notmuch-git.py | 40 ++++++++++++++++++++--------------------
>  1 file changed, 20 insertions(+), 20 deletions(-)
>
> diff --git a/notmuch-git.py b/notmuch-git.py
> index eac24a46..42de074e 100644
> --- a/notmuch-git.py
> +++ b/notmuch-git.py
> @@ -40,7 +40,7 @@ from urllib.parse import quote as _quote
>  from urllib.parse import unquote as _unquote
>  import json as _json
>  
> -_LOG = _logging.getLogger('nmbug')
> +_LOG = _logging.getLogger('notmuch-git')
>  _LOG.setLevel(_logging.WARNING)
>  _LOG.addHandler(_logging.StreamHandler())
>  
> @@ -260,7 +260,7 @@ def get_tags(prefix=None):
>  
>  def archive(treeish='HEAD', args=()):
>      """
> -    Dump a tar archive of the current nmbug tag set.
> +    Dump a tar archive of the current notmuch-git tag set.
>  
>      Using 'git archive'.
>  
> @@ -278,13 +278,13 @@ def archive(treeish='HEAD', args=()):
>  
>  def clone(repository):
>      """
> -    Create a local nmbug repository from a remote source.
> +    Create a local notmuch-git repository from a remote source.
>  
>      This wraps 'git clone', adding some options to avoid creating a
>      working tree while preserving remote-tracking branches and
>      upstreams.
>      """
> -    with _tempfile.TemporaryDirectory(prefix='nmbug-clone.') as workdir:
> +    with _tempfile.TemporaryDirectory(prefix='notmuch-git-clone.') as workdir:
>          _spawn(
>              args=[
>                  'git', 'clone', '--no-checkout', '--separate-git-dir', NOTMUCH_GIT_DIR,
> @@ -454,7 +454,7 @@ def fetch(remote=None):
>  
>  def init(remote=None,format_version=None):
>      """
> -    Create an empty nmbug repository.
> +    Create an empty notmuch-git repository.
>  
>      This wraps 'git init' with a few extra steps to support subsequent
>      status and commit commands.
> @@ -542,9 +542,9 @@ def _insist_committed():
>          _LOG.error('\n'.join([
>              'Uncommitted changes to {prefix}* tags in notmuch',
>              '',
> -            "For a summary of changes, run 'nmbug status'",
> -            "To save your changes,     run 'nmbug commit' before merging/pull",
> -            "To discard your changes,  run 'nmbug checkout'",
> +            "For a summary of changes, run 'notmuch-git status'",
> +            "To save your changes,     run 'notmuch-git commit' before merging/pull",
> +            "To discard your changes,  run 'notmuch-git checkout'",
>              ]).format(prefix=TAG_PREFIX))
>          _sys.exit(1)
>  
> @@ -566,7 +566,7 @@ def pull(repository=None, refspecs=None):
>          args.append(repository)
>      if refspecs:
>          args.extend(refspecs)
> -    with _tempfile.TemporaryDirectory(prefix='nmbug-pull.') as workdir:
> +    with _tempfile.TemporaryDirectory(prefix='notmuch-git-pull.') as workdir:
>          for command in [
>                  ['reset', '--hard'],
>                  args]:
> @@ -584,7 +584,7 @@ def merge(reference='@{upstream}'):
>      The default reference is '@{upstream}'.
>      """
>      _insist_committed()
> -    with _tempfile.TemporaryDirectory(prefix='nmbug-merge.') as workdir:
> +    with _tempfile.TemporaryDirectory(prefix='notmuch-git-merge.') as workdir:
>          for command in [
>                  ['reset', '--hard'],
>                  ['merge', reference]]:
> @@ -599,8 +599,8 @@ def log(args=()):
>      """
>      A simple wrapper for 'git log'.
>  
> -    After running 'nmbug fetch', you can inspect the changes with
> -    'nmbug log HEAD..@{upstream}'.
> +    After running 'notmuch-git fetch', you can inspect the changes with
> +    'notmuch-git log HEAD..@{upstream}'.
>      """
>      # we don't want output trapping here, because we want the pager.
>      args = ['log', '--name-status', '--no-renames'] + list(args)
> @@ -609,7 +609,7 @@ def log(args=()):
>  
>  
>  def push(repository=None, refspecs=None):
> -    "Push the local nmbug Git state to a remote repository."
> +    "Push the local notmuch-git Git state to a remote repository."
>      if refspecs and not repository:
>          repository = _get_remote()
>      args = ['push']
> @@ -632,13 +632,13 @@ def status():
>  
>      * 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 notmuch-git
> +      (equivalently, tag has been deleted in notmuch-git repo, e.g. by a
>        pull, but not restored to notmuch database).
>  
>      * D
>  
> -      Tag is present in nmbug repo, but not restored to notmuch
> +      Tag is present in notmuch-git repo, but not restored to notmuch
>        database (equivalently, tag has been deleted in notmuch).
>  
>      * U
> @@ -646,7 +646,7 @@ def status():
>        Message is unknown (missing from local notmuch database).
>  
>      The second character (if present) represents a difference between
> -    local and upstream branches. Typically 'nmbug fetch' needs to be
> +    local and upstream branches. Typically 'notmuch-git fetch' needs to be
>      run to update this.
>  
>      * a
> @@ -939,15 +939,15 @@ def _unpack_diff_lines(stream):
>  
>  def _help(parser, command=None):
>      """
> -    Show help for an nmbug command.
> +    Show help for an notmuch-git command.
>  
>      Because some folks prefer:
>  
> -      $ nmbug help COMMAND
> +      $ notmuch-git help COMMAND
>  
>      to
>  
> -      $ nmbug COMMAND --help
> +      $ notmuch-git COMMAND --help
>      """
>      if command:
>          parser.parse_args([command, '--help'])
> -- 
> 2.35.2
>
> _______________________________________________
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-leave@notmuchmail.org

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] CLI/git: replace most mentions of nmbug
  2022-07-05 16:35 ` Tomi Ollila
@ 2022-07-07  9:36   ` David Bremner
  0 siblings, 0 replies; 3+ messages in thread
From: David Bremner @ 2022-07-07  9:36 UTC (permalink / raw)
  To: Tomi Ollila, notmuch

Tomi Ollila <tomi.ollila@iki.fi> writes:

> On Mon, Jul 04 2022, David Bremner wrote:
>
>> Particularly in help messages, nmbug is confusing for users who may
>> have never heard of it.
>
> Good Progress! LGTM!
>

applied to master.

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2022-07-07  9:36 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-07-04 15:33 [PATCH] CLI/git: replace most mentions of nmbug David Bremner
2022-07-05 16:35 ` Tomi Ollila
2022-07-07  9:36   ` David Bremner

Code repositories for project(s) associated with this inbox:

	notmuch.git.git (no URL configured)

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).