diff options
author | Ondrej Kozina <okozina@redhat.com> | 2015-05-22 14:25:54 +0200 |
---|---|---|
committer | Ondrej Kozina <okozina@redhat.com> | 2015-06-08 16:01:32 +0200 |
commit | b89ad7e2d4a5dd5e1947c2b14941f6a87d354451 (patch) | |
tree | 38ab64ca1cd4370f4606c75a4d32fd27819a1fc9 | |
parent | 3225f8d17596b79b76ed9da5291843d02a2aa7b6 (diff) | |
download | lvm2-b89ad7e2d4a5dd5e1947c2b14941f6a87d354451.tar.gz |
lvmetad.h: rephrase API descriptions
Some of descritpions were misleading at least. Some were completely
off the reality.
lvmetad_init doesn't re-establish or initialise a connection
lvmetad_active and lvmetad_connect_or_warn can do so.
-rw-r--r-- | lib/cache/lvmetad.h | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/lib/cache/lvmetad.h b/lib/cache/lvmetad.h index 6769f7668..395bc41b0 100644 --- a/lib/cache/lvmetad.h +++ b/lib/cache/lvmetad.h @@ -29,8 +29,7 @@ typedef int (*activation_handler) (struct cmd_context *cmd, #ifdef LVMETAD_SUPPORT /* - * Initialise the communication with lvmetad. Normally called by - * lvmcache_init. Sets up a global handle for our process. + * Sets up a global handle for our process. */ void lvmetad_init(struct cmd_context *); @@ -59,7 +58,9 @@ int lvmetad_socket_present(void); /* * Check whether lvmetad is active (where active means both that it is running - * and that we have a working connection with it). + * and that we have a working connection with it). It opens new connection + * with lvmetad in the process when lvmetad is supposed to be used and the + * connection is not open yet. */ int lvmetad_active(void); @@ -70,8 +71,9 @@ int lvmetad_active(void); void lvmetad_connect_or_warn(void); /* - * Drop connection to lvmetad. A subsequent lvmetad_init() will re-establish - * the connection (possibly at a different socket path). + * Drop connection to lvmetad. A subsequent lvmetad_connect_or_warn or + * lvmetad_active will re-establish the connection (possibly at a + * different socket path). */ void lvmetad_disconnect(void); |