Skip to content

Commit 4f27651

Browse files
committed
doc: mark old logging as deprecated
1 parent c832d31 commit 4f27651

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

doc/libpmem/libpmem.7.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ header: "pmem API version 1.1"
2121
[ENVIRONMENT](#environment)<br />
2222
[ERROR HANDLING](#error-handling)<br />
2323
[DEBUGGING](#debugging)<br />
24+
[LOGGING (DEPRECATED)](#logging-deprecated)<br />
2425
[EXAMPLE](#example)<br />
2526
[ACKNOWLEDGEMENTS](#acknowledgements)<br />
2627
[SEE ALSO](#see-also)
@@ -245,7 +246,7 @@ function. Please see **pmem_log_set_function**(3) for details.
245246
The influx of the reported messages can be controlled by setting a respective
246247
threshold value. Please see **pmem_log_set_threshold**(3) for details.
247248

248-
# DEBBUGING #
249+
# DEBUGGING #
249250

250251
Two versions of **libpmem** are typically available on a development
251252
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
257258
under **/usr/lib/pmdk_debug**, contains run-time assertions and trace points.
258259
The typical way to access the debug version is to set the environment variable
259260
**LD_LIBRARY_PATH** to **/usr/lib/pmdk_debug** or **/usr/lib64/pmdk_debug**,
260-
as appropriate. Debugging output is controlled using the following environment
261+
as appropriate.
262+
263+
# LOGGING (DEPRECATED) #
264+
265+
Debugging output is controlled using the following environment
261266
variables. These variables have no effect on the non-debug version of the library.
262267

263268
+ **PMEM_LOG_LEVEL**

doc/libpmemobj/libpmemobj.7.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ header: "pmemobj API version 2.3"
2020
[MANAGING LIBRARY BEHAVIOR](#managing-library-behavior-1)<br />
2121
[ERROR HANDLING](#error-handling)<br />
2222
[DEBUGGING](#debugging)<br />
23+
[LOGGING (DEPRECATED)](#logging-deprecated)<br />
2324
[EXAMPLE](#example)<br />
2425
[ACKNOWLEDGEMENTS](#acknowledgements)<br />
2526
[SEE ALSO](#see-also)<br />
@@ -184,7 +185,7 @@ function. Please see **pmemobj_log_set_function**(3) for details.
184185
The influx of the reported messages can be controlled by setting a respective
185186
threshold value. Please see **pmemobj_log_set_threshold**(3) for details.
186187

187-
# DEBBUGING #
188+
# DEBUGGING #
188189

189190
Two versions of **libpmemobj** are typically available on a development
190191
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
196197
under **/usr/lib/pmdk_debug**, contains run-time assertions and trace points.
197198
The typical way to access the debug version is to set the environment variable
198199
**LD_LIBRARY_PATH** to **/usr/lib/pmdk_debug** or **/usr/lib64/pmdk_debug**,
199-
as appropriate. Debugging output is controlled using the following environment
200+
as appropriate.
201+
202+
# LOGGING (DEPRECATED) #
203+
204+
Debugging output is controlled using the following environment
200205
variables. These variables have no effect on the non-debug version of the library.
201206

202207
+ **PMEMOBJ_LOG_LEVEL**

0 commit comments

Comments
 (0)