Skip to content

Commit

Permalink
docs and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
DanEngelbrecht committed Feb 4, 2024
1 parent 76c75c2 commit efb9a51
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
- **NEW API** `Longtail_MemTracer_ReAlloc`
- **NEW API** `Longtail_CompareAndSwap` compare and swap with platform implementations
- **NEW API** `Longtail_RunJobsBatched` runs jobs in batched mode to handle a job count larger than Longtail_JobAPI::GetMaxBatchCount()
- **NEW API** `Longtail_GetFilesRecursively2` that executes using parallel jobs improving execution speed for large file trees significantly
- **REMOVED API** `Longtail_SetAllocAndFree` is replaced by `Longtail_SetReAllocAndFree`
- **REMOVED API** `Longtail_MemTracer_Alloc` is replaced by `Longtail_MemTracer_ReAlloc`
- **CHANGED API** `Longtail_ConcurrentChunkWriteAPI::Write` has new parameter `out_chunks_remaining` which is set to the remaining number of chunks to write to asset after call completes
Expand Down
8 changes: 4 additions & 4 deletions src/longtail.h
Original file line number Diff line number Diff line change
Expand Up @@ -1000,7 +1000,7 @@ LONGTAIL_EXPORT int Longtail_RunJobsBatched(
void** job_ctxs,
uint32_t * out_jobs_submitted);

/*! @brief Get all files and directories in a path recursivley.
/*! @brief Get all files and directories in a path recursively.
*
* Gets all the files and directories and allocates a struct Longtail_FileInfos structure with the details.
* Free the struct Longtail_FileInfos using Longtail_Free()
Expand All @@ -1021,12 +1021,13 @@ LONGTAIL_EXPORT int Longtail_GetFilesRecursively(
const char* root_path,
struct Longtail_FileInfos** out_file_infos);

/*! @brief Get all files and directories in a path recursivley.
/*! @brief Get all files and directories in a path recursively.
*
* Gets all the files and directories and allocates a struct Longtail_FileInfos structure with the details.
* Free the struct Longtail_FileInfos using Longtail_Free()
*
* @param[in] storage_api An implementation of struct Longtail_StorageAPI interface.
* @param[in] optional_job_api An implementation of struct Longtail_JobAPI interface or null if multithreading should not be used
* @param[in] path_filter_api An implementation of struct Longtail_PathFilter interface or null if no filtering is required
* @param[in] optional_cancel_api An implementation of struct Longtail_CancelAPI interface or null if no cancelling is required
* @param[in] optional_cancel_token A cancel token or null if @p optional_cancel_api is null
Expand All @@ -1043,8 +1044,7 @@ LONGTAIL_EXPORT int Longtail_GetFilesRecursively2(
const char* root_path,
struct Longtail_FileInfos** out_file_infos);


/*! @brief Get the size of a constructedV VersionIndex.
/*! @brief Get the size of a constructed VersionIndex.
*
* @param[in] asset_count The number of assets (files and directories) in the index
* @param[in] chunk_count The number of chunks in the version index
Expand Down

0 comments on commit efb9a51

Please sign in to comment.