Merge branch 'develop'

Author: MaJerle

.github/FUNDING.yml

@@ -0,0 +1,3 @@
+# These are supported funding model platforms
+
+custom: ['paypal.me/tilz0R']

.github/workflows/release.yml

@@ -0,0 +1,27 @@
+on:
+  push:
+    # Sequence of patterns matched against refs/tags
+    tags:
+      - 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
+
+name: Create Release
+
+jobs:
+  build:
+    name: Create Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          body: |
+            See the CHANGELOG.md
+          draft: false
+          prerelease: false

.gitignore

@@ -22,28 +22,27 @@
 *.uvoptx
 *.__i
 *.i
-*.txt
 !docs/*.txt
 RTE/
 
-# IAR Settings  
-**/settings/*.crun  
-**/settings/*.dbgdt  
-**/settings/*.cspy  
-**/settings/*.cspy.*  
-**/settings/*.xcl  
-**/settings/*.dni  
-**/settings/*.wsdt  
-**/settings/*.wspos  
-
-# IAR Debug Exe  
-**/Exe/*.sim  
-
-# IAR Debug Obj  
-**/Obj/*.pbd  
-**/Obj/*.pbd.*  
-**/Obj/*.pbi  
-**/Obj/*.pbi.*  
+# IAR Settings
+**/settings/*.crun
+**/settings/*.dbgdt
+**/settings/*.cspy
+**/settings/*.cspy.*
+**/settings/*.xcl
+**/settings/*.dni
+**/settings/*.wsdt
+**/settings/*.wspos
+
+# IAR Debug Exe
+**/Exe/*.sim
+
+# IAR Debug Obj
+**/Obj/*.pbd
+**/Obj/*.pbd.*
+**/Obj/*.pbi
+**/Obj/*.pbi.*
 
 *.TMP
 /docs_src/x_Doxyfile.doxy
@@ -274,7 +273,7 @@ ClientBin/
 *.publishsettings
 orleans.codegen.cs
 
-# Including strong name files can present a security risk 
+# Including strong name files can present a security risk
 # (https://github.com/github/gitignore/pull/2483#issue-259490424)
 #*.snk
 
@@ -370,7 +369,7 @@ __pycache__/
 # OpenCover UI analysis results
 OpenCover/
 
-# Azure Stream Analytics local run output 
+# Azure Stream Analytics local run output
 ASALocalRun/
 
 # MSBuild Binary and Structured Log

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "third_party/Unity"]
+	path = third_party/Unity
+	url = https://github.com/ThrowTheSwitch/Unity.git
+[submodule "third_party/sanitizers-cmake"]
+	path = third_party/sanitizers-cmake
+	url = https://github.com/arsenm/sanitizers-cmake.git
+[submodule "third_party/cmake-modules"]
+	path = third_party/cmake-modules
+	url = https://github.com/bilke/cmake-modules.git

CHANGELOG.md

@@ -0,0 +1,45 @@
+# Changelog
+
+## Develop
+
+## v2.0.2
+
+- Add `volatile` keyword to all local variables to ensure thread safety in highest optimization
+- Add local variables for all read and write pointer accesses
+- Remove generic `volatile` keyword from func parameter and replace to struct member
+
+## v2.0.1
+
+- Fix wrong check for valid RB instance
+- Apply code style settings with Artistic style options
+- Add thread safety docs
+
+## v2.0.0
+
+- Break compatibility with previous versions
+- Rename function prefixes to `lwrb` instead of `ringbuff`
+- Add astyle code syntax correction
+
+## v1.3.1
+
+- Fixed missing `RINGBUFF_VOLATILE` for event callback causes compiler warnings or errors
+
+## v1.3.0
+
+- Added support for events on read/write or reset operation
+- Added optional volatile parameter for buffer structure
+- Fix bug in skip and advance operation to return actual amount of bytes processed
+- Remove `BUF_PREF` parameter and rename with fixed `ringbuff_` prefix for all functions
+
+## v1.2.0
+
+- Added first sphinx documentation
+
+## v1.1.0
+
+- Code optimizations, use pre-increment instead of post
+- Another code-style fixes
+
+## v1.0.0
+
+- First stable release

dev/VisualStudio/lwrb_dev.vcxproj

@@ -139,9 +139,6 @@
       <OptimizeReferences>true</OptimizeReferences>
     </Link>
   </ItemDefinitionGroup>
-  <ItemGroup>
-    <Text Include="ReadMe.txt" />
-  </ItemGroup>
   <ItemGroup>
     <ClCompile Include="..\..\lwrb\src\lwrb\lwrb.c" />
     <ClCompile Include="main.c" />

dev/VisualStudio/lwrb_dev.vcxproj.filters

@@ -14,9 +14,6 @@
       <Extensions>rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms</Extensions>
     </Filter>
   </ItemGroup>
-  <ItemGroup>
-    <Text Include="ReadMe.txt" />
-  </ItemGroup>
   <ItemGroup>
     <ClCompile Include="main.c">
       <Filter>Source Files</Filter>

docs/conf.py

@@ -26,27 +26,32 @@
 copyright = '2020, Tilen MAJERLE'
 author = 'Tilen MAJERLE'
 
-# The full version, including alpha/beta/rc tags
-version = '2.0.1'
-
 # Try to get branch at which this is running
 # and try to determine which version to display in sphinx
+# Version is using git tag if on master or "latest-develop" if on develop branch
+version = ''
 git_branch = ''
+
+# Get current branch
 res = os.popen('git branch').read().strip()
 for line in res.split("\n"):
     if line[0] == '*':
         git_branch = line[1:].strip()
 
 # Decision for display version
-try:
-    if git_branch.index('develop') >= 0:
-        version = "latest-develop"
-except Exception:
-    print("Exception for index check")
-
-# For debugging purpose
+git_branch = git_branch.replace('(HEAD detached at ', '').replace(')', '')
+if git_branch.find('master') >= 0 or git_branch.find('main') >= 0:
+    version = os.popen('git describe --tags --abbrev=0').read().strip()
+    if version == '':
+        version = 'v0.0.0'
+elif git_branch.find('develop') != -1 and not (git_branch.find('develop-') >= 0 or git_branch.find('develop/') >= 0):
+    version = 'latest-develop'
+else:
+    version = 'branch-' + git_branch
+
+# For debugging purpose only
 print("GIT BRANCH: " + git_branch)
-print("VERSION: " + version)
+print("GIT VERSION: " + version)
 
 # -- General configuration ---------------------------------------------------
 
@@ -112,7 +117,7 @@
     'css/custom.css',
 ]
 html_js_files = [
-    'https://kit.fontawesome.com/3102794088.js'
+    'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css'
 ]
 
 master_doc = 'index'

docs/examples_src/example_advance_1.c

@@ -43,10 +43,10 @@ if ((len = lwrb_get_linear_block_write_length(&buff)) > 0) {
 /* Get length of linear memory at write pointer */
 /* Function returns 3 as we can write 3 bytes to buffer in sequence */
 /* When function returns 0, there is no memory available in the buffer for write anymore */
