Imported Upstream version 2.3.3
[platform/upstream/cryptsetup.git] / docs / examples / crypt_log_usage.c
index e3e4a2a..d8364af 100644 (file)
@@ -1,7 +1,7 @@
 /*
- * An example of using logging through libcryptsetup API
+ * libcryptsetup API log example
  *
- * Copyright (C) 2011, Red Hat, Inc. All rights reserved.
+ * Copyright (C) 2011-2020 Red Hat, Inc. All rights reserved.
  *
  * This file is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Lesser General Public
 #include <libcryptsetup.h>
 
 /*
- * This is an example of function that can be registered using crypt_set_log_callback API.
+ * This is an example of crypt_set_log_callback API callback.
  *
- * Its prototype is void (*log)(int level, const char *msg, void *usrptr) as defined
- * in crypt_set_log_callback
  */
 static void simple_syslog_wrapper(int level, const char *msg, void *usrptr)
 {
@@ -71,7 +69,7 @@ int main(void)
                return 2;
        }
 
-       /* crypt_set_log_callback() - register a log function for crypt context */
+       /* crypt_set_log_callback() - register a log callback for crypt context */
        crypt_set_log_callback(cd, &simple_syslog_wrapper, (void *)usrprefix);
 
        /* send messages ithrough the crypt_log() interface */
@@ -83,7 +81,7 @@ int main(void)
        /* release crypt context */
        crypt_free(cd);
 
-       /* Initialize default (global) log function */
+       /* Initialize default (global) log callback */
        crypt_set_log_callback(NULL, &simple_syslog_wrapper, NULL);
 
        crypt_log(NULL, CRYPT_LOG_NORMAL, "This is normal log message");