Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: mark old logging as deprecated #6082

Merged
merged 1 commit into from
May 9, 2024
Merged

doc: mark old logging as deprecated #6082

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions doc/libpmem/libpmem.7.md
View file
Open in desktop
Original file line number Diff line number Diff line change
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
View file
Open in desktop
Original file line number Diff line number Diff line change
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
Loading