Uploaded image for project: 'Zephyr'
  1. Zephyr
  2. ZEP-921

Miscellaneous documentation work

    Details

      Description

      This is a potpourri of minor documentation-related work items.

      Kernel Primer

      • List of major kernel changes needs to be updated (i.e. some significant things aren't mentioned).
      • Ensure kernel object sections are revised to reflect latest API changes. (Ensure msgq section uses the same terminology as the code ... i.e. "messages" instead of "data items".)
      • Section on workqueues is missing.
      • k_thread_cancel() capability is missing.
      • Essential thread concept is missing (from thread lifecycle section).
      • fifo APIs for adding lists of data items is missing.
      • Example of using an array of atomic variables is missing.
      • The "key properties" list for most kernel objects should be updated to mention the queue (or queues) of waiting threads that the object has. (For example, a fifo has a queue of waiting threads, but it isn't mentioned anywhere.)
      • Glossary of Terms needs to be fleshed out.

      AFTER CUTOVER TO UNIFIED KERNEL

      Kernel Primer

      • Make V2 document the only document. (i.e. Delete the V1 document)

      Build System User Guide

      • Remove references to nanokernel/microkernel and MDEF.

      Application Development Primer

      • Remove references to nanokernel/microkernel and MDEF.

      Review all other Zephyr documents for similar changes to those listed above.

        Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

            • Assignee:
              astephen Allan Stephens
              Reporter:
              ajnebnim Benjamin Walsh
            • Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: