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

doc: add pmem_log_* documentations #6061

Merged
merged 1 commit into from
Apr 2, 2024
Merged

doc: add pmem_log_* documentations #6061

merged 1 commit into from
Apr 2, 2024

Conversation

osalyk
Copy link
Contributor

@osalyk osalyk commented Mar 20, 2024

This change is Reviewable

@osalyk osalyk added sprint goal This pull request is part of the ongoing sprint no changelog Add to skip the changelog check on your pull request labels Mar 20, 2024
@osalyk osalyk requested review from grom72 and janekmi March 20, 2024 12:34
Copy link

codecov bot commented Mar 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 70.12%. Comparing base (6302d16) to head (ee83f8a).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #6061      +/-   ##
==========================================
- Coverage   70.14%   70.12%   -0.02%     
==========================================
  Files         133      133              
  Lines       19568    19568              
  Branches     3261     3261              
==========================================
- Hits        13726    13723       -3     
- Misses       5842     5845       +3     

Copy link
Contributor

@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.

:lgtm:

Reviewed 5 of 5 files at r1, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @janekmi)

Copy link
Contributor

@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: all files reviewed, 1 unresolved discussion (waiting on @janekmi and @osalyk)


doc/libpmem/pmem_log_set_function.3.md line 37 at r1 (raw file):

		enum pmem_log_level level,
		const char *file_name,
		const int line_no,

According to the latest status ...

Suggestion:

unsigned line_no

Copy link
Contributor Author

@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.

Reviewable status: 4 of 5 files reviewed, 1 unresolved discussion (waiting on @grom72 and @janekmi)


doc/libpmem/pmem_log_set_function.3.md line 37 at r1 (raw file):

Previously, grom72 (Tomasz Gromadzki) wrote…

According to the latest status ...

Done.

Copy link
Contributor

@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 r2, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @janekmi)

@grom72 grom72 added this to the 2.1.1 milestone Mar 27, 2024
@janekmi janekmi modified the milestones: 2.1.1, 2.1.0 Mar 27, 2024
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 4 of 5 files at r1, 1 of 1 files at r2, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @osalyk)


doc/libpmem/pmem_log_set_threshold.3.md line 78 at r2 (raw file):

 - **PMEM_LOG_LEVEL_FATAL** - an error that causes the program to stop working
   immediately. Sorry.
 - **PMEM_LOG_LEVEL_ERROR** - an error that causes the current operation or transaction to fail

Suggestion:

an error that causes the current operation to fail

Copy link
Contributor Author

@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.

Reviewable status: 4 of 5 files reviewed, 1 unresolved discussion (waiting on @grom72 and @janekmi)


doc/libpmem/pmem_log_set_threshold.3.md line 78 at r2 (raw file):

 - **PMEM_LOG_LEVEL_FATAL** - an error that causes the program to stop working
   immediately. Sorry.
 - **PMEM_LOG_LEVEL_ERROR** - an error that causes the current operation or transaction to fail

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.

:lgtm:

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

@janekmi janekmi merged commit 8d177f1 into pmem:master Apr 2, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog Add to skip the changelog check on your pull request 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