unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
* [PATCH 1/4] cli: add global option --stderr=FILE
@ 2013-05-23 18:05 Tomi Ollila
  2013-05-23 18:06 ` [PATCH 2/4] test: added --stderr=FILE tests Tomi Ollila
                   ` (3 more replies)
  0 siblings, 4 replies; 7+ messages in thread
From: Tomi Ollila @ 2013-05-23 18:05 UTC (permalink / raw)
  To: notmuch; +Cc: tomi.ollila

With this option all writes to stderr are redirected to the spesified
FILE (or to stdout on case FILE is '-'). This is immediately useful
in emacs interface as some of its exec intefaces do not provide
separation of stdout and stderr.
---
 notmuch-client.h |  1 +
 notmuch.c        | 31 +++++++++++++++++++++++++++++++
 2 files changed, 32 insertions(+)

diff --git a/notmuch-client.h b/notmuch-client.h
index 45749a6..4a3c7ac 100644
--- a/notmuch-client.h
+++ b/notmuch-client.h
@@ -54,6 +54,7 @@ typedef GMimeCipherContext notmuch_crypto_context_t;
 #include <sys/stat.h>
 #include <sys/time.h>
 #include <unistd.h>
+#include <fcntl.h>
 #include <dirent.h>
 #include <errno.h>
 #include <signal.h>
diff --git a/notmuch.c b/notmuch.c
index f51a84f..77b5282 100644
--- a/notmuch.c
+++ b/notmuch.c
@@ -251,6 +251,31 @@ notmuch_command (notmuch_config_t *config,
     return 0;
 }
 
+static int redirect_stderr (const char * stderr_file)
+{
+    if (strcmp (stderr_file, "-") == 0) {
+	if (dup2 (STDOUT_FILENO, STDERR_FILENO) < 0) {
+	    perror ("dup2");
+	    return 1;
+	}
+    } else {
+	int fd = open (stderr_file, O_WRONLY|O_CREAT|O_APPEND, 0644);
+	if (fd < 0) {
+	    fprintf (stderr, "Error: Cannot redirect stderr to '%s': %s\n",
+		     stderr_file, strerror (errno));
+	    return 1;
+	}
+	if (fd != STDERR_FILENO) {
+	    if (dup2 (fd, STDERR_FILENO) < 0) {
+		perror ("dup2");
+		return 1;
+	    }
+	    close (fd);
+	}
+    }
+    return 0;
+}
+
 int
 main (int argc, char *argv[])
 {
@@ -259,6 +284,7 @@ main (int argc, char *argv[])
     const char *command_name = NULL;
     command_t *command;
     char *config_file_name = NULL;
+    char *stderr_file = NULL;
     notmuch_config_t *config;
     notmuch_bool_t print_help=FALSE, print_version=FALSE;
     int opt_index;
@@ -268,6 +294,7 @@ main (int argc, char *argv[])
 	{ NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
 	{ NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
 	{ NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
+	{ NOTMUCH_OPT_STRING, &stderr_file, "stderr", '\0', 0 },
 	{ 0, 0, 0, 0, 0 }
     };
 
@@ -287,6 +314,10 @@ main (int argc, char *argv[])
 	return 1;
     }
 
+    if (stderr_file && redirect_stderr (stderr_file) != 0) {
+	/* error already printed */
+	return 1;
+    }
     if (print_help)
 	return notmuch_help_command (NULL, argc - 1, &argv[1]);
 
-- 
1.8.1.4

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

* [PATCH 2/4] test: added --stderr=FILE tests
  2013-05-23 18:05 [PATCH 1/4] cli: add global option --stderr=FILE Tomi Ollila
@ 2013-05-23 18:06 ` Tomi Ollila
  2013-05-24  8:03   ` Jani Nikula
  2013-05-23 18:06 ` [PATCH 3/4] man: documented --stderr=FILE in notmuch.1 manual page Tomi Ollila
                   ` (2 subsequent siblings)
  3 siblings, 1 reply; 7+ messages in thread
From: Tomi Ollila @ 2013-05-23 18:06 UTC (permalink / raw)
  To: notmuch; +Cc: tomi.ollila

--stderr=FILE tests were added to test/help-test as it is the one
doing most global option testing. Also, it was simplest to test
this new option using `notmuch help` command.
---

In the future this file (help-test) could be renamed and used in
more generic "global option" testing

 test/help-test | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/test/help-test b/test/help-test
index f7df725..8b77931 100755
--- a/test/help-test
+++ b/test/help-test
@@ -9,4 +9,14 @@ test_expect_success 'notmuch help' 'notmuch help'
 test_expect_success 'notmuch help tag' 'notmuch help tag'
 test_expect_success 'notmuch --version' 'notmuch --version'
 
+test_begin_subtest "notmuch --stderr=stderr help %"
+notmuch --stderr=stderr help %
+test_expect_equal "$(cat stderr)" "
+Sorry, % is not a known command. There's not much I can do to help."
+
+test_begin_subtest "notmuch --stderr=- help %"
+notmuch --stderr=stderr help %
+test_expect_equal "$(notmuch --stderr=- help %)" "
+Sorry, % is not a known command. There's not much I can do to help."
+
 test_done
-- 
1.8.1.4

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

* [PATCH 3/4] man: documented --stderr=FILE in notmuch.1 manual page
  2013-05-23 18:05 [PATCH 1/4] cli: add global option --stderr=FILE Tomi Ollila
  2013-05-23 18:06 ` [PATCH 2/4] test: added --stderr=FILE tests Tomi Ollila
@ 2013-05-23 18:06 ` Tomi Ollila
  2013-05-23 18:06 ` [PATCH 4/4] NEWS: added information about new --stderr=FILE global option Tomi Ollila
  2013-05-25  9:04 ` [PATCH 1/4] cli: add global option --stderr=FILE Mark Walters
  3 siblings, 0 replies; 7+ messages in thread
From: Tomi Ollila @ 2013-05-23 18:06 UTC (permalink / raw)
  To: notmuch; +Cc: tomi.ollila

---
 man/man1/notmuch.1 | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/man/man1/notmuch.1 b/man/man1/notmuch.1
index 033cc10..9292dfc 100644
--- a/man/man1/notmuch.1
+++ b/man/man1/notmuch.1
@@ -76,6 +76,13 @@ Print the installed version of notmuch, and exit.
 Specify the configuration file to use. This overrides any
 configuration file specified by ${NOTMUCH_CONFIG}.
+.RE
+
+.RS 4
+.TP 4
+.B \-\-stderr=FILE
 
+Redirect all writes to stderr to the specified file.
+If the file name is a plain '-', stderr is written to stdout.
 .RE
 
 .SH COMMANDS
-- 
1.8.1.4

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

* [PATCH 4/4] NEWS: added information about new --stderr=FILE global option
  2013-05-23 18:05 [PATCH 1/4] cli: add global option --stderr=FILE Tomi Ollila
  2013-05-23 18:06 ` [PATCH 2/4] test: added --stderr=FILE tests Tomi Ollila
  2013-05-23 18:06 ` [PATCH 3/4] man: documented --stderr=FILE in notmuch.1 manual page Tomi Ollila
@ 2013-05-23 18:06 ` Tomi Ollila
  2013-05-25  9:04 ` [PATCH 1/4] cli: add global option --stderr=FILE Mark Walters
  3 siblings, 0 replies; 7+ messages in thread
From: Tomi Ollila @ 2013-05-23 18:06 UTC (permalink / raw)
  To: notmuch; +Cc: tomi.ollila

---
 NEWS | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/NEWS b/NEWS
index c348068..d148057 100644
--- a/NEWS
+++ b/NEWS
@@ -18,6 +18,12 @@ Bash command-line completion
   `notmuch config`. The new completion support depends on the
   bash-completion package.
 
+New global option `--stderr=FILE`
+
+  With this option all writes to stderr are redirected to the
+  specified file. If file name is a plain '-', stderr is written
+  to stdout.
+
 Vim Front-End
 -------------
 
-- 
1.8.1.4

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

* Re: [PATCH 2/4] test: added --stderr=FILE tests
  2013-05-23 18:06 ` [PATCH 2/4] test: added --stderr=FILE tests Tomi Ollila
@ 2013-05-24  8:03   ` Jani Nikula
  2013-05-25 11:02     ` Jani Nikula
  0 siblings, 1 reply; 7+ messages in thread
From: Jani Nikula @ 2013-05-24  8:03 UTC (permalink / raw)
  To: Tomi Ollila, notmuch; +Cc: tomi.ollila

On Thu, 23 May 2013, Tomi Ollila <tomi.ollila@iki.fi> wrote:
> --stderr=FILE tests were added to test/help-test as it is the one
> doing most global option testing. Also, it was simplest to test
> this new option using `notmuch help` command.
> ---
>
> In the future this file (help-test) could be renamed and used in
> more generic "global option" testing
>
>  test/help-test | 10 ++++++++++
>  1 file changed, 10 insertions(+)
>
> diff --git a/test/help-test b/test/help-test
> index f7df725..8b77931 100755
> --- a/test/help-test
> +++ b/test/help-test
> @@ -9,4 +9,14 @@ test_expect_success 'notmuch help' 'notmuch help'
>  test_expect_success 'notmuch help tag' 'notmuch help tag'
>  test_expect_success 'notmuch --version' 'notmuch --version'
>  
> +test_begin_subtest "notmuch --stderr=stderr help %"
> +notmuch --stderr=stderr help %
> +test_expect_equal "$(cat stderr)" "
> +Sorry, % is not a known command. There's not much I can do to help."
> +
> +test_begin_subtest "notmuch --stderr=- help %"
> +notmuch --stderr=stderr help %

Leftover line from copy-paste?

> +test_expect_equal "$(notmuch --stderr=- help %)" "
> +Sorry, % is not a known command. There's not much I can do to help."
> +
>  test_done
> -- 
> 1.8.1.4
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

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

* Re: [PATCH 1/4] cli: add global option --stderr=FILE
  2013-05-23 18:05 [PATCH 1/4] cli: add global option --stderr=FILE Tomi Ollila
                   ` (2 preceding siblings ...)
  2013-05-23 18:06 ` [PATCH 4/4] NEWS: added information about new --stderr=FILE global option Tomi Ollila
@ 2013-05-25  9:04 ` Mark Walters
  3 siblings, 0 replies; 7+ messages in thread
From: Mark Walters @ 2013-05-25  9:04 UTC (permalink / raw)
  To: Tomi Ollila, notmuch; +Cc: tomi.ollila


This series looks good to me and it does simplify the emacs async error
handling very usefully. +1

Best wishes

Mark


On Thu, 23 May 2013, Tomi Ollila <tomi.ollila@iki.fi> wrote:
> With this option all writes to stderr are redirected to the spesified
> FILE (or to stdout on case FILE is '-'). This is immediately useful
> in emacs interface as some of its exec intefaces do not provide
> separation of stdout and stderr.
> ---
>  notmuch-client.h |  1 +
>  notmuch.c        | 31 +++++++++++++++++++++++++++++++
>  2 files changed, 32 insertions(+)
>
> diff --git a/notmuch-client.h b/notmuch-client.h
> index 45749a6..4a3c7ac 100644
> --- a/notmuch-client.h
> +++ b/notmuch-client.h
> @@ -54,6 +54,7 @@ typedef GMimeCipherContext notmuch_crypto_context_t;
>  #include <sys/stat.h>
>  #include <sys/time.h>
>  #include <unistd.h>
> +#include <fcntl.h>
>  #include <dirent.h>
>  #include <errno.h>
>  #include <signal.h>
> diff --git a/notmuch.c b/notmuch.c
> index f51a84f..77b5282 100644
> --- a/notmuch.c
> +++ b/notmuch.c
> @@ -251,6 +251,31 @@ notmuch_command (notmuch_config_t *config,
>      return 0;
>  }
>  
> +static int redirect_stderr (const char * stderr_file)
> +{
> +    if (strcmp (stderr_file, "-") == 0) {
> +	if (dup2 (STDOUT_FILENO, STDERR_FILENO) < 0) {
> +	    perror ("dup2");
> +	    return 1;
> +	}
> +    } else {
> +	int fd = open (stderr_file, O_WRONLY|O_CREAT|O_APPEND, 0644);
> +	if (fd < 0) {
> +	    fprintf (stderr, "Error: Cannot redirect stderr to '%s': %s\n",
> +		     stderr_file, strerror (errno));
> +	    return 1;
> +	}
> +	if (fd != STDERR_FILENO) {
> +	    if (dup2 (fd, STDERR_FILENO) < 0) {
> +		perror ("dup2");
> +		return 1;
> +	    }
> +	    close (fd);
> +	}
> +    }
> +    return 0;
> +}
> +
>  int
>  main (int argc, char *argv[])
>  {
> @@ -259,6 +284,7 @@ main (int argc, char *argv[])
>      const char *command_name = NULL;
>      command_t *command;
>      char *config_file_name = NULL;
> +    char *stderr_file = NULL;
>      notmuch_config_t *config;
>      notmuch_bool_t print_help=FALSE, print_version=FALSE;
>      int opt_index;
> @@ -268,6 +294,7 @@ main (int argc, char *argv[])
>  	{ NOTMUCH_OPT_BOOLEAN, &print_help, "help", 'h', 0 },
>  	{ NOTMUCH_OPT_BOOLEAN, &print_version, "version", 'v', 0 },
>  	{ NOTMUCH_OPT_STRING, &config_file_name, "config", 'c', 0 },
> +	{ NOTMUCH_OPT_STRING, &stderr_file, "stderr", '\0', 0 },
>  	{ 0, 0, 0, 0, 0 }
>      };
>  
> @@ -287,6 +314,10 @@ main (int argc, char *argv[])
>  	return 1;
>      }
>  
> +    if (stderr_file && redirect_stderr (stderr_file) != 0) {
> +	/* error already printed */
> +	return 1;
> +    }
>      if (print_help)
>  	return notmuch_help_command (NULL, argc - 1, &argv[1]);
>  
> -- 
> 1.8.1.4
>
> _______________________________________________
> notmuch mailing list
> notmuch@notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch

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

* Re: [PATCH 2/4] test: added --stderr=FILE tests
  2013-05-24  8:03   ` Jani Nikula
@ 2013-05-25 11:02     ` Jani Nikula
  0 siblings, 0 replies; 7+ messages in thread
From: Jani Nikula @ 2013-05-25 11:02 UTC (permalink / raw)
  To: Tomi Ollila, notmuch; +Cc: tomi.ollila

On Fri, 24 May 2013, Jani Nikula <jani@nikula.org> wrote:
> On Thu, 23 May 2013, Tomi Ollila <tomi.ollila@iki.fi> wrote:
>> --stderr=FILE tests were added to test/help-test as it is the one
>> doing most global option testing. Also, it was simplest to test
>> this new option using `notmuch help` command.
>> ---
>>
>> In the future this file (help-test) could be renamed and used in
>> more generic "global option" testing
>>
>>  test/help-test | 10 ++++++++++
>>  1 file changed, 10 insertions(+)
>>
>> diff --git a/test/help-test b/test/help-test
>> index f7df725..8b77931 100755
>> --- a/test/help-test
>> +++ b/test/help-test
>> @@ -9,4 +9,14 @@ test_expect_success 'notmuch help' 'notmuch help'
>>  test_expect_success 'notmuch help tag' 'notmuch help tag'
>>  test_expect_success 'notmuch --version' 'notmuch --version'
>>  
>> +test_begin_subtest "notmuch --stderr=stderr help %"
>> +notmuch --stderr=stderr help %
>> +test_expect_equal "$(cat stderr)" "
>> +Sorry, % is not a known command. There's not much I can do to help."
>> +
>> +test_begin_subtest "notmuch --stderr=- help %"
>> +notmuch --stderr=stderr help %
>
> Leftover line from copy-paste?

Apart from this, the whole series LGTM.

BR,
Jani.

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

end of thread, other threads:[~2013-05-25 11:03 UTC | newest]

Thread overview: 7+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2013-05-23 18:05 [PATCH 1/4] cli: add global option --stderr=FILE Tomi Ollila
2013-05-23 18:06 ` [PATCH 2/4] test: added --stderr=FILE tests Tomi Ollila
2013-05-24  8:03   ` Jani Nikula
2013-05-25 11:02     ` Jani Nikula
2013-05-23 18:06 ` [PATCH 3/4] man: documented --stderr=FILE in notmuch.1 manual page Tomi Ollila
2013-05-23 18:06 ` [PATCH 4/4] NEWS: added information about new --stderr=FILE global option Tomi Ollila
2013-05-25  9:04 ` [PATCH 1/4] cli: add global option --stderr=FILE Mark Walters

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