Skip to content

Commit

Permalink
doc: update section 3 manual with size_t changes
Browse files Browse the repository at this point in the history
Problem: some public functions have new footprints but the
section 3 manual does not reflect this.

Update manual.
  • Loading branch information
garlick committed Dec 2, 2024
1 parent e72c07e commit b06d055
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions doc/man3/flux_event_decode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SYNOPSIS
int flux_event_decode_raw (const flux_msg_t *msg,
const char **topic,
const void **data,
int *len);
size_t *len);
int flux_event_unpack (const flux_msg_t *msg,
const char **topic,
Expand All @@ -29,7 +29,7 @@ SYNOPSIS
flux_msg_t *flux_event_encode_raw (const char *topic,
const void *data,
int len);
size_t len);
flux_msg_t *flux_event_pack (const char *topic,
const char *fmt,
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_event_publish.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ SYNOPSIS
const char *topic,
int flags,
const void *data,
int len);
size_t len);
int flux_event_publish_get_seq (flux_future_t *f, int *seq);
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_kvs_lookup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ SYNOPSIS
int flux_kvs_lookup_get_raw (flux_future_t *f,
const void **data
int *len);
size_t *len);
int flux_kvs_lookup_get_dir (flux_future_t *f,
const flux_kvsdir_t **dir);
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_kvs_txn_create.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ SYNOPSIS
int flags,
const char *key,
const void *data,
int len);
size_t len);
int flux_kvs_txn_put_treeobj (flux_kvs_txn_t *txn,
int flags,
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_request_decode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ SYNOPSIS
int flux_request_decode_raw (const flux_msg_t *msg,
const char **topic,
const void **data,
int *len);
size_t *len);
Link with :command:`-lflux-core`.

Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_request_encode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ SYNOPSIS
flux_msg_t *flux_request_encode_raw (const char *topic,
void *data,
int len);
size_t len);
Link with :command:`-lflux-core`.

Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_respond.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ SYNOPSIS
int flux_respond_raw (flux_t *h,
const flux_msg_t *request,
const void *data,
int length);
size_t length);
int flux_respond_error (flux_t *h,
const flux_msg_t *request,
Expand Down
2 changes: 1 addition & 1 deletion doc/man3/flux_response_decode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ SYNOPSIS
int flux_response_decode_raw (const flux_msg_t *msg,
const char **topic,
const void **data,
int *len);
size_t *len);
int flux_response_decode_error (const flux_msg_t *msg,
const char *errstr);
Expand Down
4 changes: 2 additions & 2 deletions doc/man3/flux_rpc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ SYNOPSIS
flux_future_t *flux_rpc_raw (flux_t *h,
const char *topic,
const void *data,
int len,
size_t len,
uint32_t nodeid,
int flags);
Expand All @@ -42,7 +42,7 @@ SYNOPSIS
int flux_rpc_get_raw (flux_future_t *f,
const void **data,
int *len);
size_t *len);
uint32_t flux_rpc_get_matchtag (flux_future_t *f);
Expand Down

0 comments on commit b06d055

Please sign in to comment.