Add IPC Shared Mem recipe to the ReadTheDocs

LLNL / Umpire

An application-focused API for memory management on NUMA & GPU architectures

MIT License

312 stars 51 forks source link

Add IPC Shared Mem recipe to the ReadTheDocs #868

Open kab163 opened 7 months ago

kab163 commented 7 months ago

Currently the IPC Shared Memory cookbook page can only be found in the repo as a .cpp file, but it should also be added to the ReadTheDocs as a .rst file

kab163 commented 1 week ago

Other notes about IPC shared memory for documentation:

A note about file descriptors used for shared memory. Rao had an issue with this - see email.
A note about how the name in rm.makeResource must contain a "SHARED_" prefix for shared allocators
To find how much memory is available for a shared memory allocator, just call getActualSize() on the allocator (see question in Umpire general teams chat)