doc: mark old logging as deprecated #6082
Conversation
osalyk
added
sprint goal
There was a problem hiding this comment.
Reviewed all commit messages.
Reviewable status: 0 of 3 files reviewed, 1 unresolved discussion (waiting on @osalyk)
a discussion (no related file):
#6083 has landed. Please rebase and continue as discussed when ready. :-)
There was a problem hiding this comment.
Reviewable status: 0 of 3 files reviewed, 1 unresolved discussion (waiting on @janekmi)
a discussion (no related file):
Previously, janekmi (Jan Michalski) wrote…
#6083 has landed. Please rebase and continue as discussed when ready. :-)
Done.
There was a problem hiding this comment.
Reviewed 1 of 3 files at r2, all commit messages.
Reviewable status: 1 of 3 files reviewed, all discussions resolved
doc/libpmem/libpmem.7.md line 248 at r2 (raw file):
threshold value. Please see **pmem_log_set_threshold**(3) for details. # DEBBUGING #
@grom72 😆
There was a problem hiding this comment.
Reviewed 2 of 3 files at r2.
Reviewable status: all files reviewed, 4 unresolved discussions (waiting on @osalyk)
doc/libpmem/libpmem.7.md line 24 at r2 (raw file):
[ERROR HANDLING](#error-handling)<br /> [DEBUGGING](#debugging)<br /> [LOGGING](#logging)<br />
Assuming we agree to keep both of them in a single line. Please see the comment below.
Suggestion:
[LOGGING (DEPRECATED)](#logging-deprecated)<br />doc/libpmem/libpmem.7.md line 264 at r2 (raw file):
# LOGGING # **(DEPRECATED)**
LOGGING
(DEPRECATED)
Debugging output is controlled using the following environment variables. These variables have no effect
It looks a little bit odd in the output. Having no new line between the two you end up basically with a two-line header. I think it would look better as a single line:
LOGGING (DEPRECATED)
Debugging output is controlled using the following environment variables. These variables have no effect
Note: The bold is unnecessary since headers are already in bold.
Suggestion:
# LOGGING (DEPRECATED) #doc/libpmemobj/libpmemobj.7.md line 23 at r2 (raw file):
[ERROR HANDLING](#error-handling)<br /> [DEBUGGING](#debugging)<br /> [LOGGING](#logging)<br />
.
doc/libpmemobj/libpmemobj.7.md line 203 at r2 (raw file):
# LOGGING # **(DEPRECATED)**
Suggestion:
# LOGGING (DEPRECATED) #
There was a problem hiding this comment.
Reviewable status: all files reviewed, 4 unresolved discussions (waiting on @osalyk)
There was a problem hiding this comment.
Reviewable status: 1 of 3 files reviewed, 4 unresolved discussions (waiting on @janekmi)
doc/libpmem/libpmem.7.md line 24 at r2 (raw file):
Previously, janekmi (Jan Michalski) wrote…
Assuming we agree to keep both of them in a single line. Please see the comment below.
Done.
doc/libpmem/libpmem.7.md line 264 at r2 (raw file):
Previously, janekmi (Jan Michalski) wrote…
LOGGING (DEPRECATED) Debugging output is controlled using the following environment variables. These variables have no effectIt looks a little bit odd in the output. Having no new line between the two you end up basically with a two-line header. I think it would look better as a single line:
LOGGING (DEPRECATED) Debugging output is controlled using the following environment variables. These variables have no effectNote: The bold is unnecessary since headers are already in bold.
Done.
doc/libpmemobj/libpmemobj.7.md line 23 at r2 (raw file):
Previously, janekmi (Jan Michalski) wrote…
.
Done.
doc/libpmemobj/libpmemobj.7.md line 203 at r2 (raw file):
# LOGGING # **(DEPRECATED)**
Done.
There was a problem hiding this comment.
Reviewed 2 of 2 files at r3, all commit messages.
Reviewable status:complete! all files reviewed, all discussions resolved (waiting on @osalyk)
This change is