Skip to content

Commit

Permalink
Updated README.md for 1.0 release
Browse files Browse the repository at this point in the history
Fixed indentation in bikeshed.h
  • Loading branch information
DanEngelbrecht committed May 29, 2019
1 parent ad0c6ff commit ed47ca2
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ See design blogs at: https://danengelbrecht.github.io

## Version history

### Version v1.0 29/5 2019

**Release 1.0**

### Fixes
- Use explicit int32_t for instead of long to ensure 32-bit values on GCC/Clang x64-builds
- Corrected URL to blog in README.md
- Added sample code for performance tests (in examples folder)

### Version v0.4 18/5 2019

**Pre-release 4**
Expand Down Expand Up @@ -94,9 +103,10 @@ Minimal dependecies with default overridable method for atomic operations.
- The default (optional) MSVC implementation depends on `<Windows.h>`.

### Optional default methods
The default implementations for the atomic functions can be overridden with your own implementation by overriding the macros:
The default implementations for the atomic and CPU yield functions can be overridden with your own implementation by overriding the macros:
- `BIKESHED_ATOMICADD` Atomically adds a 32-bit signed integer to another 32-bit signed integer and returns the result
- `BIKESHED_ATOMICCAS` Atomically exchange a 32-bit signed integer with another 32-bit signed integer if the value to be swapped matches the provided compare value, returns the old value.
- `BIKESHED_CPU_YIELD` Yield CPU (mm_pause() / YieldProcessor()).

## Test code dependecies

Expand Down
2 changes: 1 addition & 1 deletion src/bikeshed.h
Original file line number Diff line number Diff line change
Expand Up @@ -521,7 +521,7 @@ static void Bikeshed_ResolveTask_private(Bikeshed shed, Bikeshed_DependencyIndex
struct Bikeshed_Dependency_private* dependency = &shed->m_Dependencies[dependency_index - 1];
Bikeshed_TaskIndex_private parent_task_index = dependency->m_ParentTaskIndex;
struct Bikeshed_Task_private* parent_task = &shed->m_Tasks[parent_task_index - 1];
int32_t child_dependency_count = BIKESHED_ATOMICADD_PRIVATE(&parent_task->m_ChildDependencyCount, -1);
int32_t child_dependency_count = BIKESHED_ATOMICADD_PRIVATE(&parent_task->m_ChildDependencyCount, -1);
if (child_dependency_count == 0)
{
BIKESHED_FATAL_ASSERT_PRIVATE(0x20000000 == BIKESHED_ATOMICADD_PRIVATE(&shed->m_Tasks[parent_task_index - 1].m_ChildDependencyCount, 0x20000000), return)
Expand Down

0 comments on commit ed47ca2

Please sign in to comment.