[LU-12837] man pages for llapi_changelog_start() and all other llapi_changelog_*() functions

• Type: Improvement
• Resolution: Fixed
• Priority: Minor
• Fix Version/s: Lustre 2.16.0
• Affects Version/s: Lustre 2.13.0
• Assignee: Etienne Aujames
• Reporter: Andreas Dilger

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?

Issue Links

• is related to: LU-5657 adding missing man pages for the Lustre user API
• is related to: LU-15373 changelog improvements tracking
• is related to: LU-930 Update or improvement to a Lustre man page, documentation, or messages
• is related to: LU-12553 polling mode for changelog driver