[LU-12837] man pages for llapi_changelog_start() and all other llapi_changelog_*() functions Created: 08/Oct/19  Updated: 19/Dec/23  Resolved: 06/Dec/22

Status: Resolved
Project: Lustre
Component/s: None
Affects Version/s: Lustre 2.13.0
Fix Version/s: Lustre 2.16.0

Type: Improvement Priority: Minor
Reporter: Andreas Dilger Assignee: Etienne Aujames
Resolution: Fixed Votes: 0
Labels: None

Issue Links:
Related
is related to LU-5657 adding missing man pages for the Lust... Resolved
is related to LU-15373 changelog improvements tracking Open
is related to LU-930 Update or improvement to a Lustre man... Open
is related to LU-12553 polling mode for changelog driver Resolved
Rank (Obsolete): 9223372036854775807

 Description   

Add proper documentation for the Changelog API:

  • llapi_changelog_start.3 man page
    • CHANGELOG_FLAG_FOLLOW flag
    • CHANGELOG_FLAG_BLOCK flag
    • CHANGELOG_FLAG_JOBID flag
    • CHANGELOG_FLAG_EXTRA_FLAGS flag
  • llapi_changelog_set_xflags.3 man page
    • CHANGELOG_EXTRA_FLAG_UIDGID flag
    • CHANGELOG_EXTRA_FLAG_NID flag
    • CHANGELOG_EXTRA_FLAG_OMODE flag
    • CHANGELOG_EXTRA_FLAG_XATTR flag
  • llapi_changelog_recv.3 man page
  • llapi_changelog_free.3 man page
  • llapi_changelog_in_buf.3 man page
  • llapi_changelog_get_fd.3 man page
  • llapi_changelog_clear.3 man page
  • llapi_changelog_fini.3 man page

As a follow-on to LU-12553 we need to add man page and test cases for the existing functions and code:

  • add test case for CHANGELOG_FLAG_FOLLOW, preferably using llsom_sync since it also doesn't have a test case?

 Comments   
Comment by Andreas Dilger [ 15/Dec/21 ]

eaujames, would you be able to work on this? You are doing a fair amount of work on changelogs/HSM currently, so it shouldn't be too hard to write these pages. You could use llapi_fid_parse.3 as an example to start with.

Comment by Etienne Aujames [ 17/Dec/21 ]

adilger, yes I can do this but with low priority.
I think I will have more time after the maintenances in February .

Comment by Gerrit Updater [ 09/Nov/22 ]

"Etienne AUJAMES <eaujames@ddn.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/49084
Subject: LU-12837 doc: add llapi_changelog* manpages
Project: fs/lustre-release
Branch: master
Current Patch Set: 1
Commit: 88e8536ed86278081db21210f87e25ec0dcb482e

Comment by Gerrit Updater [ 22/Nov/22 ]

"Etienne AUJAMES <eaujames@ddn.com>" uploaded a new patch: https://review.whamcloud.com/c/fs/lustre-release/+/49209
Subject: LU-12837 doc: add lfs-changelog* manpages
Project: fs/lustre-release
Branch: master
Current Patch Set: 1
Commit: 9a5d43324168a42fa94ed32ea306106ff8331394

Comment by Gerrit Updater [ 29/Nov/22 ]

"Oleg Drokin <green@whamcloud.com>" merged in patch https://review.whamcloud.com/c/fs/lustre-release/+/49084/
Subject: LU-12837 doc: add llapi_changelog* manpages
Project: fs/lustre-release
Branch: master
Current Patch Set:
Commit: 3fe6dac42bba8c5519ba356750752c419a2ec182

Comment by Gerrit Updater [ 06/Dec/22 ]

"Oleg Drokin <green@whamcloud.com>" merged in patch https://review.whamcloud.com/c/fs/lustre-release/+/49209/
Subject: LU-12837 doc: add lfs-changelog* manpages
Project: fs/lustre-release
Branch: master
Current Patch Set:
Commit: 82e7ad348c77e5c164aa3e3155c9eb91872369d5

Comment by Peter Jones [ 06/Dec/22 ]

Landed for 2.16

Generated at Sat Feb 10 02:56:05 UTC 2024 using Jira 9.4.14#940014-sha1:734e6822bbf0d45eff9af51f82432957f73aa32c.