Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update flux_t * references in man pages #844

Merged
merged 1 commit into from Oct 11, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions doc/man3/flux_attr_get.adoc
Expand Up @@ -12,13 +12,13 @@ SYNOPSIS
--------
#include <flux/core.h>

const char *flux_attr_get (flux_t h, const char *name, int *flags);
const char *flux_attr_get (flux_t *h, const char *name, int *flags);

int flux_attr_set (flux_t h, const char *name, const char *val);
int flux_attr_set (flux_t *h, const char *name, const char *val);

const char *flux_attr_first (flux_t h);
const char *flux_attr_first (flux_t *h);

const char *flux_attr_next (flux_t h);
const char *flux_attr_next (flux_t *h);

DESCRIPTION
-----------
Expand Down
4 changes: 2 additions & 2 deletions doc/man3/flux_aux_set.adoc
Expand Up @@ -14,9 +14,9 @@ SYNOPSIS

typedef void (*flux_free_f)(void *arg);

void *flux_aux_get (flux_t h, const char *name);
void *flux_aux_get (flux_t *h, const char *name);

void flux_aux_set (flux_t h, const char *name, void *aux, flux_free_f destroy);
void flux_aux_set (flux_t *h, const char *name, void *aux, flux_free_f destroy);


DESCRIPTION
Expand Down
4 changes: 2 additions & 2 deletions doc/man3/flux_event_subscribe.adoc
Expand Up @@ -12,9 +12,9 @@ SYNOPSIS
--------
#include <flux/core.h>

int flux_event_subscribe (flux_t h, const char *topic);
int flux_event_subscribe (flux_t *h, const char *topic);

int flux_event_unsubscribe (flux_t h, const char *topic);
int flux_event_unsubscribe (flux_t *h, const char *topic);


DESCRIPTION
Expand Down
6 changes: 3 additions & 3 deletions doc/man3/flux_fatal_set.adoc
Expand Up @@ -15,11 +15,11 @@ SYNOPSIS

typedef void (*flux_fatal_f)(const char *msg, void *arg);

void flux_fatal_set (flux_t h, flux_fatal_f fun, void *arg);
void flux_fatal_set (flux_t *h, flux_fatal_f fun, void *arg);

void flux_fatal_error (flux_t h, const char *fun, const char *msg);
void flux_fatal_error (flux_t *h, const char *fun, const char *msg);

FLUX_FATAL (flux_t h);
FLUX_FATAL (flux_t *h);


DESCRIPTION
Expand Down
6 changes: 3 additions & 3 deletions doc/man3/flux_flags_set.adoc
Expand Up @@ -12,11 +12,11 @@ SYNOPSIS
--------
#include <flux/core.h>

void flux_flags_set (flux_t h, int flags);
void flux_flags_set (flux_t *h, int flags);

void flux_flags_unset (flux_t h, int flags);
void flux_flags_unset (flux_t *h, int flags);

int flux_flags_get (flux_t h);
int flux_flags_get (flux_t *h);


DESCRIPTION
Expand Down
4 changes: 2 additions & 2 deletions doc/man3/flux_get_rank.adoc
Expand Up @@ -12,9 +12,9 @@ SYNOPSIS
--------
#include <flux/core.h>

int flux_get_rank (flux_t h, uint32_t *rank);
int flux_get_rank (flux_t *h, uint32_t *rank);

int flux_get_size (flux_t h, uint32_t *size);
int flux_get_size (flux_t *h, uint32_t *size);


DESCRIPTION
Expand Down
4 changes: 2 additions & 2 deletions doc/man3/flux_get_reactor.adoc
Expand Up @@ -12,9 +12,9 @@ SYNOPSIS
--------
#include <flux/core.h>

flux_reactor_t *flux_get_reactor (flux_t h);
flux_reactor_t *flux_get_reactor (flux_t *h);

int flux_set_reactor (flux_t h, flux_reactor_t *r);
int flux_set_reactor (flux_t *h, flux_reactor_t *r);


DESCRIPTION
Expand Down
4 changes: 2 additions & 2 deletions doc/man3/flux_handle_watcher_create.adoc
Expand Up @@ -17,11 +17,11 @@ SYNOPSIS
int revents, void *arg);

flux_watcher_t *flux_handle_watcher_create (flux_reactor_t *r,
flux_t h, int events,
flux_t *h, int events,
flux_watcher_f callback,
void *arg);

flux_t flux_handle_watcher_get_flux (flux_watcher_t *w);
flux_t *flux_handle_watcher_get_flux (flux_watcher_t *w);


DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_msg_handler_addvec.adoc
Expand Up @@ -19,7 +19,7 @@ SYNOPSIS
flux_msg_handler_t *w;
};

int flux_msg_handler_addvec (flux_t h,
int flux_msg_handler_addvec (flux_t *h,
struct flux_msg_handler_spec tab[],
void *arg);

Expand Down
4 changes: 2 additions & 2 deletions doc/man3/flux_msg_handler_create.adoc
Expand Up @@ -13,13 +13,13 @@ SYNOPSIS
--------
#include <flux/core.h>

typedef void (*flux_msg_handler_f)(flux_t h,
typedef void (*flux_msg_handler_f)(flux_t *h,
flux_msg_handler_t *w,
const flux_msg_t *msg,
void *arg);

flux_msg_handler_t *
flux_msg_handler_create (flux_t h,
flux_msg_handler_create (flux_t *h,
const struct flux_match match,
flux_msg_handler_f callback,
void *arg);
Expand Down
4 changes: 2 additions & 2 deletions doc/man3/flux_open.adoc
Expand Up @@ -12,9 +12,9 @@ SYNOPSIS
--------
#include <flux/core.h>

flux_t flux_open (const char *uri, int flags);
flux_t *flux_open (const char *uri, int flags);

void flux_close (flux_t h);
void flux_close (flux_t *h);


DESCRIPTION
Expand Down
10 changes: 5 additions & 5 deletions doc/man3/flux_pollevents.adoc
Expand Up @@ -12,9 +12,9 @@ SYNOPSIS
--------
#include <flux/core.h>

int flux_pollevents (flux_t h);
int flux_pollevents (flux_t *h);

int flux_pollfd (flux_t h);
int flux_pollfd (flux_t *h);


DESCRIPTION
Expand Down Expand Up @@ -103,7 +103,7 @@ struct ev_flux {
ev_prepare prepare_w;
ev_idle idle_w;
ev_check check_w;
flux_t h;
flux_t *h;
int pollfd;
int events;
ev_flux_f cb;
Expand All @@ -114,7 +114,7 @@ struct ev_flux {

....
// ev_flux.c
static int get_pollevents (flux_t h)
static int get_pollevents (flux_t *h)
{
int e = flux_pollevents (h);
int events = 0;
Expand Down Expand Up @@ -155,7 +155,7 @@ static void check_cb (struct ev_loop *loop, ev_check *w,
}

int ev_flux_init (struct ev_flux *w, ev_flux_f cb,
flux_t h, int events)
flux_t *h, int events)
{
w->cb = cb;
w->h = h;
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_recv.adoc
Expand Up @@ -12,7 +12,7 @@ SYNOPSIS
--------
#include <flux/core.h>

flux_msg_t *flux_recv (flux_t h, struct flux_match match, int flags);
flux_msg_t *flux_recv (flux_t *h, struct flux_match match, int flags);


DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_reduce_create.adoc
Expand Up @@ -21,7 +21,7 @@ SYNOPSIS
int (*itemweight)(void *item);
};

flux_reduce_t *flux_reduce_create (flux_t h, flux_reduce_ops ops,
flux_reduce_t *flux_reduce_create (flux_t *h, flux_reduce_ops ops,
double timeout, void *arg, int flags);

void flux_reduce_destroy (flux_reduce_t *r);
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_requeue.adoc
Expand Up @@ -12,7 +12,7 @@ SYNOPSIS
--------
#include <flux/core.h>

int flux_requeue (flux_t h, const flux_msg_t *msg, int flags);
int flux_requeue (flux_t *h, const flux_msg_t *msg, int flags);


DESCRIPTION
Expand Down
4 changes: 2 additions & 2 deletions doc/man3/flux_respond.adoc
Expand Up @@ -12,10 +12,10 @@ SYNOPSIS
--------
#include <flux/core.h>

int flux_respond (flux_t h, const flux_msg_t *request,
int flux_respond (flux_t *h, const flux_msg_t *request,
int errnum, const char *json_str);

int flux_respond_raw (flux_t h, const flux_msg_t *request,
int flux_respond_raw (flux_t *h, const flux_msg_t *request,
int errnum, const void *data, int length);

DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_rpc.adoc
Expand Up @@ -12,7 +12,7 @@ SYNOPSIS
--------
#include <flux/core.h>

flux_rpc_t *flux_rpc (flux_t h, const char *topic,
flux_rpc_t *flux_rpc (flux_t *h, const char *topic,
const char *json_in,
uint32_t nodeid_in, int flags);

Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_rpc_multi.adoc
Expand Up @@ -12,7 +12,7 @@ SYNOPSIS
--------
#include <flux/core.h>

flux_rpc_t *flux_rpc_multi (flux_t h, const char *topic, const char *json_str,
flux_rpc_t *flux_rpc_multi (flux_t *h, const char *topic, const char *json_str,
const char *nodeset, int flags);

bool flux_rpc_completed (flux_rpc_t *rpc);
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_rpc_raw.adoc
Expand Up @@ -12,7 +12,7 @@ SYNOPSIS
--------
#include <flux/core.h>

flux_rpc_t *flux_rpc_raw (flux_t h, const char *topic,
flux_rpc_t *flux_rpc_raw (flux_t *h, const char *topic,
const void *data_in, int length_in,
uint32_t nodeid_in, int flags);

Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_send.adoc
Expand Up @@ -12,7 +12,7 @@ SYNOPSIS
--------
#include <flux/core.h>

int flux_send (flux_t h, const flux_msg_t *msg, int flags);
int flux_send (flux_t *h, const flux_msg_t *msg, int flags);


DESCRIPTION
Expand Down