[PATCH 1/2] notmuch-emacs-mua: remove -C to keep short options compatible with mutt

[PATCH 1/2] notmuch-emacs-mua: remove -C to keep short options compatible with mutt

[Jani Nikula]

Notmuch uses long options exclusively all around. The short options in
notmuch-emacs-mua are intentionally just a compatible subset of
mutt(1). Keep it this way, if only to make documenting the fact easy!

The Notmuch style --client long option remains, of course.
---
 doc/man1/notmuch-emacs-mua.rst | 2 +-
 notmuch-emacs-mua              | 5 +++--
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst
index eb47098e11ca..32b728639188 100644
--- a/doc/man1/notmuch-emacs-mua.rst
+++ b/doc/man1/notmuch-emacs-mua.rst
@@ -18,7 +18,7 @@ Supported options for **notmuch-emacs-mua** include
     ``-h, --help``
         Display help.
 
-    ``-C, --client``
+    ``--client``
         Use emacsclient, rather than emacs. This will start
         an emacs daemon process if necessary.
 
diff --git a/notmuch-emacs-mua b/notmuch-emacs-mua
index b8cbc822fe89..13f67bee4417 100755
--- a/notmuch-emacs-mua
+++ b/notmuch-emacs-mua
@@ -38,7 +38,8 @@ CLIENT_TYPE="-c"
 ELISP="(prog1 'done (require 'notmuch) (notmuch-mua-new-mail)"
 ELISP="${ELISP} (setq message-exit-actions (list #'save-buffers-kill-terminal))"
 
-while getopts :s:c:b:i:hC opt; do
+# Short options compatible with mutt(1).
+while getopts :s:c:b:i:h opt; do
     # Handle errors and long options.
     case "${opt}" in
 	:)
@@ -79,7 +80,7 @@ while getopts :s:c:b:i:hC opt; do
 	--help|h)
 	    exec man notmuch-emacs-mua
 	    ;;
-	--client|C)
+	--client)
 	    USE_EMACSCLIENT="yes"
 	    ;;
 	--subject|s)
-- 
2.1.4

[PATCH 2/2] man: fix notmuch-emacs-mua environment section

[Jani Nikula]

It's emacsclient command, not comment. Document default values. While
at it, format the environment section similarly to other man pages.
---
 doc/man1/notmuch-emacs-mua.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst
index 32b728639188..36b51cdc3b18 100644
--- a/doc/man1/notmuch-emacs-mua.rst
+++ b/doc/man1/notmuch-emacs-mua.rst
@@ -51,11 +51,11 @@ Options may be specified multiple times.
 ENVIRONMENT VARIABLES
 =====================
 
-``EMACS``
-Name of emacs command to invoke
+**EMACS**
+    Name of emacs command to invoke. Defaults to "emacs".
 
-``EMACSCLIENT``
-Name of emacsclient comment to invoke
+**EMACSCLIENT**
+    Name of emacsclient command to invoke. Defaults to "emacsclient".
 
 SEE ALSO
 ========
-- 
2.1.4

Re: [PATCH 1/2] notmuch-emacs-mua: remove -C to keep short options compatible with mutt

[Tomi Ollila]

On Sat, Mar 07 2015, Jani Nikula <jani@nikula.org> wrote:

> Notmuch uses long options exclusively all around. The short options in
> notmuch-emacs-mua are intentionally just a compatible subset of
> mutt(1). Keep it this way, if only to make documenting the fact easy!
>
> The Notmuch style --client long option remains, of course.

Series LGTM.

Tomi

> ---
>  doc/man1/notmuch-emacs-mua.rst | 2 +-
>  notmuch-emacs-mua              | 5 +++--
>  2 files changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/doc/man1/notmuch-emacs-mua.rst b/doc/man1/notmuch-emacs-mua.rst
> index eb47098e11ca..32b728639188 100644
> --- a/doc/man1/notmuch-emacs-mua.rst
> +++ b/doc/man1/notmuch-emacs-mua.rst
> @@ -18,7 +18,7 @@ Supported options for **notmuch-emacs-mua** include
>      ``-h, --help``
>          Display help.
>  
> -    ``-C, --client``
> +    ``--client``
>          Use emacsclient, rather than emacs. This will start
>          an emacs daemon process if necessary.
>  
> diff --git a/notmuch-emacs-mua b/notmuch-emacs-mua
> index b8cbc822fe89..13f67bee4417 100755
> --- a/notmuch-emacs-mua
> +++ b/notmuch-emacs-mua
> @@ -38,7 +38,8 @@ CLIENT_TYPE="-c"
>  ELISP="(prog1 'done (require 'notmuch) (notmuch-mua-new-mail)"
>  ELISP="${ELISP} (setq message-exit-actions (list #'save-buffers-kill-terminal))"
>  
> -while getopts :s:c:b:i:hC opt; do
> +# Short options compatible with mutt(1).
> +while getopts :s:c:b:i:h opt; do
>      # Handle errors and long options.
>      case "${opt}" in
>  	:)
> @@ -79,7 +80,7 @@ while getopts :s:c:b:i:hC opt; do
>  	--help|h)
>  	    exec man notmuch-emacs-mua
>  	    ;;
> -	--client|C)
> +	--client)
>  	    USE_EMACSCLIENT="yes"
>  	    ;;
>  	--subject|s)
> -- 
> 2.1.4
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

Re: [PATCH 1/2] notmuch-emacs-mua: remove -C to keep short options compatible with mutt

[David Bremner]

Jani Nikula <jani@nikula.org> writes:

> Notmuch uses long options exclusively all around. The short options in
> notmuch-emacs-mua are intentionally just a compatible subset of
> mutt(1). Keep it this way, if only to make documenting the fact easy!
>
> The Notmuch style --client long option remains, of course.

pushed.

d