Skip to content

Commit

Permalink
Merge pull request #6082 from osalyk/logging_deprecated
Browse files Browse the repository at this point in the history
doc: mark old logging as deprecated
  • Loading branch information
janekmi committed May 9, 2024
2 parents c832d31 + 4f27651 commit ff78d98
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
9 changes: 7 additions & 2 deletions doc/libpmem/libpmem.7.md
Expand Up @@ -21,6 +21,7 @@ header: "pmem API version 1.1"
[ENVIRONMENT](#environment)<br />
[ERROR HANDLING](#error-handling)<br />
[DEBUGGING](#debugging)<br />
[LOGGING (DEPRECATED)](#logging-deprecated)<br />
[EXAMPLE](#example)<br />
[ACKNOWLEDGEMENTS](#acknowledgements)<br />
[SEE ALSO](#see-also)
Expand Down Expand Up @@ -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
Expand All @@ -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**
Expand Down
9 changes: 7 additions & 2 deletions doc/libpmemobj/libpmemobj.7.md
Expand Up @@ -20,6 +20,7 @@ header: "pmemobj API version 2.3"
[MANAGING LIBRARY BEHAVIOR](#managing-library-behavior-1)<br />
[ERROR HANDLING](#error-handling)<br />
[DEBUGGING](#debugging)<br />
[LOGGING (DEPRECATED)](#logging-deprecated)<br />
[EXAMPLE](#example)<br />
[ACKNOWLEDGEMENTS](#acknowledgements)<br />
[SEE ALSO](#see-also)<br />
Expand Down Expand Up @@ -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
Expand All @@ -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**
Expand Down

0 comments on commit ff78d98

Please sign in to comment.