Skip to content

man page updates for ocpidev asset documentation system

Lisa Zahn requested to merge 2959-manpage-updates into develop

What this MR does / why we need it:

This MR provides man pages that have been updated to describe how to use the ocpidev asset documentation system. Affected man pages include the "create", "delete", "build", and "clean" man pages and the man pages for the "buildable" OpenCPI assets. The ocpidev and "ocpidev-test" man pages have also been updated. These man pages have also been updated to address issue #3030 (closed) (man pages for this issue are also included in this MR) and to address issues #3309 (closed), #3029 (closed), #3011 (closed), #3335 (closed).

Steps to complete before submitting MR:

  • I have read Contribution guidelines

  • I have ensured I have a changelog written in the imperative form that is meaningful and accurately summarizes the work done

  • I have added the release notes label if applicable (more information below)

  • I have ensured the workflow labels are up to date and will continue to do so up until this work is merged into develop

  • I have added a category, type, and target release label along with all other labels as need be

  • My branch is up to date with develop. If it is not, then I have ensured my work does not conflict with other work

  • I agree my bugfix MR does not include new features/enhancements

  • I represent that bugfixes have been locally tested against the most recent major.minor release in which the bug exists

  • (REVIEWER ONLY) I have thoroughly gone through the above steps to ensure that they have been followed

Changelog

  • enh(doc): add ocpidev asset doc system usage information to relevant man pages
  • enh(doc): fix ordering of options in man pages to be short form first

Which issue(s) this MR closes

Closes #2959 (closed), #3309 (closed), #3029 (closed), #3335 (closed), #3011 (closed), #3030 (closed)

Edited by Robert Tracy

Merge request reports