mirror of
https://github.com/microsoft/mscclpp.git
synced 2026-05-11 17:00:22 +00:00
710f6686dc
* Moved the `MemoryChannel::copy()` method out of the `MemoryChannel` as a standalone function. * Renamed `mscclpp::putPackets()` and `mscclpp::getPackets()` to `mscclpp::copyToPackets()` and `mscclpp::copyFromPackets()` respectively for consistency. * Renamed `MemoryChannel::getPackets()` to `MemoryChannel::unpackPackets()` for clarity. Renamed `getPacketBuffer` to `packetBuffer`. * Added the `MemoryChannel::unpackPacket()` method that unpacks one packet in the buffer. * Added the `BaseMemoryChannel` class that only contains a semaphore without memory addresses. * Removed the `MemoryDevice2DeviceSemaphoreDeviceHandle::signalPacket()` method that is lacking use cases.
How to build docs
-
Install
doxygen.$ sudo apt-get install doxygen graphviz -
Install Python packages below. If you install them on the user's local, you need to include
~/.local/binto$PATH(to usesphinx-build).$ sudo python3 -m pip install -r ./requirements.txt -
Create Doxygen documents.
$ doxygen -
Create Sphinx documents.
$ make html -
Done. The HTML files will be on
_build/directory.