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.

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

common: 2.1.0 documentation update #6071

Merged
merged 1 commit into from
Apr 3, 2024
Merged

Conversation

grom72
Copy link
Contributor

@grom72 grom72 commented Mar 28, 2024

This change is Reviewable

@grom72 grom72 requested review from janekmi and osalyk March 28, 2024 07:50
@grom72 grom72 added the sprint goal This pull request is part of the ongoing sprint label Mar 28, 2024
@grom72 grom72 added this to the 2.1.0 milestone Mar 28, 2024
Copy link
Contributor

@osalyk osalyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


ChangeLog line 8 at r1 (raw file):

	- Introduces the new logging subsystem in the release version of all libraries.
	  Messages by default are printed to syslog and stderr but might be redirected to user defined function,
	  see pmemobj_log_set_function() for details.

Suggestion:

see pmem(obj)_log_set_function() for details.

Copy link
Contributor

@janekmi janekmi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: all files reviewed, 10 unresolved discussions (waiting on @grom72)


ChangeLog line 5 at r1 (raw file):

	* Version 2.1.0

	This release

Suggestion:

This release:

ChangeLog line 6 at r1 (raw file):


	This release
	- Introduces the new logging subsystem in the release version of all libraries.

Suggestion:

Introduces the new logging subsystem in the release build for all libraries.

ChangeLog line 8 at r1 (raw file):

	- Introduces the new logging subsystem in the release version of all libraries.
	  Messages by default are printed to syslog and stderr but might be redirected to user defined function,
	  see pmemobj_log_set_function() for details.

Suggestion:

	    - Messages by default are printed to syslog and stderr but might be redirected to a user-defined function,
	  see pmemobj_log_set_function() for details.

ChangeLog line 9 at r1 (raw file):

	  Messages by default are printed to syslog and stderr but might be redirected to user defined function,
	  see pmemobj_log_set_function() for details.
	  Log level threshold is cntroled via new API, see pmem(obj)_log_set_treshold() for details.

Suggestion:

  - Log level thresholds are controlled via new API, see pmem(obj)_log_set_treshold() for details.

ChangeLog line 9 at r1 (raw file):

	  Messages by default are printed to syslog and stderr but might be redirected to user defined function,
	  see pmemobj_log_set_function() for details.
	  Log level threshold is cntroled via new API, see pmem(obj)_log_set_treshold() for details.

Code snippet:

- These new APIs are not available for LIBPMEM2 and LIBPMEMPOOL at the moment.

ChangeLog line 10 at r1 (raw file):

	  see pmemobj_log_set_function() for details.
	  Log level threshold is cntroled via new API, see pmem(obj)_log_set_treshold() for details.
	  The new logging is suppressed in debug version when PMEM_LOG_LEVEL/PMEM2_LOG_LEVEL/PMEMOBJ_LOG_LEVEL environment varaibles are set.

Suggestion:

	  - The new logging subsystem is suppressed in the debug build when
	    the legacy debug logging environment varaibles are set:
	    - PMEM_LOG_LEVEL/_FILE
	    - PMEM2_LOG_LEVEL/_FILE
	    - PMEMOBJ_LOG_LEVEL/_FILE
	    - PMEMPOOL_LOG_LEVEL/_FILE

ChangeLog line 10 at r1 (raw file):

	  see pmemobj_log_set_function() for details.
	  Log level threshold is cntroled via new API, see pmem(obj)_log_set_treshold() for details.
	  The new logging is suppressed in debug version when PMEM_LOG_LEVEL/PMEM2_LOG_LEVEL/PMEMOBJ_LOG_LEVEL environment varaibles are set.

Code snippet:

- The debug logging subsystem becomes deprecated.

ChangeLog line 14 at r1 (raw file):

	  - PMEMOBJ_IGNORE_DIRTY_SHUTDOWN and PMEMOBJ_IGNORE_BAD_BLOCKS are required to acknowledge
	    the understanding of what production-critical functions are missing for the build without NDCTL
	- Does not allow opening PMem pool without unsafe shoutdown counter (USC) if not explicitly disabled (#5968)

Suggestion:

Does not allow opening PMEMOBJ pool without unsafe shutdown counter (USC) if not explicitly disabled (#5968)

ChangeLog line 16 at r1 (raw file):

	- Does not allow opening PMem pool without unsafe shoutdown counter (USC) if not explicitly disabled (#5968)
	  - use PMEMOBJ_CONF="sds.at_create=0" to disable USC when working without PMem (emulated PMem, Docker, etc.)
	- Removes support for build time define NO_LIBPTHREAD

Suggestion:

Drops support for building without libpthread (NO_LIBPTHREAD build-time define)

Copy link

codecov bot commented Apr 2, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.12%. Comparing base (fe46289) to head (39ca94a).
Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6071   +/-   ##
=======================================
  Coverage   70.12%   70.12%           
=======================================
  Files         133      133           
  Lines       19568    19568           
  Branches     3261     3261           
=======================================
  Hits        13723    13723           
  Misses       5845     5845           

Copy link
Contributor Author

@grom72 grom72 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


ChangeLog line 5 at r1 (raw file):

	* Version 2.1.0

	This release

Done.


ChangeLog line 6 at r1 (raw file):


	This release
	- Introduces the new logging subsystem in the release version of all libraries.

Done.


ChangeLog line 8 at r1 (raw file):

	- Introduces the new logging subsystem in the release version of all libraries.
	  Messages by default are printed to syslog and stderr but might be redirected to user defined function,
	  see pmemobj_log_set_function() for details.

Done.


ChangeLog line 8 at r1 (raw file):

	- Introduces the new logging subsystem in the release version of all libraries.
	  Messages by default are printed to syslog and stderr but might be redirected to user defined function,
	  see pmemobj_log_set_function() for details.

Done.


ChangeLog line 9 at r1 (raw file):

	  Messages by default are printed to syslog and stderr but might be redirected to user defined function,
	  see pmemobj_log_set_function() for details.
	  Log level threshold is cntroled via new API, see pmem(obj)_log_set_treshold() for details.

Done.


ChangeLog line 9 at r1 (raw file):

	  Messages by default are printed to syslog and stderr but might be redirected to user defined function,
	  see pmemobj_log_set_function() for details.
	  Log level threshold is cntroled via new API, see pmem(obj)_log_set_treshold() for details.

Done.


ChangeLog line 10 at r1 (raw file):

	  see pmemobj_log_set_function() for details.
	  Log level threshold is cntroled via new API, see pmem(obj)_log_set_treshold() for details.
	  The new logging is suppressed in debug version when PMEM_LOG_LEVEL/PMEM2_LOG_LEVEL/PMEMOBJ_LOG_LEVEL environment varaibles are set.

Done.


ChangeLog line 10 at r1 (raw file):

	  see pmemobj_log_set_function() for details.
	  Log level threshold is cntroled via new API, see pmem(obj)_log_set_treshold() for details.
	  The new logging is suppressed in debug version when PMEM_LOG_LEVEL/PMEM2_LOG_LEVEL/PMEMOBJ_LOG_LEVEL environment varaibles are set.

Done.


ChangeLog line 14 at r1 (raw file):

	  - PMEMOBJ_IGNORE_DIRTY_SHUTDOWN and PMEMOBJ_IGNORE_BAD_BLOCKS are required to acknowledge
	    the understanding of what production-critical functions are missing for the build without NDCTL
	- Does not allow opening PMem pool without unsafe shoutdown counter (USC) if not explicitly disabled (#5968)

Done.


ChangeLog line 16 at r1 (raw file):

	- Does not allow opening PMem pool without unsafe shoutdown counter (USC) if not explicitly disabled (#5968)
	  - use PMEMOBJ_CONF="sds.at_create=0" to disable USC when working without PMem (emulated PMem, Docker, etc.)
	- Removes support for build time define NO_LIBPTHREAD

Done.

Copy link
Contributor

@janekmi janekmi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

a discussion (no related file):
Either do not break long lines at all or break them at the 80-character limit. ATM you are proposing something in between. It looks ugly.



ChangeLog line 5 at r1 (raw file):

Previously, grom72 (Tomasz Gromadzki) wrote…

Done.

Can we drop this nonsense of having a space ahead of a colon here?


ChangeLog line 8 at r1 (raw file):

Previously, grom72 (Tomasz Gromadzki) wrote…

Done.

Nope.


ChangeLog line 7 at r2 (raw file):

	This release :
	- Introduces the new logging subsystem in the release build for all libraries.
	  - Messages by default are printed to syslog and stderr but might be redirected to a user defined function,

IMHO It is non-optional.

Suggestion:

user-defined

ChangeLog line 9 at r2 (raw file):

	  - Messages by default are printed to syslog and stderr but might be redirected to a user defined function,
	    see pmemobj_log_set_function() for details.
	  - Log level threshold is cntroled via new API, see pmemobj_log_set_treshold()/pmem_log_set_treshold() for details.

Suggestion:

Log level thresholds are controlled

ChangeLog line 11 at r2 (raw file):

	  - Log level threshold is cntroled via new API, see pmemobj_log_set_treshold()/pmem_log_set_treshold() for details.
	  - These new APIs are not available for LIBPMEM2 and LIBPMEMPOOL at the moment.
	  - The new logging subsystem is suppressed in the debug build when any of the legacy debug logging environment varaible is set:

Suggestion:

variables 

@grom72 grom72 force-pushed the 2.1.0-changelog branch 2 times, most recently from e2bc617 to ee7d0ee Compare April 2, 2024 15:13
Copy link
Contributor Author

@grom72 grom72 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

a discussion (no related file):

Previously, janekmi (Jan Michalski) wrote…

Either do not break long lines at all or break them at the 80-character limit. ATM you are proposing something in between. It looks ugly.

Done.



ChangeLog line 5 at r1 (raw file):

Previously, janekmi (Jan Michalski) wrote…

Can we drop this nonsense of having a space ahead of a colon here?

Done.


ChangeLog line 8 at r1 (raw file):

Previously, janekmi (Jan Michalski) wrote…

Nope.

Done.


ChangeLog line 7 at r2 (raw file):

Previously, janekmi (Jan Michalski) wrote…

IMHO It is non-optional.

Done.


ChangeLog line 9 at r2 (raw file):

	  - Messages by default are printed to syslog and stderr but might be redirected to a user defined function,
	    see pmemobj_log_set_function() for details.
	  - Log level threshold is cntroled via new API, see pmemobj_log_set_treshold()/pmem_log_set_treshold() for details.

Done.


ChangeLog line 11 at r2 (raw file):

	  - Log level threshold is cntroled via new API, see pmemobj_log_set_treshold()/pmem_log_set_treshold() for details.
	  - These new APIs are not available for LIBPMEM2 and LIBPMEMPOOL at the moment.
	  - The new logging subsystem is suppressed in the debug build when any of the legacy debug logging environment varaible is set:

Done.

Copy link
Contributor Author

@grom72 grom72 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 1 of 1 files at r4, all commit messages.
Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @janekmi and @osalyk)

Copy link
Contributor

@janekmi janekmi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


ChangeLog line 9 at r2 (raw file):

Previously, grom72 (Tomasz Gromadzki) wrote…

Done.

Nope.


ChangeLog line 11 at r2 (raw file):

Previously, grom72 (Tomasz Gromadzki) wrote…

Done.

Nope.

Copy link
Contributor Author

@grom72 grom72 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


ChangeLog line 9 at r2 (raw file):

Previously, janekmi (Jan Michalski) wrote…

Nope.

Done.


ChangeLog line 11 at r2 (raw file):

Previously, janekmi (Jan Michalski) wrote…

Nope.

Done.

Copy link
Contributor

@osalyk osalyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

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

Copy link
Contributor

@janekmi janekmi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


ChangeLog line 8 at r5 (raw file):

	- Introduces the new logging subsystem in the release build for all libraries.
	  - Messages by default are printed to syslog and stderr but might be redirected to a user-defined function, see pmem(obj)_log_set_function() for details.
	  - Log level thresholds are cntrolled via new API, see pmem(obj)_log_set_treshold() for details.

Suggestion:

controlled

Signed-off-by: Tomasz Gromadzki <tomasz.gromadzki@intel.com>
Copy link
Contributor Author

@grom72 grom72 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewable status: 0 of 1 files reviewed, 1 unresolved discussion (waiting on @janekmi and @osalyk)


ChangeLog line 8 at r5 (raw file):

	- Introduces the new logging subsystem in the release build for all libraries.
	  - Messages by default are printed to syslog and stderr but might be redirected to a user-defined function, see pmem(obj)_log_set_function() for details.
	  - Log level thresholds are cntrolled via new API, see pmem(obj)_log_set_treshold() for details.

Done.

Copy link
Contributor Author

@grom72 grom72 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed 1 of 1 files at r6.
Reviewable status: all files reviewed (commit messages unreviewed), 1 unresolved discussion (waiting on @janekmi)

Copy link
Contributor

@janekmi janekmi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

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

@janekmi janekmi merged commit 09cc935 into pmem:master Apr 3, 2024
9 checks passed
@grom72 grom72 deleted the 2.1.0-changelog branch May 15, 2024 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
sprint goal This pull request is part of the ongoing sprint
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants