From 4f2765173d2b0a91ae002ae7b8afd02861c0055e Mon Sep 17 00:00:00 2001 From: Oksana Salyk Date: Thu, 9 May 2024 12:42:07 +0200 Subject: [PATCH] doc: mark old logging as deprecated --- doc/libpmem/libpmem.7.md | 9 +++++++-- doc/libpmemobj/libpmemobj.7.md | 9 +++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/doc/libpmem/libpmem.7.md b/doc/libpmem/libpmem.7.md index 1334b752af4..8684d7f8482 100644 --- a/doc/libpmem/libpmem.7.md +++ b/doc/libpmem/libpmem.7.md @@ -21,6 +21,7 @@ header: "pmem API version 1.1" [ENVIRONMENT](#environment)
[ERROR HANDLING](#error-handling)
[DEBUGGING](#debugging)
+[LOGGING (DEPRECATED)](#logging-deprecated)
[EXAMPLE](#example)
[ACKNOWLEDGEMENTS](#acknowledgements)
[SEE ALSO](#see-also) @@ -245,7 +246,7 @@ function. Please see **pmem_log_set_function**(3) for details. The influx of the reported messages can be controlled by setting a respective threshold value. Please see **pmem_log_set_threshold**(3) for details. -# DEBBUGING # +# DEBUGGING # Two versions of **libpmem** are typically available on a development system. The normal version, accessed when a program is linked using the @@ -257,7 +258,11 @@ A second version of **libpmem**, accessed when a program uses the libraries under **/usr/lib/pmdk_debug**, contains run-time assertions and trace points. The typical way to access the debug version is to set the environment variable **LD_LIBRARY_PATH** to **/usr/lib/pmdk_debug** or **/usr/lib64/pmdk_debug**, -as appropriate. Debugging output is controlled using the following environment +as appropriate. + +# LOGGING (DEPRECATED) # + +Debugging output is controlled using the following environment variables. These variables have no effect on the non-debug version of the library. + **PMEM_LOG_LEVEL** diff --git a/doc/libpmemobj/libpmemobj.7.md b/doc/libpmemobj/libpmemobj.7.md index 8fdb6b69d6a..8d2135f9bc2 100644 --- a/doc/libpmemobj/libpmemobj.7.md +++ b/doc/libpmemobj/libpmemobj.7.md @@ -20,6 +20,7 @@ header: "pmemobj API version 2.3" [MANAGING LIBRARY BEHAVIOR](#managing-library-behavior-1)
[ERROR HANDLING](#error-handling)
[DEBUGGING](#debugging)
+[LOGGING (DEPRECATED)](#logging-deprecated)
[EXAMPLE](#example)
[ACKNOWLEDGEMENTS](#acknowledgements)
[SEE ALSO](#see-also)
@@ -184,7 +185,7 @@ function. Please see **pmemobj_log_set_function**(3) for details. The influx of the reported messages can be controlled by setting a respective threshold value. Please see **pmemobj_log_set_threshold**(3) for details. -# DEBBUGING # +# DEBUGGING # Two versions of **libpmemobj** are typically available on a development system. The normal version, accessed when a program is linked using the @@ -196,7 +197,11 @@ A second version of **libpmemobj**, accessed when a program uses the libraries under **/usr/lib/pmdk_debug**, contains run-time assertions and trace points. The typical way to access the debug version is to set the environment variable **LD_LIBRARY_PATH** to **/usr/lib/pmdk_debug** or **/usr/lib64/pmdk_debug**, -as appropriate. Debugging output is controlled using the following environment +as appropriate. + +# LOGGING (DEPRECATED) # + +Debugging output is controlled using the following environment variables. These variables have no effect on the non-debug version of the library. + **PMEMOBJ_LOG_LEVEL**