-if ((len = lwrb_get_linear_block_read_length(&buff)) > 0) {
+if ((len = lwrb_get_linear_block_write_length(&buff)) > 0) {
     /* Get pointer to first element in linear block at write address */
     /* Function returns &buff_data[0] */
-    data = lwrb_get_linear_block_read_address(&buff);
+    data = lwrb_get_linear_block_write_address(&buff);
 
     /* Receive data via DMA and wait to finish (for sake of example) */
     /* Any other hardware may directly write to data array */

docs/get-started/index.rst

@@ -3,15 +3,21 @@
 Getting started
 ===============
 
+Getting started may be the most challenging part of every new library.
+This guide is describing how to start with the library quickly and effectively
+
 .. _download_library:
 
 Download library
 ^^^^^^^^^^^^^^^^
 
 Library is primarly hosted on `Github <https://github.com/MaJerle/lwrb>`_.
 
-* Download latest release from `releases area <https://github.com/MaJerle/lwrb/releases>`_ on Github
-* Clone `develop` branch for latest development
+You can get it with:
+
+* Downloading latest release from `releases area <https://github.com/MaJerle/lwrb/releases>`_ on Github
+* Cloning ``master`` branch for latest stable version
+* Cloning ``develop`` branch for latest development
 
 Download from releases
 **********************
@@ -24,7 +30,9 @@ Clone from Github
 First-time clone
 """"""""""""""""
 
-* Download and install ``git`` if not already
+This is used when you do not have yet local copy on your machine.
+
+* Make sure ``git`` is installed.
 * Open console and navigate to path in the system to clone repository to. Use command ``cd your_path``
 * Clone repository with one of available ``3`` options
 
@@ -38,7 +46,8 @@ Update cloned to latest version
 """""""""""""""""""""""""""""""
 
 * Open console and navigate to path in the system where your resources repository is. Use command ``cd your_path``
-* Run ``git pull origin master --recurse-submodules`` command to pull latest changes and to fetch latest changes from submodules
+* Run ``git pull origin master --recurse-submodules`` command to pull latest changes and to fetch latest changes from submodules on ``master`` branch
+* Run ``git pull origin develop --recurse-submodules`` command to pull latest changes and to fetch latest changes from submodules on ``develop`` branch
 * Run ``git submodule foreach git pull origin master`` to update & merge all submodules
 
 .. note::
@@ -49,18 +58,21 @@ Add library to project
 ^^^^^^^^^^^^^^^^^^^^^^
 
 At this point it is assumed that you have successfully download library, either cloned it or from releases page.
+Next step is to add the library to the project, by means of source files to compiler inputs and header files in search path
 
-* Copy ``lwrb`` folder to your project
-* Add ``lwrb/src/include`` folder to `include path` of your toolchain
-* Add source files from ``lwrb/src/`` folder to toolchain build
+* Copy ``lwrb`` folder to your project, it contains library files
+* Add ``lwrb/src/include`` folder to `include path` of your toolchain. This is where `C/C++` compiler can find the files during compilation process. Usually using ``-I`` flag
+* Add source files from ``lwrb/src/`` folder to toolchain build. These files are built by `C/C++` compilery
 * Build the project
 
+
 Minimal example code
 ^^^^^^^^^^^^^^^^^^^^
 
-Run below example to test and verify library
+To verify proper library setup, minimal example has been prepared.
+Run it in your main application file to verify its proper execution
 
 .. literalinclude:: ../examples_src/example_minimal.c
     :language: c
     :linenos:
-    :caption: Minimal example code
+    :caption: Absolute minimum example