IUT/linuxinstall
4
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added documentation for container and backing

Browse Source
This commit is contained in:
Alexeï Kadir
2024-02-19 20:03:30 +01:00
parent a9be69eed7
commit 7513bb37cc
6 changed files with 128 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/disk.h
View File

@@ -14,7 +14,7 @@ typedef struct {
/// @brief Creates a root disk (empty disk) at the given path with the given size.
/// @param path The path to create the disk at. Any existing file at this path will be overwritten.
/// @param size The size of the disk to create.
/// @param size The size of the disk to create, in bytes.
/// @return The result of the operation.
result_t create_root_disk(const char* path, uint64_t size);
@@ -29,7 +29,7 @@ result_t create_backed_disk(const char* path, const char* backing_path);
/// @return The result of the operation.
result_t trim_disk(const char* path);
/// @brief Resets the given disk to its original state.
/// @brief Resets the given disk to its initial state.
/// @param path The path to the disk to reset.
/// @return The result of the operation.
result_t reset_disk(const char* path);
@@ -41,7 +41,7 @@ result_t reset_disk(const char* path);
result_t reback_disk(const char* path, const char* backing_path);
/// @brief Gets the disk information of the disk at the given path.
/// @param _info The disk information pointer to store the result in. The caller is responsible for freeing the disk information.
/// @param _info The disk information pointer to store the resulting disk information in. The caller is responsible for freeing the disk information.
/// @param path The path to the disk to get the information of.
/// @return The result of the operation.
result_t get_disk_info(disk_info_t* _info, const char* path);