doc: logging information added to manpages (7)

[grom72]

This change is 

[osalyk]

Reviewed 2 of 3 files at r1, 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @grom72 and @janekmi)

---

doc/libpmem/libpmem.7.md line 22 at r2 (raw file):

[LIBRARY API VERSIONING](#library-api-versioning-1)<br />
[ENVIRONMENT](#environment)<br />
[DEBUGGING AND ERROR HANDLING](#debugging-and-error-handling)<br />

Here, too, a breakdown is needed

Suggestion:

[ERROR HANDLING](#error-handling)<br />
[DEBUGGING](#debugging)<br />

---

doc/libpmemobj/libpmemobj.7.md line 21 at r2 (raw file):

[LIBRARY API VERSIONING](#library-api-versioning-1)<br />
[MANAGING LIBRARY BEHAVIOR](#managing-library-behavior-1)<br />
[DEBUGGING AND ERROR HANDLING](#debugging-and-error-handling)<br />

.

[grom72]

Reviewable status: 1 of 3 files reviewed, 2 unresolved discussions (waiting on @janekmi and @osalyk)

---

doc/libpmem/libpmem.7.md line 22 at r2 (raw file):

Previously, osalyk (Oksana Sałyk) wrote…

Here, too, a breakdown is needed

Done.

---

doc/libpmemobj/libpmemobj.7.md line 21 at r2 (raw file):

Previously, osalyk (Oksana Sałyk) wrote…

.

Done.

[janekmi]

Reviewed 1 of 1 files at r2, 2 of 2 files at r3, all commit messages.
Reviewable status: all files reviewed, 8 unresolved discussions (waiting on @grom72 and @osalyk)

---

doc/libpmem/libpmem.7.md line 256 at r3 (raw file):

User can provide a custom logging function via **pmem_log_set_function**(3).
In such case all error/warning/info messages are redirected to the custom
function and are written neither to **syslog**(3) nor to **stderr**(3).

Suggestion:

In parallel to the above mechanism, log messages are written to **syslog**(3)
and/or **stderr**(3) or passed to the user-provided logging 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.

---

doc/libpmem/libpmem.7.md line 275 at r3 (raw file):

+ **PMEM_LOG_LEVEL**

The value of **PMEM_LOG_LEVEL** environment variable enables trace points in

Suggestion:

The value of the **PMEM_LOG_LEVEL** environment variable enables trace points in

---

doc/libpmem/libpmem.7.md line 293 at r3 (raw file):

information that is likely only useful to the **libpmem** developers.

Unless **PMEM_LOG_FILE** environment variable is set, debugging output is

Suggestion:

Unless the **PMEM_LOG_FILE** environment variable is set, the debugging output is

---

doc/libpmem/libpmem.7.md line 306 at r3 (raw file):

Whenever either **PMEM_LOG_LEVEL** or **PMEM_LOG_FILE** environment variable is
set no messages are written to **syslog**(3). The same apply to the custom
logging function.

Suggestion:

Whenever either **PMEM_LOG_LEVEL** or **PMEM_LOG_FILE** environment variable is
set the messages are not passed via the routes described in
the ERROR HANDLING section except for the **pmem_errormsg**() which works
unconditionally.

---

doc/libpmemobj/libpmemobj.7.md line 195 at r3 (raw file):

User can provide a custom logging function via **pmemobj_log_set_function**(3).
In such case all error/warning/info messages are redirected to the custom
function and are written neither to **syslog**(3) nor to **stderr**(3).

Suggestion:

In parallel to the above mechanism, log messages are written to **syslog**(3)
and/or **stderr**(3) or passed to the user-provided logging 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.

---

doc/libpmemobj/libpmemobj.7.md line 243 at r3 (raw file):

Whenever either **PMEMOBJ_LOG_LEVEL** or **PMEMOBJ_LOG_FILE** environment
variable is set no messages are written to **syslog**(3). The same apply to
the custom logging function.

Suggestion:

Whenever either **PMEMOBJ_LOG_LEVEL** or **PMEMOBJ_LOG_FILE** environment variable is
set the messages are not passed via the routes described in
the ERROR HANDLING section except for the **pmem_errormsg**() which works
unconditionally.

[grom72]

Reviewable status: 1 of 3 files reviewed, 8 unresolved discussions (waiting on @janekmi and @osalyk)

---

doc/libpmem/libpmem.7.md line 256 at r3 (raw file):

User can provide a custom logging function via **pmem_log_set_function**(3).
In such case all error/warning/info messages are redirected to the custom
function and are written neither to **syslog**(3) nor to **stderr**(3).

Done.

---

doc/libpmem/libpmem.7.md line 275 at r3 (raw file):

+ **PMEM_LOG_LEVEL**

The value of **PMEM_LOG_LEVEL** environment variable enables trace points in

Done.

---

doc/libpmem/libpmem.7.md line 293 at r3 (raw file):

information that is likely only useful to the **libpmem** developers.

Unless **PMEM_LOG_FILE** environment variable is set, debugging output is

Done.

---

doc/libpmem/libpmem.7.md line 306 at r3 (raw file):

Whenever either **PMEM_LOG_LEVEL** or **PMEM_LOG_FILE** environment variable is
set no messages are written to **syslog**(3). The same apply to the custom
logging function.

Done.

---

doc/libpmemobj/libpmemobj.7.md line 195 at r3 (raw file):

User can provide a custom logging function via **pmemobj_log_set_function**(3).
In such case all error/warning/info messages are redirected to the custom
function and are written neither to **syslog**(3) nor to **stderr**(3).

Done.

---

doc/libpmemobj/libpmemobj.7.md line 243 at r3 (raw file):

Whenever either **PMEMOBJ_LOG_LEVEL** or **PMEMOBJ_LOG_FILE** environment
variable is set no messages are written to **syslog**(3). The same apply to
the custom logging function.

Done.

[janekmi]

Reviewed 2 of 2 files at r4, all commit messages.
Reviewable status: all files reviewed, 4 unresolved discussions (waiting on @grom72 and @osalyk)

---

doc/libpmemobj/libpmemobj.7.md line 222 at r4 (raw file):

that is likely only useful to the **libpmemobj** developers.

Unless the **PMEMOBJ_LOG_FILE** environment variable is set, debugging output

Suggestion:

the debugging output

---

doc/libpmemobj/libpmemobj.7.md line 235 at r4 (raw file):

variable is set the messages are not passed via the routes described in
the [ERROR HANDLING](#error-handling) section except for
the **pmem_objerrormsg**() which works unconditionally.

Suggestion:

pmemobj_errormsg

[grom72]

Reviewable status: 2 of 3 files reviewed, 4 unresolved discussions (waiting on @janekmi and @osalyk)

---

doc/libpmemobj/libpmemobj.7.md line 222 at r4 (raw file):

that is likely only useful to the **libpmemobj** developers.

Unless the **PMEMOBJ_LOG_FILE** environment variable is set, debugging output

Done.

---

doc/libpmemobj/libpmemobj.7.md line 235 at r4 (raw file):

variable is set the messages are not passed via the routes described in
the [ERROR HANDLING](#error-handling) section except for
the **pmem_objerrormsg**() which works unconditionally.

Done.

[osalyk]

Reviewed 1 of 1 files at r5, all commit messages.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @janekmi)

[osalyk]

Reviewed 1 of 2 files at r4.
Reviewable status: all files reviewed, 2 unresolved discussions (waiting on @janekmi)

[janekmi]

Reviewed 1 of 1 files at r5, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @grom72)

[osalyk]

Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @grom72)