Contains support documentation discussion on various specific topics, including issues faced when building this project, and setting up the various test environments and CI/CD related activities.
NOTE: A lot of the documentation found in this tree are conversations with AI on the issue at hand.
Basic usage can be found in setup_ramdisk_example.py
The Ramdisk interface:
The following functionality is available for every operating system. Other RamDisk methods may or may not be available for every operating sysytem.
RamDisk(size, mountpoint): create a ramdisk of a specific size and mountpoint
- size: Size of the ramdisk in megabytes
- mountpoint: location on the filesystem to mount the ramdisk
RamDisk.umount(): unmount the current ramdisk instance
RamDisk.getMountPoint(): returns the mountpoint - the location on the filesystem where the ramdisk is mounted.
RamDisk.getDevice(): returns the device the ramdisk is attached to.
RamDisk.getData(): returns the data describing the current ramdisk
RamDisk.getNprintData(): prints and returns the data describing the current ramdisk instance.
RamDisk.getNlogData(): logs and returns the data describing the current ramdisk instance.
umount(device): Function to unmount the ramdisk assigned 'device'.
- device: the operating system device the RamDisk is attached to.
eject(device): Duplicate function to unmount the ramdisk assigned to 'device'
- device: the operating system device the RamDisk is attached to.