[PATCH] lib: update documentation of callback functions for database_compact and database_upgrade.

[David Bremner]

Jani Nikula  writes:

> The point was, we can do this *now* without soname bumps, because we
> haven't released this yet.

OK, I think we are agreeing violently. This is a bit ephemeral for a
commit message, but not worth re-doing the patch just for that.

d

[PATCH] lib: update documentation of callback functions for database_compact and database_upgrade.

[Jani Nikula]

The point was, we can do this *now* without soname bumps, because we
haven't released this yet.
 On Nov 2, 2013 1:16 AM,  wrote:

> From: David Bremner 
>
> Compact was missing callback documentation entirely, and upgrade did not
> discuss the
> closure parameter.
> ---
> This patch depends on
>
>
> id:2a58adbdc1257f16579692544b4bcbadca3d3045.1383315568.git.jani at nikula.org
>
> BTW, I didn't completely understand the remark about SONAME bumps;
> since we're providing new symbols, it doesn't really matter what the
> signature is?
>
>  lib/notmuch.h | 6 +-
>  1 file changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/lib/notmuch.h b/lib/notmuch.h
> index cd301a4..82fd599 100644
> --- a/lib/notmuch.h
> +++ b/lib/notmuch.h
> @@ -227,6 +227,9 @@ typedef void (*notmuch_compact_status_cb_t)(const char
> *message, void *closure);
>   * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
>   * during the compaction process to ensure no writes are made.
>   *
> + * If the optional callback function 'status_cb' is non-NULL, it will
> + * be called with diagnostic and informational messages. The argument
> + * 'closure' is passed verbatim to any callback invoked.
>   */
>  notmuch_status_t
>  notmuch_database_compact (const char* path,
> @@ -270,7 +273,8 @@ notmuch_database_needs_upgrade (notmuch_database_t
> *database);
>   * provide progress indication to the user. If non-NULL it will be
>   * called periodically with 'progress' as a floating-point value in
>   * the range of [0.0 .. 1.0] indicating the progress made so far in
> - * the upgrade process.
> + * the upgrade process.  The argument 'closure' is passed verbatim to
> + * any callback invoked.
>   */
>  notmuch_status_t
>  notmuch_database_upgrade (notmuch_database_t *database,
> --
> 1.8.4.rc3
>
> ___
> notmuch mailing list
> notmuch at notmuchmail.org
> http://notmuchmail.org/mailman/listinfo/notmuch
>
-- next part --
An HTML attachment was scrubbed...
URL: 

Re: [PATCH] lib: update documentation of callback functions for database_compact and database_upgrade.

[David Bremner]

Jani Nikula j...@nikula.org writes:

 The point was, we can do this *now* without soname bumps, because we
 haven't released this yet.

OK, I think we are agreeing violently. This is a bit ephemeral for a
commit message, but not worth re-doing the patch just for that.

d
___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch

[PATCH] lib: update documentation of callback functions for database_compact and database_upgrade.

[da...@tethera.net]

From: David Bremner 

Compact was missing callback documentation entirely, and upgrade did not 
discuss the
closure parameter.
---
This patch depends on 

 id:2a58adbdc1257f16579692544b4bcbadca3d3045.1383315568.git.jani at 
nikula.org

BTW, I didn't completely understand the remark about SONAME bumps;
since we're providing new symbols, it doesn't really matter what the
signature is?

 lib/notmuch.h | 6 +-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/lib/notmuch.h b/lib/notmuch.h
index cd301a4..82fd599 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -227,6 +227,9 @@ typedef void (*notmuch_compact_status_cb_t)(const char 
*message, void *closure);
  * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
  * during the compaction process to ensure no writes are made.
  *
+ * If the optional callback function 'status_cb' is non-NULL, it will
+ * be called with diagnostic and informational messages. The argument
+ * 'closure' is passed verbatim to any callback invoked.
  */
 notmuch_status_t
 notmuch_database_compact (const char* path,
@@ -270,7 +273,8 @@ notmuch_database_needs_upgrade (notmuch_database_t 
*database);
  * provide progress indication to the user. If non-NULL it will be
  * called periodically with 'progress' as a floating-point value in
  * the range of [0.0 .. 1.0] indicating the progress made so far in
- * the upgrade process.
+ * the upgrade process.  The argument 'closure' is passed verbatim to
+ * any callback invoked.
  */
 notmuch_status_t
 notmuch_database_upgrade (notmuch_database_t *database,
-- 
1.8.4.rc3

[PATCH] lib: update documentation of callback functions for database_compact and database_upgrade.

[david]

From: David Bremner brem...@debian.org

Compact was missing callback documentation entirely, and upgrade did not 
discuss the
closure parameter.
---
This patch depends on 
 
 id:2a58adbdc1257f16579692544b4bcbadca3d3045.1383315568.git.j...@nikula.org

BTW, I didn't completely understand the remark about SONAME bumps;
since we're providing new symbols, it doesn't really matter what the
signature is?

 lib/notmuch.h | 6 +-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/lib/notmuch.h b/lib/notmuch.h
index cd301a4..82fd599 100644
--- a/lib/notmuch.h
+++ b/lib/notmuch.h
@@ -227,6 +227,9 @@ typedef void (*notmuch_compact_status_cb_t)(const char 
*message, void *closure);
  * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
  * during the compaction process to ensure no writes are made.
  *
+ * If the optional callback function 'status_cb' is non-NULL, it will
+ * be called with diagnostic and informational messages. The argument
+ * 'closure' is passed verbatim to any callback invoked.
  */
 notmuch_status_t
 notmuch_database_compact (const char* path,
@@ -270,7 +273,8 @@ notmuch_database_needs_upgrade (notmuch_database_t 
*database);
  * provide progress indication to the user. If non-NULL it will be
  * called periodically with 'progress' as a floating-point value in
  * the range of [0.0 .. 1.0] indicating the progress made so far in
- * the upgrade process.
+ * the upgrade process.  The argument 'closure' is passed verbatim to
+ * any callback invoked.
  */
 notmuch_status_t
 notmuch_database_upgrade (notmuch_database_t *database,
-- 
1.8.4.rc3

___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch

Re: [PATCH] lib: update documentation of callback functions for database_compact and database_upgrade.

[Jani Nikula]

The point was, we can do this *now* without soname bumps, because we
haven't released this yet.
 On Nov 2, 2013 1:16 AM, da...@tethera.net wrote:

 From: David Bremner brem...@debian.org

 Compact was missing callback documentation entirely, and upgrade did not
 discuss the
 closure parameter.
 ---
 This patch depends on


 id:2a58adbdc1257f16579692544b4bcbadca3d3045.1383315568.git.j...@nikula.org

 BTW, I didn't completely understand the remark about SONAME bumps;
 since we're providing new symbols, it doesn't really matter what the
 signature is?

  lib/notmuch.h | 6 +-
  1 file changed, 5 insertions(+), 1 deletion(-)

 diff --git a/lib/notmuch.h b/lib/notmuch.h
 index cd301a4..82fd599 100644
 --- a/lib/notmuch.h
 +++ b/lib/notmuch.h
 @@ -227,6 +227,9 @@ typedef void (*notmuch_compact_status_cb_t)(const char
 *message, void *closure);
   * The database will be opened with NOTMUCH_DATABASE_MODE_READ_WRITE
   * during the compaction process to ensure no writes are made.
   *
 + * If the optional callback function 'status_cb' is non-NULL, it will
 + * be called with diagnostic and informational messages. The argument
 + * 'closure' is passed verbatim to any callback invoked.
   */
  notmuch_status_t
  notmuch_database_compact (const char* path,
 @@ -270,7 +273,8 @@ notmuch_database_needs_upgrade (notmuch_database_t
 *database);
   * provide progress indication to the user. If non-NULL it will be
   * called periodically with 'progress' as a floating-point value in
   * the range of [0.0 .. 1.0] indicating the progress made so far in
 - * the upgrade process.
 + * the upgrade process.  The argument 'closure' is passed verbatim to
 + * any callback invoked.
   */
  notmuch_status_t
  notmuch_database_upgrade (notmuch_database_t *database,
 --
 1.8.4.rc3

 ___
 notmuch mailing list
 notmuch@notmuchmail.org
 http://notmuchmail.org/mailman/listinfo/notmuch

___
notmuch mailing list
notmuch@notmuchmail.org
http://notmuchmail.org/mailman/listinfo/notmuch