summaryrefslogtreecommitdiffstats
path: root/src/fluent-bit/lib/lwrb/docs
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 12:08:03 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-05-05 12:08:18 +0000
commit5da14042f70711ea5cf66e034699730335462f66 (patch)
tree0f6354ccac934ed87a2d555f45be4c831cf92f4a /src/fluent-bit/lib/lwrb/docs
parentReleasing debian version 1.44.3-2. (diff)
downloadnetdata-5da14042f70711ea5cf66e034699730335462f66.tar.xz
netdata-5da14042f70711ea5cf66e034699730335462f66.zip
Merging upstream version 1.45.3+dfsg.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/fluent-bit/lib/lwrb/docs')
-rw-r--r--src/fluent-bit/lib/lwrb/docs/Makefile20
-rw-r--r--src/fluent-bit/lib/lwrb/docs/api-reference/index.rst11
-rw-r--r--src/fluent-bit/lib/lwrb/docs/api-reference/lwrb.rst6
-rw-r--r--src/fluent-bit/lib/lwrb/docs/conf.py144
-rw-r--r--src/fluent-bit/lib/lwrb/docs/doxyfile.doxy2456
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_advance_1.c67
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_advance_2.c19
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_dma_skip.c61
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_events.c26
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_index.c20
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_minimal.c19
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_skip_1.c62
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_skip_2.c21
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_thread_safety.c47
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_tt_buff_size.c43
-rw-r--r--src/fluent-bit/lib/lwrb/docs/examples_src/example_tt_buff_size_log.c3
-rw-r--r--src/fluent-bit/lib/lwrb/docs/get-started/index.rst77
-rw-r--r--src/fluent-bit/lib/lwrb/docs/index.rst96
-rw-r--r--src/fluent-bit/lib/lwrb/docs/make.bat35
-rw-r--r--src/fluent-bit/lib/lwrb/docs/requirements.txt8
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/css/common.css64
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/css/custom.css0
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/dark-light/checked.svg1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/dark-light/common-dark-light.css143
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/dark-light/dark-mode-toggle.mjs329
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/dark-light/dark.css36
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/dark-light/light.css24
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/dark-light/moon.pngbin0 -> 3511 bytes
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/dark-light/moon.svg7
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/dark-light/sun.pngbin0 -> 1897 bytes
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/dark-light/sun.svg5
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/dark-light/unchecked.svg1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_cases.svg2
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_cases.xml1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_read_skip.svg2
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_read_skip.xml1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_write_advance.svg2
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_write_advance.xml1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_main_irq_write.svg3
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_main_irq_write.xml1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read.svg3
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read.xml1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read_write.svg3
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read_write.xml1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_write.svg3
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_write.xml1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_single_read_write.svg3
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_single_read_write.xml1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/logo.drawio1
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/logo.svg3
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/logo_tm.pngbin0 -> 3338 bytes
-rw-r--r--src/fluent-bit/lib/lwrb/docs/static/images/logo_tm_full.pngbin0 -> 17470 bytes
-rw-r--r--src/fluent-bit/lib/lwrb/docs/tips-tricks/index.rst28
-rw-r--r--src/fluent-bit/lib/lwrb/docs/user-manual/events.rst28
-rw-r--r--src/fluent-bit/lib/lwrb/docs/user-manual/how-it-works.rst61
-rw-r--r--src/fluent-bit/lib/lwrb/docs/user-manual/hw-dma-usage.rst96
-rw-r--r--src/fluent-bit/lib/lwrb/docs/user-manual/index.rst12
-rw-r--r--src/fluent-bit/lib/lwrb/docs/user-manual/thread-safety.rst84
58 files changed, 4193 insertions, 0 deletions
diff --git a/src/fluent-bit/lib/lwrb/docs/Makefile b/src/fluent-bit/lib/lwrb/docs/Makefile
new file mode 100644
index 000000000..d4bb2cbb9
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = .
+BUILDDIR = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/src/fluent-bit/lib/lwrb/docs/api-reference/index.rst b/src/fluent-bit/lib/lwrb/docs/api-reference/index.rst
new file mode 100644
index 000000000..d6683a23b
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/api-reference/index.rst
@@ -0,0 +1,11 @@
+.. _api_reference:
+
+API reference
+=============
+
+List of all the modules:
+
+.. toctree::
+ :maxdepth: 2
+
+ lwrb \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/api-reference/lwrb.rst b/src/fluent-bit/lib/lwrb/docs/api-reference/lwrb.rst
new file mode 100644
index 000000000..b48317dcb
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/api-reference/lwrb.rst
@@ -0,0 +1,6 @@
+.. _api_lwrb:
+
+LwRB
+====
+
+.. doxygengroup:: LWRB \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/conf.py b/src/fluent-bit/lib/lwrb/docs/conf.py
new file mode 100644
index 000000000..0523835f5
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/conf.py
@@ -0,0 +1,144 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+from sphinx.builders.html import StandaloneHTMLBuilder
+import subprocess, os
+
+# Run doxygen first
+# read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
+# if read_the_docs_build:
+subprocess.call('doxygen doxyfile.doxy', shell=True)
+# -- Project information -----------------------------------------------------
+
+project = 'LwRB'
+copyright = '2022, Tilen MAJERLE'
+author = 'Tilen MAJERLE'
+
+# 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/main or "latest-develop" if on develop branch
+version = ''
+git_branch = ''
+
+def cmd_exec_print(t):
+ print("cmd > ", t, "\n", os.popen(t).read().strip(), "\n")
+
+# Print demo data here
+cmd_exec_print('git branch')
+cmd_exec_print('git describe')
+cmd_exec_print('git describe --tags')
+cmd_exec_print('git describe --tags --abbrev=0')
+cmd_exec_print('git describe --tags --abbrev=1')
+
+# 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
+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()
+ version = 'latest-stable'
+elif git_branch.find('develop-') >= 0 or git_branch.find('develop/') >= 0:
+ version = 'branch-' + git_branch
+elif git_branch == 'develop' or git_branch == 'origin/develop':
+ version = 'latest-develop'
+else:
+ version = os.popen('git describe --tags --abbrev=0').read().strip()
+
+# For debugging purpose only
+print("GIT BRANCH: " + git_branch)
+print("PROJ VERSION: " + version)
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+ 'sphinx.ext.autodoc',
+ 'sphinx.ext.intersphinx',
+ 'sphinx.ext.autosectionlabel',
+ 'sphinx.ext.todo',
+ 'sphinx.ext.coverage',
+ 'sphinx.ext.mathjax',
+ 'sphinx.ext.ifconfig',
+ 'sphinx.ext.viewcode',
+ 'sphinx_sitemap',
+
+ 'breathe',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+highlight_language = 'c'
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+html_theme_options = {
+ 'canonical_url': '',
+ 'analytics_id': '', # Provided by Google in your dashboard
+ 'display_version': True,
+ 'prev_next_buttons_location': 'bottom',
+ 'style_external_links': False,
+
+ 'logo_only': False,
+
+ # Toc options
+ 'collapse_navigation': True,
+ 'sticky_navigation': True,
+ 'navigation_depth': 4,
+ 'includehidden': True,
+ 'titles_only': False
+}
+html_logo = 'static/images/logo.svg'
+github_url = 'https://github.com/MaJerle/lwrb'
+html_baseurl = 'https://docs.majerle.eu/projects/lwrb/'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['static']
+html_css_files = [
+ 'css/common.css',
+ 'css/custom.css',
+ 'https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.1/css/all.min.css',
+]
+html_js_files = [
+ ''
+]
+
+# Master index file
+master_doc = 'index'
+
+# --- Breathe configuration -----------------------------------------------------
+breathe_projects = {
+ "lwrb": "_build/xml/"
+}
+breathe_default_project = "lwrb"
+breathe_default_members = ('members', 'undoc-members')
+breathe_show_enumvalue_initializer = True \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/doxyfile.doxy b/src/fluent-bit/lib/lwrb/docs/doxyfile.doxy
new file mode 100644
index 000000000..4145e04b8
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/doxyfile.doxy
@@ -0,0 +1,2456 @@
+# Doxyfile 1.8.10
+
+# This file describes the settings to be used by the documentation system
+# doxygen (www.doxygen.org) for a project.
+#
+# All text after a double hash (##) is considered a comment and is placed in
+# front of the TAG it is preceding.
+#
+# All text after a single hash (#) is considered a comment and will be ignored.
+# The format is:
+# TAG = value [value, ...]
+# For lists, items can also be appended using:
+# TAG += value [value, ...]
+# Values that contain spaces should be placed between quotes (\" \").
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+
+# This tag specifies the encoding used for all characters in the config file
+# that follow. The default is UTF-8 which is also the encoding used for all text
+# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv
+# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv
+# for the list of possible encodings.
+# The default value is: UTF-8.
+
+DOXYFILE_ENCODING = UTF-8
+
+# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by
+# double-quotes, unless you are using Doxywizard) that should identify the
+# project for which the documentation is generated. This name is used in the
+# title of most generated pages and in a few other places.
+# The default value is: My Project.
+
+PROJECT_NAME = "LwRB"
+
+# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
+# could be handy for archiving the generated documentation or if some version
+# control system is used.
+
+PROJECT_NUMBER = ""
+
+# Using the PROJECT_BRIEF tag one can provide an optional one line description
+# for a project that appears at the top of each page and should give viewer a
+# quick idea about the purpose of the project. Keep the description short.
+
+PROJECT_BRIEF = "Lightweight ring buffer manager"
+
+# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
+# in the documentation. The maximum height of the logo should not exceed 55
+# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
+# the logo to the output directory.
+
+PROJECT_LOGO =
+
+# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path
+# into which the generated documentation will be written. If a relative path is
+# entered, it will be relative to the location where doxygen was started. If
+# left blank the current directory will be used.
+
+OUTPUT_DIRECTORY = "_build"
+
+# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
+# directories (in 2 levels) under the output directory of each output format and
+# will distribute the generated files over these directories. Enabling this
+# option can be useful when feeding doxygen a huge amount of source files, where
+# putting all generated files in the same directory would otherwise causes
+# performance problems for the file system.
+# The default value is: NO.
+
+CREATE_SUBDIRS = NO
+
+# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII
+# characters to appear in the names of generated files. If set to NO, non-ASCII
+# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode
+# U+3044.
+# The default value is: NO.
+
+ALLOW_UNICODE_NAMES = NO
+
+# The OUTPUT_LANGUAGE tag is used to specify the language in which all
+# documentation generated by doxygen is written. Doxygen will use this
+# information to generate all constant output in the proper language.
+# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese,
+# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States),
+# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian,
+# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages),
+# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian,
+# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian,
+# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish,
+# Ukrainian and Vietnamese.
+# The default value is: English.
+
+OUTPUT_LANGUAGE = English
+
+# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
+# descriptions after the members that are listed in the file and class
+# documentation (similar to Javadoc). Set to NO to disable this.
+# The default value is: YES.
+
+BRIEF_MEMBER_DESC = YES
+
+# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
+# description of a member or function before the detailed description
+#
+# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
+# brief descriptions will be completely suppressed.
+# The default value is: YES.
+
+REPEAT_BRIEF = YES
+
+# This tag implements a quasi-intelligent brief description abbreviator that is
+# used to form the text in various listings. Each string in this list, if found
+# as the leading text of the brief description, will be stripped from the text
+# and the result, after processing the whole list, is used as the annotated
+# text. Otherwise, the brief description is used as-is. If left blank, the
+# following values are used ($name is automatically replaced with the name of
+# the entity):The $name class, The $name widget, The $name file, is, provides,
+# specifies, contains, represents, a, an and the.
+
+ABBREVIATE_BRIEF = "The $name class" \
+ "The $name widget" \
+ "The $name file" \
+ is \
+ provides \
+ specifies \
+ contains \
+ represents \
+ a \
+ an \
+ the
+
+# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
+# doxygen will generate a detailed section even if there is only a brief
+# description.
+# The default value is: NO.
+
+ALWAYS_DETAILED_SEC = NO
+
+# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
+# inherited members of a class in the documentation of that class as if those
+# members were ordinary class members. Constructors, destructors and assignment
+# operators of the base classes will not be shown.
+# The default value is: NO.
+
+INLINE_INHERITED_MEMB = NO
+
+# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
+# before files name in the file list and in the header files. If set to NO the
+# shortest path that makes the file name unique will be used
+# The default value is: YES.
+
+FULL_PATH_NAMES = NO
+
+# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
+# Stripping is only done if one of the specified strings matches the left-hand
+# part of the path. The tag can be used to show relative paths in the file list.
+# If left blank the directory from which doxygen is run is used as the path to
+# strip.
+#
+# Note that you can specify absolute paths here, but also relative paths, which
+# will be relative from the directory where doxygen is started.
+# This tag requires that the tag FULL_PATH_NAMES is set to YES.
+
+STRIP_FROM_PATH =
+
+# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
+# path mentioned in the documentation of a class, which tells the reader which
+# header file to include in order to use a class. If left blank only the name of
+# the header file containing the class definition is used. Otherwise one should
+# specify the list of include paths that are normally passed to the compiler
+# using the -I flag.
+
+STRIP_FROM_INC_PATH =
+
+# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
+# less readable) file names. This can be useful is your file systems doesn't
+# support long names like on DOS, Mac, or CD-ROM.
+# The default value is: NO.
+
+SHORT_NAMES = NO
+
+# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
+# first line (until the first dot) of a Javadoc-style comment as the brief
+# description. If set to NO, the Javadoc-style will behave just like regular Qt-
+# style comments (thus requiring an explicit @brief command for a brief
+# description.)
+# The default value is: NO.
+
+JAVADOC_AUTOBRIEF = NO
+
+# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
+# line (until the first dot) of a Qt-style comment as the brief description. If
+# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
+# requiring an explicit \brief command for a brief description.)
+# The default value is: NO.
+
+QT_AUTOBRIEF = NO
+
+# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
+# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
+# a brief description. This used to be the default behavior. The new default is
+# to treat a multi-line C++ comment block as a detailed description. Set this
+# tag to YES if you prefer the old behavior instead.
+#
+# Note that setting this tag to YES also means that rational rose comments are
+# not recognized any more.
+# The default value is: NO.
+
+MULTILINE_CPP_IS_BRIEF = NO
+
+# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
+# documentation from any documented member that it re-implements.
+# The default value is: YES.
+
+INHERIT_DOCS = YES
+
+# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
+# page for each member. If set to NO, the documentation of a member will be part
+# of the file/class/namespace that contains it.
+# The default value is: NO.
+
+SEPARATE_MEMBER_PAGES = NO
+
+# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
+# uses this value to replace tabs by spaces in code fragments.
+# Minimum value: 1, maximum value: 16, default value: 4.
+
+TAB_SIZE = 4
+
+# This tag can be used to specify a number of aliases that act as commands in
+# the documentation. An alias has the form:
+# name=value
+# For example adding
+# "sideeffect=@par Side Effects:\n"
+# will allow you to put the command \sideeffect (or @sideeffect) in the
+# documentation, which will result in a user-defined paragraph with heading
+# "Side Effects:". You can put \n's in the value part of an alias to insert
+# newlines.
+
+ALIASES =
+
+# This tag can be used to specify a number of word-keyword mappings (TCL only).
+# A mapping has the form "name=value". For example adding "class=itcl::class"
+# will allow you to use the command class in the itcl::class meaning.
+
+TCL_SUBST =
+
+# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
+# only. Doxygen will then generate output that is more tailored for C. For
+# instance, some of the names that are used will be different. The list of all
+# members will be omitted, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_FOR_C = YES
+
+# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
+# Python sources only. Doxygen will then generate output that is more tailored
+# for that language. For instance, namespaces will be presented as packages,
+# qualified scopes will look different, etc.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_JAVA = NO
+
+# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
+# sources. Doxygen will then generate output that is tailored for Fortran.
+# The default value is: NO.
+
+OPTIMIZE_FOR_FORTRAN = NO
+
+# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
+# sources. Doxygen will then generate output that is tailored for VHDL.
+# The default value is: NO.
+
+OPTIMIZE_OUTPUT_VHDL = NO
+
+# Doxygen selects the parser to use depending on the extension of the files it
+# parses. With this tag you can assign which parser to use for a given
+# extension. Doxygen has a built-in mapping, but you can override or extend it
+# using this tag. The format is ext=language, where ext is a file extension, and
+# language is one of the parsers supported by doxygen: IDL, Java, Javascript,
+# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran:
+# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran:
+# Fortran. In the later case the parser tries to guess whether the code is fixed
+# or free formatted code, this is the default for Fortran type files), VHDL. For
+# instance to make doxygen treat .inc files as Fortran files (default is PHP),
+# and .f files as C (default is Fortran), use: inc=Fortran f=C.
+#
+# Note: For files without extension you can use no_extension as a placeholder.
+#
+# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
+# the files are not read by doxygen.
+
+EXTENSION_MAPPING =
+
+# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
+# according to the Markdown format, which allows for more readable
+# documentation. See http://daringfireball.net/projects/markdown/ for details.
+# The output of markdown processing is further processed by doxygen, so you can
+# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
+# case of backward compatibilities issues.
+# The default value is: YES.
+
+MARKDOWN_SUPPORT = YES
+
+# When enabled doxygen tries to link words that correspond to documented
+# classes, or namespaces to their corresponding documentation. Such a link can
+# be prevented in individual cases by putting a % sign in front of the word or
+# globally by setting AUTOLINK_SUPPORT to NO.
+# The default value is: YES.
+
+AUTOLINK_SUPPORT = YES
+
+# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
+# to include (a tag file for) the STL sources as input, then you should set this
+# tag to YES in order to let doxygen match functions declarations and
+# definitions whose arguments contain STL classes (e.g. func(std::string);
+# versus func(std::string) {}). This also make the inheritance and collaboration
+# diagrams that involve STL classes more complete and accurate.
+# The default value is: NO.
+
+BUILTIN_STL_SUPPORT = NO
+
+# If you use Microsoft's C++/CLI language, you should set this option to YES to
+# enable parsing support.
+# The default value is: NO.
+
+CPP_CLI_SUPPORT = NO
+
+# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
+# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen
+# will parse them like normal C++ but will assume all classes use public instead
+# of private inheritance when no explicit protection keyword is present.
+# The default value is: NO.
+
+SIP_SUPPORT = NO
+
+# For Microsoft's IDL there are propget and propput attributes to indicate
+# getter and setter methods for a property. Setting this option to YES will make
+# doxygen to replace the get and set methods by a property in the documentation.
+# This will only work if the methods are indeed getting or setting a simple
+# type. If this is not the case, or you want to show the methods anyway, you
+# should set this option to NO.
+# The default value is: YES.
+
+IDL_PROPERTY_SUPPORT = YES
+
+# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
+# tag is set to YES then doxygen will reuse the documentation of the first
+# member in the group (if any) for the other members of the group. By default
+# all members of a group must be documented explicitly.
+# The default value is: NO.
+
+DISTRIBUTE_GROUP_DOC = NO
+
+# If one adds a struct or class to a group and this option is enabled, then also
+# any nested class or struct is added to the same group. By default this option
+# is disabled and one has to add nested compounds explicitly via \ingroup.
+# The default value is: NO.
+
+GROUP_NESTED_COMPOUNDS = NO
+
+# Set the SUBGROUPING tag to YES to allow class member groups of the same type
+# (for instance a group of public functions) to be put as a subgroup of that
+# type (e.g. under the Public Functions section). Set it to NO to prevent
+# subgrouping. Alternatively, this can be done per class using the
+# \nosubgrouping command.
+# The default value is: YES.
+
+SUBGROUPING = YES
+
+# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
+# are shown inside the group in which they are included (e.g. using \ingroup)
+# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
+# and RTF).
+#
+# Note that this feature does not work in combination with
+# SEPARATE_MEMBER_PAGES.
+# The default value is: NO.
+
+INLINE_GROUPED_CLASSES = NO
+
+# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
+# with only public data fields or simple typedef fields will be shown inline in
+# the documentation of the scope in which they are defined (i.e. file,
+# namespace, or group documentation), provided this scope is documented. If set
+# to NO, structs, classes, and unions are shown on a separate page (for HTML and
+# Man pages) or section (for LaTeX and RTF).
+# The default value is: NO.
+
+INLINE_SIMPLE_STRUCTS = NO
+
+# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
+# enum is documented as struct, union, or enum with the name of the typedef. So
+# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
+# with name TypeT. When disabled the typedef will appear as a member of a file,
+# namespace, or class. And the struct will be named TypeS. This can typically be
+# useful for C code in case the coding convention dictates that all compound
+# types are typedef'ed and only the typedef is referenced, never the tag name.
+# The default value is: NO.
+
+TYPEDEF_HIDES_STRUCT = YES
+
+# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
+# cache is used to resolve symbols given their name and scope. Since this can be
+# an expensive process and often the same symbol appears multiple times in the
+# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
+# doxygen will become slower. If the cache is too large, memory is wasted. The
+# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
+# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
+# symbols. At the end of a run doxygen will report the cache usage and suggest
+# the optimal cache size from a speed point of view.
+# Minimum value: 0, maximum value: 9, default value: 0.
+
+LOOKUP_CACHE_SIZE = 0
+
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+
+# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in
+# documentation are documented, even if no documentation was available. Private
+# class members and static file members will be hidden unless the
+# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES.
+# Note: This will also disable the warnings about undocumented members that are
+# normally produced when WARNINGS is set to YES.
+# The default value is: NO.
+
+EXTRACT_ALL = NO
+
+# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
+# be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PRIVATE = NO
+
+# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
+# scope will be included in the documentation.
+# The default value is: NO.
+
+EXTRACT_PACKAGE = NO
+
+# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
+# included in the documentation.
+# The default value is: NO.
+
+EXTRACT_STATIC = YES
+
+# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
+# locally in source files will be included in the documentation. If set to NO,
+# only classes defined in header files are included. Does not have any effect
+# for Java sources.
+# The default value is: YES.
+
+EXTRACT_LOCAL_CLASSES = YES
+
+# This flag is only useful for Objective-C code. If set to YES, local methods,
+# which are defined in the implementation section but not in the interface are
+# included in the documentation. If set to NO, only methods in the interface are
+# included.
+# The default value is: NO.
+
+EXTRACT_LOCAL_METHODS = NO
+
+# If this flag is set to YES, the members of anonymous namespaces will be
+# extracted and appear in the documentation as a namespace called
+# 'anonymous_namespace{file}', where file will be replaced with the base name of
+# the file that contains the anonymous namespace. By default anonymous namespace
+# are hidden.
+# The default value is: NO.
+
+EXTRACT_ANON_NSPACES = NO
+
+# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
+# undocumented members inside documented classes or files. If set to NO these
+# members will be included in the various overviews, but no documentation
+# section is generated. This option has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_MEMBERS = NO
+
+# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
+# undocumented classes that are normally visible in the class hierarchy. If set
+# to NO, these classes will be included in the various overviews. This option
+# has no effect if EXTRACT_ALL is enabled.
+# The default value is: NO.
+
+HIDE_UNDOC_CLASSES = NO
+
+# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
+# (class|struct|union) declarations. If set to NO, these declarations will be
+# included in the documentation.
+# The default value is: NO.
+
+HIDE_FRIEND_COMPOUNDS = NO
+
+# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
+# documentation blocks found inside the body of a function. If set to NO, these
+# blocks will be appended to the function's detailed documentation block.
+# The default value is: NO.
+
+HIDE_IN_BODY_DOCS = NO
+
+# The INTERNAL_DOCS tag determines if documentation that is typed after a
+# \internal command is included. If the tag is set to NO then the documentation
+# will be excluded. Set it to YES to include the internal documentation.
+# The default value is: NO.
+
+INTERNAL_DOCS = NO
+
+# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file
+# names in lower-case letters. If set to YES, upper-case letters are also
+# allowed. This is useful if you have classes or files whose names only differ
+# in case and if your file system supports case sensitive file names. Windows
+# and Mac users are advised to set this option to NO.
+# The default value is: system dependent.
+
+CASE_SENSE_NAMES = NO
+
+# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with
+# their full class and namespace scopes in the documentation. If set to YES, the
+# scope will be hidden.
+# The default value is: NO.
+
+HIDE_SCOPE_NAMES = YES
+
+# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will
+# append additional text to a page's title, such as Class Reference. If set to
+# YES the compound reference will be hidden.
+# The default value is: NO.
+
+HIDE_COMPOUND_REFERENCE= NO
+
+# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
+# the files that are included by a file in the documentation of that file.
+# The default value is: YES.
+
+SHOW_INCLUDE_FILES = YES
+
+# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
+# grouped member an include statement to the documentation, telling the reader
+# which file to include in order to use the member.
+# The default value is: NO.
+
+SHOW_GROUPED_MEMB_INC = NO
+
+# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
+# files with double quotes in the documentation rather than with sharp brackets.
+# The default value is: NO.
+
+FORCE_LOCAL_INCLUDES = NO
+
+# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
+# documentation for inline members.
+# The default value is: YES.
+
+INLINE_INFO = YES
+
+# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
+# (detailed) documentation of file and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order.
+# The default value is: YES.
+
+SORT_MEMBER_DOCS = YES
+
+# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
+# descriptions of file, namespace and class members alphabetically by member
+# name. If set to NO, the members will appear in declaration order. Note that
+# this will also influence the order of the classes in the class list.
+# The default value is: NO.
+
+SORT_BRIEF_DOCS = NO
+
+# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
+# (brief and detailed) documentation of class members so that constructors and
+# destructors are listed first. If set to NO the constructors will appear in the
+# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
+# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
+# member documentation.
+# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
+# detailed member documentation.
+# The default value is: NO.
+
+SORT_MEMBERS_CTORS_1ST = NO
+
+# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
+# of group names into alphabetical order. If set to NO the group names will
+# appear in their defined order.
+# The default value is: NO.
+
+SORT_GROUP_NAMES = NO
+
+# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
+# fully-qualified names, including namespaces. If set to NO, the class list will
+# be sorted only by class name, not including the namespace part.
+# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
+# Note: This option applies only to the class list, not to the alphabetical
+# list.
+# The default value is: NO.
+
+SORT_BY_SCOPE_NAME = NO
+
+# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
+# type resolution of all parameters of a function it will reject a match between
+# the prototype and the implementation of a member function even if there is
+# only one candidate or it is obvious which candidate to choose by doing a
+# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
+# accept a match between prototype and implementation in such cases.
+# The default value is: NO.
+
+STRICT_PROTO_MATCHING = NO
+
+# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
+# list. This list is created by putting \todo commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TODOLIST = YES
+
+# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
+# list. This list is created by putting \test commands in the documentation.
+# The default value is: YES.
+
+GENERATE_TESTLIST = YES
+
+# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
+# list. This list is created by putting \bug commands in the documentation.
+# The default value is: YES.
+
+GENERATE_BUGLIST = YES
+
+# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
+# the deprecated list. This list is created by putting \deprecated commands in
+# the documentation.
+# The default value is: YES.
+
+GENERATE_DEPRECATEDLIST= YES
+
+# The ENABLED_SECTIONS tag can be used to enable conditional documentation
+# sections, marked by \if <section_label> ... \endif and \cond <section_label>
+# ... \endcond blocks.
+
+ENABLED_SECTIONS =
+
+# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
+# initial value of a variable or macro / define can have for it to appear in the
+# documentation. If the initializer consists of more lines than specified here
+# it will be hidden. Use a value of 0 to hide initializers completely. The
+# appearance of the value of individual variables and macros / defines can be
+# controlled using \showinitializer or \hideinitializer command in the
+# documentation regardless of this setting.
+# Minimum value: 0, maximum value: 10000, default value: 30.
+
+MAX_INITIALIZER_LINES = 30
+
+# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
+# the bottom of the documentation of classes and structs. If set to YES, the
+# list will mention the files that were used to generate the documentation.
+# The default value is: YES.
+
+SHOW_USED_FILES = NO
+
+# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
+# will remove the Files entry from the Quick Index and from the Folder Tree View
+# (if specified).
+# The default value is: YES.
+
+SHOW_FILES = NO
+
+# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
+# page. This will remove the Namespaces entry from the Quick Index and from the
+# Folder Tree View (if specified).
+# The default value is: YES.
+
+SHOW_NAMESPACES = YES
+
+# The FILE_VERSION_FILTER tag can be used to specify a program or script that
+# doxygen should invoke to get the current version for each file (typically from
+# the version control system). Doxygen will invoke the program by executing (via
+# popen()) the command command input-file, where command is the value of the
+# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided
+# by doxygen. Whatever the program writes to standard output is used as the file
+# version. For an example see the documentation.
+
+FILE_VERSION_FILTER =
+
+# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed
+# by doxygen. The layout file controls the global structure of the generated
+# output files in an output format independent way. To create the layout file
+# that represents doxygen's defaults, run doxygen with the -l option. You can
+# optionally specify a file name after the option, if omitted DoxygenLayout.xml
+# will be used as the name of the layout file.
+#
+# Note that if you run doxygen from a directory containing a file called
+# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE
+# tag is left empty.
+
+LAYOUT_FILE =
+
+# The CITE_BIB_FILES tag can be used to specify one or more bib files containing
+# the reference definitions. This must be a list of .bib files. The .bib
+# extension is automatically appended if omitted. This requires the bibtex tool
+# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info.
+# For LaTeX the style of the bibliography can be controlled using
+# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the
+# search path. See also \cite for info how to create references.
+
+CITE_BIB_FILES =
+
+#---------------------------------------------------------------------------
+# Configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+
+# The QUIET tag can be used to turn on/off the messages that are generated to
+# standard output by doxygen. If QUIET is set to YES this implies that the
+# messages are off.
+# The default value is: NO.
+
+QUIET = NO
+
+# The WARNINGS tag can be used to turn on/off the warning messages that are
+# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES
+# this implies that the warnings are on.
+#
+# Tip: Turn warnings on while writing the documentation.
+# The default value is: YES.
+
+WARNINGS = YES
+
+# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate
+# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag
+# will automatically be disabled.
+# The default value is: YES.
+
+WARN_IF_UNDOCUMENTED = YES
+
+# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for
+# potential errors in the documentation, such as not documenting some parameters
+# in a documented function, or documenting parameters that don't exist or using
+# markup commands wrongly.
+# The default value is: YES.
+
+WARN_IF_DOC_ERROR = YES
+
+# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that
+# are documented, but have no documentation for their parameters or return
+# value. If set to NO, doxygen will only warn about wrong or incomplete
+# parameter documentation, but not about the absence of documentation.
+# The default value is: NO.
+
+WARN_NO_PARAMDOC = YES
+
+# The WARN_FORMAT tag determines the format of the warning messages that doxygen
+# can produce. The string should contain the $file, $line, and $text tags, which
+# will be replaced by the file and line number from which the warning originated
+# and the warning text. Optionally the format may contain $version, which will
+# be replaced by the version of the file (if it could be obtained via
+# FILE_VERSION_FILTER)
+# The default value is: $file:$line: $text.
+
+WARN_FORMAT = "$file:$line: $text"
+
+# The WARN_LOGFILE tag can be used to specify a file to which warning and error
+# messages should be written. If left blank the output is written to standard
+# error (stderr).
+
+WARN_LOGFILE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the input files
+#---------------------------------------------------------------------------
+
+# The INPUT tag is used to specify the files and/or directories that contain
+# documented source files. You may enter file names like myfile.cpp or
+# directories like /usr/src/myproject. Separate the files or directories with
+# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
+# Note: If this tag is empty the current directory is searched.
+
+INPUT = "../lwrb/"
+
+# This tag can be used to specify the character encoding of the source files
+# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
+# libiconv (or the iconv built into libc) for the transcoding. See the libiconv
+# documentation (see: http://www.gnu.org/software/libiconv) for the list of
+# possible encodings.
+# The default value is: UTF-8.
+
+INPUT_ENCODING = UTF-8
+
+# If the value of the INPUT tag contains directories, you can use the
+# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
+# *.h) to filter out the source-files in the directories.
+#
+# Note that for custom extensions or not directly supported extensions you also
+# need to set EXTENSION_MAPPING for the extension otherwise the files are not
+# read by doxygen.
+#
+# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
+# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
+# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
+# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd,
+# *.vhdl, *.ucf, *.qsf, *.as and *.js.
+
+FILE_PATTERNS = *.c \
+ *.cc \
+ *.cxx \
+ *.cpp \
+ *.c++ \
+ *.java \
+ *.ii \
+ *.ixx \
+ *.ipp \
+ *.i++ \
+ *.inl \
+ *.idl \
+ *.ddl \
+ *.odl \
+ *.h \
+ *.hh \
+ *.hxx \
+ *.hpp \
+ *.h++ \
+ *.cs \
+ *.d \
+ *.php \
+ *.php4 \
+ *.php5 \
+ *.phtml \
+ *.inc \
+ *.m \
+ *.markdown \
+ *.md \
+ *.mm \
+ *.dox \
+ *.py \
+ *.f90 \
+ *.f \
+ *.for \
+ *.tcl \
+ *.vhd \
+ *.vhdl \
+ *.ucf \
+ *.qsf \
+ *.as \
+ *.js
+
+# The RECURSIVE tag can be used to specify whether or not subdirectories should
+# be searched for input files as well.
+# The default value is: NO.
+
+RECURSIVE = YES
+
+# The EXCLUDE tag can be used to specify files and/or directories that should be
+# excluded from the INPUT source files. This way you can easily exclude a
+# subdirectory from a directory tree whose root is specified with the INPUT tag.
+#
+# Note that relative paths are relative to the directory from which doxygen is
+# run.
+
+EXCLUDE =
+
+# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
+# directories that are symbolic links (a Unix file system feature) are excluded
+# from the input.
+# The default value is: NO.
+
+EXCLUDE_SYMLINKS = NO
+
+# If the value of the INPUT tag contains directories, you can use the
+# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude
+# certain files from those directories.
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories for example use the pattern */test/*
+
+EXCLUDE_PATTERNS =
+
+# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
+# (namespaces, classes, functions, etc.) that should be excluded from the
+# output. The symbol name can be a fully qualified name, a word, or if the
+# wildcard * is used, a substring. Examples: ANamespace, AClass,
+# AClass::ANamespace, ANamespace::*Test
+#
+# Note that the wildcards are matched against the file with absolute path, so to
+# exclude all test directories use the pattern */test/*
+
+EXCLUDE_SYMBOLS =
+
+# The EXAMPLE_PATH tag can be used to specify one or more files or directories
+# that contain example code fragments that are included (see the \include
+# command).
+
+EXAMPLE_PATH =
+
+# If the value of the EXAMPLE_PATH tag contains directories, you can use the
+# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
+# *.h) to filter out the source-files in the directories. If left blank all
+# files are included.
+
+EXAMPLE_PATTERNS = *
+
+# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
+# searched for input files to be used with the \include or \dontinclude commands
+# irrespective of the value of the RECURSIVE tag.
+# The default value is: NO.
+
+EXAMPLE_RECURSIVE = NO
+
+# The IMAGE_PATH tag can be used to specify one or more files or directories
+# that contain images that are to be included in the documentation (see the
+# \image command).
+
+IMAGE_PATH =
+
+# The INPUT_FILTER tag can be used to specify a program that doxygen should
+# invoke to filter for each input file. Doxygen will invoke the filter program
+# by executing (via popen()) the command:
+#
+# <filter> <input-file>
+#
+# where <filter> is the value of the INPUT_FILTER tag, and <input-file> is the
+# name of an input file. Doxygen will then use the output that the filter
+# program writes to standard output. If FILTER_PATTERNS is specified, this tag
+# will be ignored.
+#
+# Note that the filter must not add or remove lines; it is applied before the
+# code is scanned, but not when the output code is generated. If lines are added
+# or removed, the anchors will not be placed correctly.
+
+INPUT_FILTER =
+
+# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
+# basis. Doxygen will compare the file name with each pattern and apply the
+# filter if there is a match. The filters are a list of the form: pattern=filter
+# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how
+# filters are used. If the FILTER_PATTERNS tag is empty or if none of the
+# patterns match the file name, INPUT_FILTER is applied.
+
+FILTER_PATTERNS =
+
+# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using
+# INPUT_FILTER) will also be used to filter the input files that are used for
+# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES).
+# The default value is: NO.
+
+FILTER_SOURCE_FILES = NO
+
+# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file
+# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and
+# it is also possible to disable source filtering for a specific pattern using
+# *.ext= (so without naming a filter).
+# This tag requires that the tag FILTER_SOURCE_FILES is set to YES.
+
+FILTER_SOURCE_PATTERNS =
+
+# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that
+# is part of the input, its contents will be placed on the main page
+# (index.html). This can be useful if you have a project on for instance GitHub
+# and want to reuse the introduction page also for the doxygen output.
+
+USE_MDFILE_AS_MAINPAGE =
+
+#---------------------------------------------------------------------------
+# Configuration options related to source browsing
+#---------------------------------------------------------------------------
+
+# If the SOURCE_BROWSER tag is set to YES then a list of source files will be
+# generated. Documented entities will be cross-referenced with these sources.
+#
+# Note: To get rid of all source code in the generated output, make sure that
+# also VERBATIM_HEADERS is set to NO.
+# The default value is: NO.
+
+SOURCE_BROWSER = NO
+
+# Setting the INLINE_SOURCES tag to YES will include the body of functions,
+# classes and enums directly into the documentation.
+# The default value is: NO.
+
+INLINE_SOURCES = NO
+
+# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any
+# special comment blocks from generated source code fragments. Normal C, C++ and
+# Fortran comments will always remain visible.
+# The default value is: YES.
+
+STRIP_CODE_COMMENTS = YES
+
+# If the REFERENCED_BY_RELATION tag is set to YES then for each documented
+# function all documented functions referencing it will be listed.
+# The default value is: NO.
+
+REFERENCED_BY_RELATION = NO
+
+# If the REFERENCES_RELATION tag is set to YES then for each documented function
+# all documented entities called/used by that function will be listed.
+# The default value is: NO.
+
+REFERENCES_RELATION = NO
+
+# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set
+# to YES then the hyperlinks from functions in REFERENCES_RELATION and
+# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will
+# link to the documentation.
+# The default value is: YES.
+
+REFERENCES_LINK_SOURCE = YES
+
+# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the
+# source code will show a tooltip with additional information such as prototype,
+# brief description and links to the definition and documentation. Since this
+# will make the HTML file larger and loading of large files a bit slower, you
+# can opt to disable this feature.
+# The default value is: YES.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+SOURCE_TOOLTIPS = YES
+
+# If the USE_HTAGS tag is set to YES then the references to source code will
+# point to the HTML generated by the htags(1) tool instead of doxygen built-in
+# source browser. The htags tool is part of GNU's global source tagging system
+# (see http://www.gnu.org/software/global/global.html). You will need version
+# 4.8.6 or higher.
+#
+# To use it do the following:
+# - Install the latest version of global
+# - Enable SOURCE_BROWSER and USE_HTAGS in the config file
+# - Make sure the INPUT points to the root of the source tree
+# - Run doxygen as normal
+#
+# Doxygen will invoke htags (and that will in turn invoke gtags), so these
+# tools must be available from the command line (i.e. in the search path).
+#
+# The result: instead of the source browser generated by doxygen, the links to
+# source code will now point to the output of htags.
+# The default value is: NO.
+# This tag requires that the tag SOURCE_BROWSER is set to YES.
+
+USE_HTAGS = NO
+
+# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a
+# verbatim copy of the header file for each class for which an include is
+# specified. Set to NO to disable this.
+# See also: Section \class.
+# The default value is: YES.
+
+VERBATIM_HEADERS = YES
+
+# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
+# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
+# cost of reduced performance. This can be particularly helpful with template
+# rich C++ code for which doxygen's built-in parser lacks the necessary type
+# information.
+# Note: The availability of this option depends on whether or not doxygen was
+# compiled with the --with-libclang option.
+# The default value is: NO.
+
+CLANG_ASSISTED_PARSING = NO
+
+# If clang assisted parsing is enabled you can provide the compiler with command
+# line options that you would normally use when invoking the compiler. Note that
+# the include paths will already be set by doxygen for the files and directories
+# specified with INPUT and INCLUDE_PATH.
+# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
+
+CLANG_OPTIONS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+
+# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
+# compounds will be generated. Enable this if the project contains a lot of
+# classes, structs, unions or interfaces.
+# The default value is: YES.
+
+ALPHABETICAL_INDEX = YES
+
+# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
+# which the alphabetical index list will be split.
+# Minimum value: 1, maximum value: 20, default value: 5.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+COLS_IN_ALPHA_INDEX = 5
+
+# In case all classes in a project start with a common prefix, all classes will
+# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
+# can be used to specify a prefix (or a list of prefixes) that should be ignored
+# while generating the index headers.
+# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
+
+IGNORE_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the HTML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
+# The default value is: YES.
+
+GENERATE_HTML = YES
+
+# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_OUTPUT = html
+
+# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each
+# generated HTML page (for example: .htm, .php, .asp).
+# The default value is: .html.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FILE_EXTENSION = .html
+
+# The HTML_HEADER tag can be used to specify a user-defined HTML header file for
+# each generated HTML page. If the tag is left blank doxygen will generate a
+# standard header.
+#
+# To get valid HTML the header file that includes any scripts and style sheets
+# that doxygen needs, which is dependent on the configuration options used (e.g.
+# the setting GENERATE_TREEVIEW). It is highly recommended to start with a
+# default header using
+# doxygen -w html new_header.html new_footer.html new_stylesheet.css
+# YourConfigFile
+# and then modify the file new_header.html. See also section "Doxygen usage"
+# for information on how to generate the default header that doxygen normally
+# uses.
+# Note: The header is subject to change so you typically have to regenerate the
+# default header when upgrading to a newer version of doxygen. For a description
+# of the possible markers and block names see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_HEADER = ""
+
+# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each
+# generated HTML page. If the tag is left blank doxygen will generate a standard
+# footer. See HTML_HEADER for more information on how to generate a default
+# footer and what special commands can be used inside the footer. See also
+# section "Doxygen usage" for information on how to generate the default footer
+# that doxygen normally uses.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_FOOTER = ""
+
+# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style
+# sheet that is used by each HTML page. It can be used to fine-tune the look of
+# the HTML output. If left blank doxygen will generate a default style sheet.
+# See also section "Doxygen usage" for information on how to generate the style
+# sheet that doxygen normally uses.
+# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as
+# it is more robust and this tag (HTML_STYLESHEET) will in the future become
+# obsolete.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_STYLESHEET =
+
+# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# cascading style sheets that are included after the standard style sheets
+# created by doxygen. Using this option one can overrule certain style aspects.
+# This is preferred over using HTML_STYLESHEET since it does not replace the
+# standard style sheet and is therefore more robust against future updates.
+# Doxygen will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list). For an example see the documentation.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_STYLESHEET =
+
+# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the HTML output directory. Note
+# that these files will be copied to the base HTML output directory. Use the
+# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these
+# files. In the HTML_STYLESHEET file, use the file name only. Also note that the
+# files will be copied as-is; there are no commands or markers available.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_EXTRA_FILES =
+
+# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
+# will adjust the colors in the style sheet and background images according to
+# this color. Hue is specified as an angle on a colorwheel, see
+# http://en.wikipedia.org/wiki/Hue for more information. For instance the value
+# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300
+# purple, and 360 is red again.
+# Minimum value: 0, maximum value: 359, default value: 220.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_HUE = 220
+
+# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors
+# in the HTML output. For a value of 0 the output will use grayscales only. A
+# value of 255 will produce the most vivid colors.
+# Minimum value: 0, maximum value: 255, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_SAT = 100
+
+# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the
+# luminance component of the colors in the HTML output. Values below 100
+# gradually make the output lighter, whereas values above 100 make the output
+# darker. The value divided by 100 is the actual gamma applied, so 80 represents
+# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not
+# change the gamma.
+# Minimum value: 40, maximum value: 240, default value: 80.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_COLORSTYLE_GAMMA = 80
+
+# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
+# page will contain the date and time when the page was generated. Setting this
+# to YES can help to show when doxygen was last run and thus if the
+# documentation is up to date.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_TIMESTAMP = YES
+
+# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
+# documentation will contain sections that can be hidden and shown after the
+# page has loaded.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_DYNAMIC_SECTIONS = NO
+
+# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries
+# shown in the various tree structured indices initially; the user can expand
+# and collapse entries dynamically later on. Doxygen will expand the tree to
+# such a level that at most the specified number of entries are visible (unless
+# a fully collapsed tree already exceeds this amount). So setting the number of
+# entries 1 will produce a full collapsed tree by default. 0 is a special value
+# representing an infinite number of entries and will result in a full expanded
+# tree by default.
+# Minimum value: 0, maximum value: 9999, default value: 100.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+HTML_INDEX_NUM_ENTRIES = 100
+
+# If the GENERATE_DOCSET tag is set to YES, additional index files will be
+# generated that can be used as input for Apple's Xcode 3 integrated development
+# environment (see: http://developer.apple.com/tools/xcode/), introduced with
+# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a
+# Makefile in the HTML output directory. Running make will produce the docset in
+# that directory and running make install will install the docset in
+# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at
+# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html
+# for more information.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_DOCSET = NO
+
+# This tag determines the name of the docset feed. A documentation feed provides
+# an umbrella under which multiple documentation sets from a single provider
+# (such as a company or product suite) can be grouped.
+# The default value is: Doxygen generated docs.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_FEEDNAME = "Doxygen generated docs"
+
+# This tag specifies a string that should uniquely identify the documentation
+# set bundle. This should be a reverse domain-name style string, e.g.
+# com.mycompany.MyDocSet. Doxygen will append .docset to the name.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_BUNDLE_ID = org.doxygen.Project
+
+# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify
+# the documentation publisher. This should be a reverse domain-name style
+# string, e.g. com.mycompany.MyDocSet.documentation.
+# The default value is: org.doxygen.Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_ID = org.doxygen.Publisher
+
+# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher.
+# The default value is: Publisher.
+# This tag requires that the tag GENERATE_DOCSET is set to YES.
+
+DOCSET_PUBLISHER_NAME = Publisher
+
+# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three
+# additional HTML index files: index.hhp, index.hhc, and index.hhk. The
+# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop
+# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on
+# Windows.
+#
+# The HTML Help Workshop contains a compiler that can convert all HTML output
+# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
+# files are now used as the Windows 98 help format, and will replace the old
+# Windows help format (.hlp) on all Windows platforms in the future. Compressed
+# HTML files also contain an index, a table of contents, and you can search for
+# words in the documentation. The HTML workshop also contains a viewer for
+# compressed HTML files.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_HTMLHELP = NO
+
+# The CHM_FILE tag can be used to specify the file name of the resulting .chm
+# file. You can add a path in front of the file if the result should not be
+# written to the html output directory.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_FILE =
+
+# The HHC_LOCATION tag can be used to specify the location (absolute path
+# including file name) of the HTML help compiler (hhc.exe). If non-empty,
+# doxygen will try to run the HTML help compiler on the generated index.hhp.
+# The file has to be specified with full path.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+HHC_LOCATION =
+
+# The GENERATE_CHI flag controls if a separate .chi index file is generated
+# (YES) or that it should be included in the master .chm file (NO).
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+GENERATE_CHI = NO
+
+# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
+# and project file content.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+CHM_INDEX_ENCODING =
+
+# The BINARY_TOC flag controls whether a binary table of contents is generated
+# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
+# enables the Previous and Next buttons.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+BINARY_TOC = NO
+
+# The TOC_EXPAND flag can be set to YES to add extra items for group members to
+# the table of contents of the HTML help documentation and to the tree view.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
+
+TOC_EXPAND = NO
+
+# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
+# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
+# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
+# (.qch) of the generated HTML documentation.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_QHP = NO
+
+# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
+# the file name of the resulting .qch file. The path specified is relative to
+# the HTML output folder.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QCH_FILE =
+
+# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
+# Project output. For more information please see Qt Help Project / Namespace
+# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace).
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_NAMESPACE = org.doxygen.Project
+
+# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
+# Help Project output. For more information please see Qt Help Project / Virtual
+# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual-
+# folders).
+# The default value is: doc.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_VIRTUAL_FOLDER = doc
+
+# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
+# filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_NAME =
+
+# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
+# custom filter to add. For more information please see Qt Help Project / Custom
+# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom-
+# filters).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_CUST_FILTER_ATTRS =
+
+# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
+# project's filter section matches. Qt Help Project / Filter Attributes (see:
+# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes).
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHP_SECT_FILTER_ATTRS =
+
+# The QHG_LOCATION tag can be used to specify the location of Qt's
+# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the
+# generated .qhp file.
+# This tag requires that the tag GENERATE_QHP is set to YES.
+
+QHG_LOCATION =
+
+# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
+# generated, together with the HTML files, they form an Eclipse help plugin. To
+# install this plugin and make it available under the help contents menu in
+# Eclipse, the contents of the directory containing the HTML and XML files needs
+# to be copied into the plugins directory of eclipse. The name of the directory
+# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
+# After copying Eclipse needs to be restarted before the help appears.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_ECLIPSEHELP = NO
+
+# A unique identifier for the Eclipse help plugin. When installing the plugin
+# the directory name containing the HTML and XML files should also have this
+# name. Each documentation set should have its own identifier.
+# The default value is: org.doxygen.Project.
+# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
+
+ECLIPSE_DOC_ID = org.doxygen.Project
+
+# If you want full control over the layout of the generated HTML pages it might
+# be necessary to disable the index and replace it with your own. The
+# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
+# of each HTML page. A value of NO enables the index and the value YES disables
+# it. Since the tabs in the index contain the same information as the navigation
+# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+DISABLE_INDEX = NO
+
+# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
+# structure should be generated to display hierarchical information. If the tag
+# value is set to YES, a side panel will be generated containing a tree-like
+# index structure (just like the one that is generated for HTML Help). For this
+# to work a browser that supports JavaScript, DHTML, CSS and frames is required
+# (i.e. any modern browser). Windows users are probably better off using the
+# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
+# further fine-tune the look of the index. As an example, the default style
+# sheet generated by doxygen has an example that shows how to put an image at
+# the root of the tree instead of the PROJECT_NAME. Since the tree basically has
+# the same information as the tab index, you could consider setting
+# DISABLE_INDEX to YES when enabling this option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+GENERATE_TREEVIEW = YES
+
+# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that
+# doxygen will group on one line in the generated HTML documentation.
+#
+# Note that a value of 0 will completely suppress the enum values from appearing
+# in the overview section.
+# Minimum value: 0, maximum value: 20, default value: 4.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+ENUM_VALUES_PER_LINE = 4
+
+# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used
+# to set the initial width (in pixels) of the frame in which the tree is shown.
+# Minimum value: 0, maximum value: 1500, default value: 250.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+TREEVIEW_WIDTH = 250
+
+# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to
+# external symbols imported via tag files in a separate window.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+EXT_LINKS_IN_WINDOW = NO
+
+# Use this tag to change the font size of LaTeX formulas included as images in
+# the HTML documentation. When you change the font size after a successful
+# doxygen run you need to manually remove any form_*.png images from the HTML
+# output directory to force them to be regenerated.
+# Minimum value: 8, maximum value: 50, default value: 10.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_FONTSIZE = 10
+
+# Use the FORMULA_TRANPARENT tag to determine whether or not the images
+# generated for formulas are transparent PNGs. Transparent PNGs are not
+# supported properly for IE 6.0, but are supported on all modern browsers.
+#
+# Note that when changing this option you need to delete any form_*.png files in
+# the HTML output directory before the changes have effect.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+FORMULA_TRANSPARENT = YES
+
+# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see
+# http://www.mathjax.org) which uses client side Javascript for the rendering
+# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX
+# installed or if you want to formulas look prettier in the HTML output. When
+# enabled you may also need to install MathJax separately and configure the path
+# to it using the MATHJAX_RELPATH option.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+USE_MATHJAX = YES
+
+# When MathJax is enabled you can set the default output format to be used for
+# the MathJax output. See the MathJax site (see:
+# http://docs.mathjax.org/en/latest/output.html) for more details.
+# Possible values are: HTML-CSS (which is slower, but has the best
+# compatibility), NativeMML (i.e. MathML) and SVG.
+# The default value is: HTML-CSS.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_FORMAT = HTML-CSS
+
+# When MathJax is enabled you need to specify the location relative to the HTML
+# output directory using the MATHJAX_RELPATH option. The destination directory
+# should contain the MathJax.js script. For instance, if the mathjax directory
+# is located at the same level as the HTML output directory, then
+# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax
+# Content Delivery Network so you can quickly see the result without installing
+# MathJax. However, it is strongly recommended to install a local copy of
+# MathJax from http://www.mathjax.org before deployment.
+# The default value is: http://cdn.mathjax.org/mathjax/latest.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
+
+# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
+# extension names that should be enabled during MathJax rendering. For example
+# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_EXTENSIONS =
+
+# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
+# of code that will be used on startup of the MathJax code. See the MathJax site
+# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an
+# example see the documentation.
+# This tag requires that the tag USE_MATHJAX is set to YES.
+
+MATHJAX_CODEFILE =
+
+# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
+# the HTML output. The underlying search engine uses javascript and DHTML and
+# should work on any modern browser. Note that when using HTML help
+# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
+# there is already a search function so this one should typically be disabled.
+# For large projects the javascript based search engine can be slow, then
+# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
+# search using the keyboard; to jump to the search box use <access key> + S
+# (what the <access key> is depends on the OS and browser, but it is typically
+# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
+# key> to jump into the search results window, the results can be navigated
+# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
+# the search. The filter options can be selected when the cursor is inside the
+# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
+# to select a filter and <Enter> or <escape> to activate or cancel the filter
+# option.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_HTML is set to YES.
+
+SEARCHENGINE = YES
+
+# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
+# implemented using a web server instead of a web client using Javascript. There
+# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
+# setting. When disabled, doxygen will generate a PHP script for searching and
+# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
+# and searching needs to be provided by external tools. See the section
+# "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SERVER_BASED_SEARCH = NO
+
+# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
+# script for searching. Instead the search results are written to an XML file
+# which needs to be processed by an external indexer. Doxygen will invoke an
+# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
+# search results.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/).
+#
+# See the section "External Indexing and Searching" for details.
+# The default value is: NO.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH = NO
+
+# The SEARCHENGINE_URL should point to a search engine hosted by a web server
+# which will return the search results when EXTERNAL_SEARCH is enabled.
+#
+# Doxygen ships with an example indexer (doxyindexer) and search engine
+# (doxysearch.cgi) which are based on the open source search engine library
+# Xapian (see: http://xapian.org/). See the section "External Indexing and
+# Searching" for details.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHENGINE_URL =
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
+# search data is written to a file for indexing by an external tool. With the
+# SEARCHDATA_FILE tag the name of this file can be specified.
+# The default file is: searchdata.xml.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+SEARCHDATA_FILE = searchdata.xml
+
+# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
+# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
+# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
+# projects and redirect the results back to the right project.
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTERNAL_SEARCH_ID =
+
+# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
+# projects other than the one defined by this configuration file, but that are
+# all added to the same external search index. Each project needs to have a
+# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
+# to a relative location where the documentation can be found. The format is:
+# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
+# This tag requires that the tag SEARCHENGINE is set to YES.
+
+EXTRA_SEARCH_MAPPINGS =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
+# The default value is: YES.
+
+GENERATE_LATEX = NO
+
+# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_OUTPUT = latex
+
+# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
+# invoked.
+#
+# Note that when enabling USE_PDFLATEX this option is only used for generating
+# bitmaps for formulas in the HTML output, but not in the Makefile that is
+# written to the output directory.
+# The default file is: latex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_CMD_NAME = latex
+
+# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
+# index for LaTeX.
+# The default file is: makeindex.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+MAKEINDEX_CMD_NAME = makeindex
+
+# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+COMPACT_LATEX = YES
+
+# The PAPER_TYPE tag can be used to set the paper type that is used by the
+# printer.
+# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
+# 14 inches) and executive (7.25 x 10.5 inches).
+# The default value is: a4.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PAPER_TYPE = a4
+
+# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
+# that should be included in the LaTeX output. The package can be specified just
+# by its name or with the correct syntax as to be used with the LaTeX
+# \usepackage command. To get the times font for instance you can specify :
+# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
+# To use the option intlimits with the amsmath package you can specify:
+# EXTRA_PACKAGES=[intlimits]{amsmath}
+# If left blank no extra packages will be included.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+EXTRA_PACKAGES =
+
+# The LATEX_HEADER tag can be used to specify a personal LaTeX header for the
+# generated LaTeX document. The header should contain everything until the first
+# chapter. If it is left blank doxygen will generate a standard header. See
+# section "Doxygen usage" for information on how to let doxygen write the
+# default header to a separate file.
+#
+# Note: Only use a user-defined header if you know what you are doing! The
+# following commands have a special meaning inside the header: $title,
+# $datetime, $date, $doxygenversion, $projectname, $projectnumber,
+# $projectbrief, $projectlogo. Doxygen will replace $title with the empty
+# string, for the replacement values of the other commands the user is referred
+# to HTML_HEADER.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HEADER =
+
+# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the
+# generated LaTeX document. The footer should contain everything after the last
+# chapter. If it is left blank doxygen will generate a standard footer. See
+# LATEX_HEADER for more information on how to generate a default footer and what
+# special commands can be used inside the footer.
+#
+# Note: Only use a user-defined footer if you know what you are doing!
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_FOOTER =
+
+# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
+# LaTeX style sheets that are included after the standard style sheets created
+# by doxygen. Using this option one can overrule certain style aspects. Doxygen
+# will copy the style sheet files to the output directory.
+# Note: The order of the extra style sheet files is of importance (e.g. the last
+# style sheet in the list overrules the setting of the previous ones in the
+# list).
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_STYLESHEET =
+
+# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
+# other source files which should be copied to the LATEX_OUTPUT output
+# directory. Note that the files will be copied as-is; there are no commands or
+# markers available.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_EXTRA_FILES =
+
+# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
+# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
+# contain links (just like the HTML output) instead of page references. This
+# makes the output suitable for online browsing using a PDF viewer.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+PDF_HYPERLINKS = YES
+
+# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate
+# the PDF file directly from the LaTeX files. Set this option to YES, to get a
+# higher quality PDF documentation.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+USE_PDFLATEX = YES
+
+# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode
+# command to the generated LaTeX files. This will instruct LaTeX to keep running
+# if errors occur, instead of asking the user for help. This option is also used
+# when generating formulas in HTML.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BATCHMODE = NO
+
+# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
+# index chapters (such as File Index, Compound Index, etc.) in the output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_HIDE_INDICES = NO
+
+# If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source
+# code with syntax highlighting in the LaTeX output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_SOURCE_CODE = YES
+
+# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
+# bibliography, e.g. plainnat, or ieeetr. See
+# http://en.wikipedia.org/wiki/BibTeX and \cite for more info.
+# The default value is: plain.
+# This tag requires that the tag GENERATE_LATEX is set to YES.
+
+LATEX_BIB_STYLE = plain
+
+#---------------------------------------------------------------------------
+# Configuration options related to the RTF output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
+# RTF output is optimized for Word 97 and may not look too pretty with other RTF
+# readers/editors.
+# The default value is: NO.
+
+GENERATE_RTF = NO
+
+# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: rtf.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_OUTPUT = rtf
+
+# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
+# documents. This may be useful for small projects and may help to save some
+# trees in general.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+COMPACT_RTF = YES
+
+# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
+# contain hyperlink fields. The RTF file will contain links (just like the HTML
+# output) instead of page references. This makes the output suitable for online
+# browsing using Word or some other Word compatible readers that support those
+# fields.
+#
+# Note: WordPad (write) and others do not support links.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_HYPERLINKS = YES
+
+# Load stylesheet definitions from file. Syntax is similar to doxygen's config
+# file, i.e. a series of assignments. You only have to provide replacements,
+# missing definitions are set to their default value.
+#
+# See also section "Doxygen usage" for information on how to generate the
+# default style sheet that doxygen normally uses.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_STYLESHEET_FILE =
+
+# Set optional variables used in the generation of an RTF document. Syntax is
+# similar to doxygen's config file. A template extensions file can be generated
+# using doxygen -e rtf extensionFile.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_EXTENSIONS_FILE =
+
+# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code
+# with syntax highlighting in the RTF output.
+#
+# Note that which sources are shown also depends on other settings such as
+# SOURCE_BROWSER.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_RTF is set to YES.
+
+RTF_SOURCE_CODE = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the man page output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
+# classes and files.
+# The default value is: NO.
+
+GENERATE_MAN = NO
+
+# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it. A directory man3 will be created inside the directory specified by
+# MAN_OUTPUT.
+# The default directory is: man.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_OUTPUT = man
+
+# The MAN_EXTENSION tag determines the extension that is added to the generated
+# man pages. In case the manual section does not start with a number, the number
+# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
+# optional.
+# The default value is: .3.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_EXTENSION = .3
+
+# The MAN_SUBDIR tag determines the name of the directory created within
+# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
+# MAN_EXTENSION with the initial . removed.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_SUBDIR =
+
+# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
+# will generate one additional man file for each entity documented in the real
+# man page(s). These additional files only source the real man page, but without
+# them the man command would be unable to find the correct page.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_MAN is set to YES.
+
+MAN_LINKS = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the XML output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
+# captures the structure of the code including all documentation.
+# The default value is: NO.
+
+GENERATE_XML = YES
+
+# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
+# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
+# it.
+# The default directory is: xml.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_OUTPUT = xml
+
+# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
+# listings (including syntax highlighting and cross-referencing information) to
+# the XML output. Note that enabling this will significantly increase the size
+# of the XML output.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_XML is set to YES.
+
+XML_PROGRAMLISTING = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to the DOCBOOK output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
+# that can be used to generate PDF.
+# The default value is: NO.
+
+GENERATE_DOCBOOK = NO
+
+# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages will be put.
+# If a relative path is entered the value of OUTPUT_DIRECTORY will be put in
+# front of it.
+# The default directory is: docbook.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_OUTPUT = docbook
+
+# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the
+# program listings (including syntax highlighting and cross-referencing
+# information) to the DOCBOOK output. Note that enabling this will significantly
+# increase the size of the DOCBOOK output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
+
+DOCBOOK_PROGRAMLISTING = NO
+
+#---------------------------------------------------------------------------
+# Configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
+# AutoGen Definitions (see http://autogen.sf.net) file that captures the
+# structure of the code including all documentation. Note that this feature is
+# still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_AUTOGEN_DEF = NO
+
+#---------------------------------------------------------------------------
+# Configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+
+# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
+# file that captures the structure of the code including all documentation.
+#
+# Note that this feature is still experimental and incomplete at the moment.
+# The default value is: NO.
+
+GENERATE_PERLMOD = NO
+
+# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
+# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
+# output from the Perl module output.
+# The default value is: NO.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_LATEX = NO
+
+# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
+# formatted so it can be parsed by a human reader. This is useful if you want to
+# understand what is going on. On the other hand, if this tag is set to NO, the
+# size of the Perl module output will be much smaller and Perl will parse it
+# just the same.
+# The default value is: YES.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_PRETTY = YES
+
+# The names of the make variables in the generated doxyrules.make file are
+# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
+# so different doxyrules.make files included by the same Makefile don't
+# overwrite each other's variables.
+# This tag requires that the tag GENERATE_PERLMOD is set to YES.
+
+PERLMOD_MAKEVAR_PREFIX =
+
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+
+# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
+# C-preprocessor directives found in the sources and include files.
+# The default value is: YES.
+
+ENABLE_PREPROCESSING = YES
+
+# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
+# in the source code. If set to NO, only conditional compilation will be
+# performed. Macro expansion can be done in a controlled way by setting
+# EXPAND_ONLY_PREDEF to YES.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+MACRO_EXPANSION = NO
+
+# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
+# the macro expansion is limited to the macros specified with the PREDEFINED and
+# EXPAND_AS_DEFINED tags.
+# The default value is: NO.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_ONLY_PREDEF = NO
+
+# If the SEARCH_INCLUDES tag is set to YES, the include files in the
+# INCLUDE_PATH will be searched if a #include is found.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SEARCH_INCLUDES = YES
+
+# The INCLUDE_PATH tag can be used to specify one or more directories that
+# contain include files that are not input files but should be processed by the
+# preprocessor.
+# This tag requires that the tag SEARCH_INCLUDES is set to YES.
+
+INCLUDE_PATH =
+
+# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
+# patterns (like *.h and *.hpp) to filter out the header-files in the
+# directories. If left blank, the patterns specified with FILE_PATTERNS will be
+# used.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+INCLUDE_FILE_PATTERNS =
+
+# The PREDEFINED tag can be used to specify one or more macro names that are
+# defined before the preprocessor is started (similar to the -D option of e.g.
+# gcc). The argument of the tag is a list of macros of the form: name or
+# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
+# is assumed. To prevent a macro definition from being undefined via #undef or
+# recursively expanded use the := operator instead of the = operator.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \
+ DOXYGEN \
+ __DOXYGEN__=1
+
+# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
+# tag can be used to specify a list of macro names that should be expanded. The
+# macro definition that is found in the sources will be used. Use the PREDEFINED
+# tag if you want to use a different macro definition that overrules the
+# definition found in the source code.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+EXPAND_AS_DEFINED =
+
+# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
+# remove all references to function-like macros that are alone on a line, have
+# an all uppercase name, and do not end with a semicolon. Such function macros
+# are typically used for boiler-plate code, and will confuse the parser if not
+# removed.
+# The default value is: YES.
+# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
+
+SKIP_FUNCTION_MACROS = YES
+
+#---------------------------------------------------------------------------
+# Configuration options related to external references
+#---------------------------------------------------------------------------
+
+# The TAGFILES tag can be used to specify one or more tag files. For each tag
+# file the location of the external documentation should be added. The format of
+# a tag file without this location is as follows:
+# TAGFILES = file1 file2 ...
+# Adding location for the tag files is done as follows:
+# TAGFILES = file1=loc1 "file2 = loc2" ...
+# where loc1 and loc2 can be relative or absolute paths or URLs. See the
+# section "Linking to external documentation" for more information about the use
+# of tag files.
+# Note: Each tag file must have a unique name (where the name does NOT include
+# the path). If a tag file is not located in the directory in which doxygen is
+# run, you must also specify the path to the tagfile here.
+
+TAGFILES =
+
+# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
+# tag file that is based on the input files it reads. See section "Linking to
+# external documentation" for more information about the usage of tag files.
+
+GENERATE_TAGFILE =
+
+# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
+# the class index. If set to NO, only the inherited external classes will be
+# listed.
+# The default value is: NO.
+
+ALLEXTERNALS = NO
+
+# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
+# in the modules index. If set to NO, only the current project's groups will be
+# listed.
+# The default value is: YES.
+
+EXTERNAL_GROUPS = YES
+
+# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
+# the related pages index. If set to NO, only the current project's pages will
+# be listed.
+# The default value is: YES.
+
+EXTERNAL_PAGES = YES
+
+# The PERL_PATH should be the absolute path and name of the perl script
+# interpreter (i.e. the result of 'which perl').
+# The default file (with absolute path) is: /usr/bin/perl.
+
+PERL_PATH = /usr/bin/perl
+
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+
+# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram
+# (in HTML and LaTeX) for classes with base or super classes. Setting the tag to
+# NO turns the diagrams off. Note that this option also works with HAVE_DOT
+# disabled, but it is recommended to install and use dot, since it yields more
+# powerful graphs.
+# The default value is: YES.
+
+CLASS_DIAGRAMS = YES
+
+# You can define message sequence charts within doxygen comments using the \msc
+# command. Doxygen will then run the mscgen tool (see:
+# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
+# documentation. The MSCGEN_PATH tag allows you to specify the directory where
+# the mscgen tool resides. If left empty the tool is assumed to be found in the
+# default search path.
+
+MSCGEN_PATH =
+
+# You can include diagrams made with dia in doxygen documentation. Doxygen will
+# then run dia to produce the diagram and insert it in the documentation. The
+# DIA_PATH tag allows you to specify the directory where the dia binary resides.
+# If left empty dia is assumed to be found in the default search path.
+
+DIA_PATH =
+
+# If set to YES the inheritance and collaboration graphs will hide inheritance
+# and usage relations if the target is undocumented or is not a class.
+# The default value is: YES.
+
+HIDE_UNDOC_RELATIONS = YES
+
+# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
+# available from the path. This tool is part of Graphviz (see:
+# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
+# Bell Labs. The other options in this section have no effect if this option is
+# set to NO
+# The default value is: NO.
+
+HAVE_DOT = NO
+
+# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
+# to run in parallel. When set to 0 doxygen will base this on the number of
+# processors available in the system. You can set it explicitly to a value
+# larger than 0 to get control over the balance between CPU load and processing
+# speed.
+# Minimum value: 0, maximum value: 32, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_NUM_THREADS = 0
+
+# When you want a differently looking font in the dot files that doxygen
+# generates you can specify the font name using DOT_FONTNAME. You need to make
+# sure dot is able to find the font, which can be done by putting it in a
+# standard location or by setting the DOTFONTPATH environment variable or by
+# setting DOT_FONTPATH to the directory containing the font.
+# The default value is: Helvetica.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTNAME = Helvetica
+
+# The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
+# dot graphs.
+# Minimum value: 4, maximum value: 24, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTSIZE = 10
+
+# By default doxygen will tell dot to use the default font as specified with
+# DOT_FONTNAME. If you specify a different font using DOT_FONTNAME you can set
+# the path where dot can find it using this tag.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_FONTPATH =
+
+# If the CLASS_GRAPH tag is set to YES then doxygen will generate a graph for
+# each documented class showing the direct and indirect inheritance relations.
+# Setting this tag to YES will force the CLASS_DIAGRAMS tag to NO.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CLASS_GRAPH = YES
+
+# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
+# graph for each documented class showing the direct and indirect implementation
+# dependencies (inheritance, containment, and class references variables) of the
+# class with other documented classes.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+COLLABORATION_GRAPH = YES
+
+# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
+# groups, showing the direct groups dependencies.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GROUP_GRAPHS = YES
+
+# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
+# collaboration diagrams in a style similar to the OMG's Unified Modeling
+# Language.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LOOK = NO
+
+# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
+# class node. If there are many fields or methods and many nodes the graph may
+# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
+# number of items for each type to make the size more manageable. Set this to 0
+# for no limit. Note that the threshold may be exceeded by 50% before the limit
+# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
+# but if the number exceeds 15, the total amount of fields shown is limited to
+# 10.
+# Minimum value: 0, maximum value: 100, default value: 10.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+UML_LIMIT_NUM_FIELDS = 10
+
+# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
+# collaboration graphs will show the relations between templates and their
+# instances.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+TEMPLATE_RELATIONS = NO
+
+# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
+# YES then doxygen will generate a graph for each documented file showing the
+# direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDE_GRAPH = YES
+
+# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
+# set to YES then doxygen will generate a graph for each documented file showing
+# the direct and indirect include dependencies of the file with other documented
+# files.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INCLUDED_BY_GRAPH = YES
+
+# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable call graphs for selected
+# functions only using the \callgraph command. Disabling a call graph can be
+# accomplished by means of the command \hidecallgraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALL_GRAPH = NO
+
+# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
+# dependency graph for every global function or class method.
+#
+# Note that enabling this option will significantly increase the time of a run.
+# So in most cases it will be better to enable caller graphs for selected
+# functions only using the \callergraph command. Disabling a caller graph can be
+# accomplished by means of the command \hidecallergraph.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+CALLER_GRAPH = NO
+
+# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
+# hierarchy of all classes instead of a textual one.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GRAPHICAL_HIERARCHY = YES
+
+# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
+# dependencies a directory has on other directories in a graphical way. The
+# dependency relations are determined by the #include relations between the
+# files in the directories.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DIRECTORY_GRAPH = YES
+
+# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
+# generated by dot. For an explanation of the image formats see the section
+# output formats in the documentation of the dot tool (Graphviz (see:
+# http://www.graphviz.org/)).
+# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
+# to make the SVG files visible in IE 9+ (other browsers do not have this
+# requirement).
+# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
+# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
+# png:gdiplus:gdiplus.
+# The default value is: png.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_IMAGE_FORMAT = png
+
+# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
+# enable generation of interactive SVG images that allow zooming and panning.
+#
+# Note that this requires a modern browser other than Internet Explorer. Tested
+# and working are Firefox, Chrome, Safari, and Opera.
+# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
+# the SVG files visible. Older versions of IE do not have SVG support.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+INTERACTIVE_SVG = NO
+
+# The DOT_PATH tag can be used to specify the path where the dot tool can be
+# found. If left blank, it is assumed the dot tool can be found in the path.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_PATH =
+
+# The DOTFILE_DIRS tag can be used to specify one or more directories that
+# contain dot files that are included in the documentation (see the \dotfile
+# command).
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOTFILE_DIRS =
+
+# The MSCFILE_DIRS tag can be used to specify one or more directories that
+# contain msc files that are included in the documentation (see the \mscfile
+# command).
+
+MSCFILE_DIRS =
+
+# The DIAFILE_DIRS tag can be used to specify one or more directories that
+# contain dia files that are included in the documentation (see the \diafile
+# command).
+
+DIAFILE_DIRS =
+
+# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
+# path where java can find the plantuml.jar file. If left blank, it is assumed
+# PlantUML is not used or called during a preprocessing step. Doxygen will
+# generate a warning when it encounters a \startuml command in this case and
+# will not generate output for the diagram.
+
+PLANTUML_JAR_PATH =
+
+# When using plantuml, the specified paths are searched for files specified by
+# the !include statement in a plantuml block.
+
+PLANTUML_INCLUDE_PATH =
+
+# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
+# that will be shown in the graph. If the number of nodes in a graph becomes
+# larger than this value, doxygen will truncate the graph, which is visualized
+# by representing a node as a red box. Note that doxygen if the number of direct
+# children of the root node in a graph is already larger than
+# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
+# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
+# Minimum value: 0, maximum value: 10000, default value: 50.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_GRAPH_MAX_NODES = 50
+
+# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
+# generated by dot. A depth value of 3 means that only nodes reachable from the
+# root by following a path via at most 3 edges will be shown. Nodes that lay
+# further from the root node will be omitted. Note that setting this option to 1
+# or 2 may greatly reduce the computation time needed for large code bases. Also
+# note that the size of a graph can be further restricted by
+# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
+# Minimum value: 0, maximum value: 1000, default value: 0.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+MAX_DOT_GRAPH_DEPTH = 0
+
+# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent
+# background. This is disabled by default, because dot on Windows does not seem
+# to support this out of the box.
+#
+# Warning: Depending on the platform used, enabling this option may lead to
+# badly anti-aliased labels on the edges of a graph (i.e. they become hard to
+# read).
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_TRANSPARENT = NO
+
+# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
+# files in one run (i.e. multiple -o and -T options on the command line). This
+# makes dot run faster, but since only newer versions of dot (>1.8.10) support
+# this, this feature is disabled by default.
+# The default value is: NO.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_MULTI_TARGETS = NO
+
+# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
+# explaining the meaning of the various boxes and arrows in the dot generated
+# graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+GENERATE_LEGEND = YES
+
+# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot
+# files that are used to generate the various graphs.
+# The default value is: YES.
+# This tag requires that the tag HAVE_DOT is set to YES.
+
+DOT_CLEANUP = YES
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_advance_1.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_advance_1.c
new file mode 100644
index 000000000..3a2e041e9
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_advance_1.c
@@ -0,0 +1,67 @@
+/* Declare rb instance & raw data */
+lwrb_t buff;
+uint8_t buff_data[8];
+
+size_t len;
+uint8_t* data;
+
+/* Initialize buffer, use buff_data as data array */
+lwrb_init(&buff, buff_data, sizeof(buff_data));
+
+/* Use write, read operations, process data */
+/* ... */
+
+/* IMAGE PART A */
+
+/* At this stage, we have buffer as on image above */
+/* R = 4, W = 4, buffer is considered empty */
+
+/* Get length of linear memory at write pointer */
+/* Function returns 4 as we can write 4 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_write_length(&buff)) > 0) {
+ /* Get pointer to first element in linear block at write address */
+ /* Function returns &buff_data[4] */
+ 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 */
+ /* Data array has len bytes length */
+ /* Or use memcpy(data, my_array, len); */
+ receive_data(data, len);
+
+ /* Now advance buffer for written bytes to buffer = move write pointer */
+ /* Write pointer is moved for len bytes */
+ lwrb_advance(&buff, len);
+
+ /* Now W points to top of buffer, W = 0 */
+ /* At this point, we are at image part B */
+}
+
+/* IMAGE PART B */
+
+/* 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_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_write_address(&buff);
+
+ /* Receive data via DMA and wait to finish (for sake of example) */
+ /* Any other hardware may directly write to data array */
+ /* Data array has len bytes length */
+ /* Or use memcpy(data, my_array, len); */
+ receive_data(data, len);
+
+ /* Now advance buffer for written bytes to buffer = move write pointer */
+ /* Write pointer is moved for len bytes */
+ lwrb_advance(&buff, len);
+
+ /* Now W points to 3, R points to 4, that is R == W + 1 and buffer is now full */
+ /* At this point, we are at image part C */
+}
+
+/* IMAGE PART C */
+
+/* Buffer is considered full as R == W + 1 */ \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_advance_2.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_advance_2.c
new file mode 100644
index 000000000..4486a9e11
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_advance_2.c
@@ -0,0 +1,19 @@
+#include "lwrb/lwrb.h"
+
+/* Declare rb instance & raw data */
+lwrb_t buff;
+uint8_t buff_data[8];
+
+/* Application variables */
+uint8_t data[2];
+
+/* Application code ... */
+lwrb_init(&buff, buff_data, sizeof(buff_data)); /* Initialize buffer */
+
+/* Write 4 bytes of data */
+lwrb_write(&buff, "0123", 4);
+
+/* Print number of bytes in buffer */
+printf("Bytes in buffer: %d\r\n", (int)lwrb_get_full(&buff));
+
+/* Will print "4" */ \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_dma_skip.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_dma_skip.c
new file mode 100644
index 000000000..24042868a
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_dma_skip.c
@@ -0,0 +1,61 @@
+/* Declare rb instance & raw data */
+lwrb_t buff;
+uint8_t buff_data[8];
+
+/* Working data length */
+volatile size_t len;
+
+/* Send data function */
+void send_data(void);
+
+int
+main(void) {
+ /* Initialize buffer */
+ lwrb_init(&buff, buff_data, sizeof(buff_data));
+
+ /* Write 4 bytes of data */
+ lwrb_write(&buff, "0123", 4);
+
+ /* Send data over DMA */
+ send_data();
+
+ while (1);
+}
+
+/* Send data over DMA */
+void
+send_data(void) {
+ /* If len > 0, DMA transfer is on-going */
+ if (len > 0) {
+ return;
+ }
+
+ /* Get maximal length of buffer to read data as linear memory */
+ len = lwrb_get_linear_block_read_length(&buff);
+ if (len > 0) {
+ /* Get pointer to read memory */
+ uint8_t* data = lwrb_get_linear_block_read_address(&buff);
+
+ /* Start DMA transfer */
+ start_dma_transfer(data, len);
+ }
+
+ /* Function does not wait for transfer to finish */
+}
+
+/* Interrupt handler */
+/* Called on DMA transfer finish */
+void
+DMA_Interrupt_handler(void) {
+ /* Transfer finished */
+ if (len > 0) {
+ /* Now skip the data (move read pointer) as they were successfully transferred over DMA */
+ lwrb_skip(&buff, len);
+
+ /* Reset length = DMA is not active */
+ len = 0;
+
+ /* Try to send more */
+ send_data();
+ }
+}
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_events.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_events.c
new file mode 100644
index 000000000..378bf887a
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_events.c
@@ -0,0 +1,26 @@
+/**
+ * \brief Buffer event function
+ */
+void
+my_buff_evt_fn(lwrb_t* buff, lwrb_evt_type_t type, size_t len) {
+ switch (type) {
+ case LWRB_EVT_RESET:
+ printf("[EVT] Buffer reset event!\r\n");
+ break;
+ case LWRB_EVT_READ:
+ printf("[EVT] Buffer read event: %d byte(s)!\r\n", (int)len);
+ break;
+ case LWRB_EVT_WRITE:
+ printf("[EVT] Buffer write event: %d byte(s)!\r\n", (int)len);
+ break;
+ default: break;
+ }
+}
+
+/* Later in the code... */
+lwrb_t buff;
+uint8_t buff_data[8];
+
+/* Init buffer and set event function */
+lwrb_init(&buff, buff_data, sizeof(buff_data));
+lwrb_set_evt_fn(&buff, my_buff_evt_fn);
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_index.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_index.c
new file mode 100644
index 000000000..e1fd836fc
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_index.c
@@ -0,0 +1,20 @@
+/* Declare rb instance & raw data */
+lwrb_t buff;
+uint8_t buff_data[8];
+
+/* Application variables */
+uint8_t data[2];
+size_t len;
+
+/* Application code ... */
+lwrb_init(&buff, buff_data, sizeof(buff_data)); /* Initialize buffer */
+
+/* Write 4 bytes of data */
+lwrb_write(&buff, "0123", 4);
+
+/* Try to read buffer */
+/* len holds number of bytes read */
+/* Read until len == 0, when buffer is empty */
+while ((len = lwrb_read(&buff, data, sizeof(data))) > 0) {
+ printf("Successfully read %d bytes\r\n", (int)len);
+} \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_minimal.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_minimal.c
new file mode 100644
index 000000000..c2333088f
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_minimal.c
@@ -0,0 +1,19 @@
+#include "lwrb/lwrb.h"
+
+/* Declare rb instance & raw data */
+lwrb_t buff;
+uint8_t buff_data[8];
+
+/* Application variables */
+uint8_t data[2]; /* Application working data */
+
+/* Application code ... */
+lwrb_init(&buff, buff_data, sizeof(buff_data)); /* Initialize buffer */
+
+/* Write 4 bytes of data */
+lwrb_write(&buff, "0123", 4);
+
+/* Print number of bytes in buffer */
+printf("Bytes in buffer: %d\r\n", (int)lwrb_get_full(&buff));
+
+/* Will print "4" */ \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_skip_1.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_skip_1.c
new file mode 100644
index 000000000..ccce6ffbf
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_skip_1.c
@@ -0,0 +1,62 @@
+#include "lwrb/lwrb.h"
+
+/* Declare rb instance & raw data */
+lwrb_t buff;
+uint8_t buff_data[8];
+
+size_t len;
+uint8_t* data;
+
+/* Initialize buffer, use buff_data as data array */
+lwrb_init(&buff, buff_data, sizeof(buff_data));
+
+/* Use write, read operations, process data */
+/* ... */
+
+/* IMAGE PART A */
+
+/* At this stage, we have buffer as on image above */
+/* R = 5, W = 4, buffer is considered full */
+
+/* Get length of linear memory at read pointer */
+/* Function returns 3 as we can read 3 bytes from buffer in sequence */
+/* When function returns 0, there is no memory available in the buffer for read anymore */
+if ((len = lwrb_get_linear_block_read_length(&buff)) > 0) {
+ /* Get pointer to first element in linear block at read address */
+ /* Function returns &buff_data[5] */
+ data = lwrb_get_linear_block_read_address(&buff);
+
+ /* Send data via DMA and wait to finish (for sake of example) */
+ send_data(data, len);
+
+ /* Now skip sent bytes from buffer = move read pointer */
+ lwrb_skip(&buff, len);
+
+ /* Now R points to top of buffer, R = 0 */
+ /* At this point, we are at image part B */
+}
+
+/* IMAGE PART B */
+
+/* Get length of linear memory at read pointer */
+/* Function returns 4 as we can read 4 bytes from buffer in sequence */
+/* When function returns 0, there is no memory available in the buffer for read anymore */
+if ((len = lwrb_get_linear_block_read_length(&buff)) > 0) {
+ /* Get pointer to first element in linear block at read address */
+ /* Function returns &buff_data[0] */
+ data = lwrb_get_linear_block_read_address(&buff);
+
+ /* Send data via DMA and wait to finish (for sake of example) */
+ send_data(data, len);
+
+ /* Now skip sent bytes from buffer = move read pointer */
+ /* Read pointer is moved for len bytes */
+ lwrb_skip(&buff, len);
+
+ /* Now R points to 4, that is R == W and buffer is now empty */
+ /* At this point, we are at image part C */
+}
+
+/* IMAGE PART C */
+
+/* Buffer is considered empty as R == W */ \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_skip_2.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_skip_2.c
new file mode 100644
index 000000000..1ad8c34cb
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_skip_2.c
@@ -0,0 +1,21 @@
+/* Initialization part skipped */
+
+/* Get length of linear memory at read pointer */
+/* When function returns 0, there is no memory
+ available in the buffer for read anymore */
+while ((len = lwrb_get_linear_block_read_length(&buff)) > 0) {
+ /* Get pointer to first element in linear block at read address */
+ data = lwrb_get_linear_block_read_address(&buff);
+
+ /* If max length needs to be considered */
+ /* simply decrease it and use smaller len on skip function */
+ if (len > max_len) {
+ len = max_len;
+ }
+
+ /* Send data via DMA and wait to finish (for sake of example) */
+ send_data(data, len);
+
+ /* Now skip sent bytes from buffer = move read pointer */
+ lwrb_skip(&buff, len);
+} \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_thread_safety.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_thread_safety.c
new file mode 100644
index 000000000..5ffdee291
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_thread_safety.c
@@ -0,0 +1,47 @@
+/* Declare variables */
+lwrb_t rb;
+
+/* 2 mutexes, one for write operations,
+ one for read operations */
+mutex_t m_w, m_r;
+
+/* 4 threads below, 2 for write, 2 for read */
+void
+thread_write_1(void* arg) {
+ /* Use write mutex */
+ while (1) {
+ mutex_get(&m_w);
+ lwrb_write(&rb, ...);
+ mutex_give(&m_w);
+ }
+}
+
+void
+thread_write_2(void* arg) {
+ /* Use write mutex */
+ while (1) {
+ mutex_get(&m_w);
+ lwrb_write(&rb, ...);
+ mutex_give(&m_w);
+ }
+}
+
+void
+thread_read_1(void* arg) {
+ /* Use read mutex */
+ while (1) {
+ mutex_get(&m_r);
+ lwrb_read(&rb, ...);
+ mutex_give(&m_r);
+ }
+}
+
+void
+thread_read_2(void* arg) {
+ /* Use read mutex */
+ while (1) {
+ mutex_get(&m_r);
+ lwrb_read(&rb, ...);
+ mutex_give(&m_r);
+ }
+} \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_tt_buff_size.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_tt_buff_size.c
new file mode 100644
index 000000000..90c670798
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_tt_buff_size.c
@@ -0,0 +1,43 @@
+#include "lwrb/lwrb.h"
+
+/* Number of data blocks to write */
+#define N 3
+
+/* Create custom data structure */
+/* Data is array of 2 32-bit words, 8-bytes */
+uint32_t d[2];
+
+/* Create buffer structures */
+lwrb_t buff_1;
+lwrb_t buff_2;
+
+/* Create data for buffers. Use sizeof structure,
+ multiplied by N (for N instances) */
+/* Buffer with + 1 bytes bigger memory */
+uint8_t buff_data_1[sizeof(d) * N + 1];
+/* Buffer without + 1 at the end */
+uint8_t buff_data_2[sizeof(d) * N];
+
+/* Write result values */
+size_t len_1;
+size_t len_2;
+
+/* Initialize buffers */
+lwrb_init(&buff_1, buff_data_1, sizeof(buff_data_1));
+lwrb_init(&buff_2, buff_data_2, sizeof(buff_data_2));
+
+/* Write data to buffer */
+for (size_t i = 0; i < N; ++i) {
+ /* Prepare data */
+ d.a = i;
+ d.b = i * 2;
+
+ /* Write data to both buffers, memory copy from d to buffer */
+ len_1 = lwrb_write(&buff_1, d, sizeof(d));
+ len_2 = lwrb_write(&buff_2, d, sizeof(d));
+
+ /* Print results */
+ printf("Write buffer 1: %d/%d bytes; buffer 2: %d/%d\r\n",
+ (int)len_1, (int)sizeof(d),
+ (int)len_2, (int)sizeof(d));
+} \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/examples_src/example_tt_buff_size_log.c b/src/fluent-bit/lib/lwrb/docs/examples_src/example_tt_buff_size_log.c
new file mode 100644
index 000000000..a555f076d
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/examples_src/example_tt_buff_size_log.c
@@ -0,0 +1,3 @@
+Write: buffer 1: 8/8; buffer 2: 8/8
+Write: buffer 1: 8/8; buffer 2: 8/8
+Write: buffer 1: 8/8; buffer 2: 7/8 <-- See here --> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/get-started/index.rst b/src/fluent-bit/lib/lwrb/docs/get-started/index.rst
new file mode 100644
index 000000000..c3dd85155
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/get-started/index.rst
@@ -0,0 +1,77 @@
+.. _getting_started:
+
+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>`_.
+
+You can get it by:
+
+* Downloading latest release from `releases area <https://github.com/MaJerle/lwrb/releases>`_ on Github
+* Cloning ``main`` branch for latest stable version
+* Cloning ``develop`` branch for latest development
+
+Download from releases
+**********************
+
+All releases are available on Github `releases area <https://github.com/MaJerle/lwrb/releases>`_.
+
+Clone from Github
+*****************
+
+First-time clone
+""""""""""""""""
+
+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 options below
+
+ * Run ``git clone --recurse-submodules https://github.com/MaJerle/lwrb`` command to clone entire repository, including submodules
+ * Run ``git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwrb`` to clone `development` branch, including submodules
+ * Run ``git clone --recurse-submodules --branch main https://github.com/MaJerle/lwrb`` to clone `latest stable` branch, including submodules
+
+* Navigate to ``examples`` directory and run favourite example
+
+Update cloned to latest version
+"""""""""""""""""""""""""""""""
+
+* Open console and navigate to path in the system where your repository is located. Use command ``cd your_path``
+* Run ``git pull origin main`` command to get latest changes on ``main`` branch
+* Run ``git pull origin develop`` command to get latest changes on ``develop`` branch
+* Run ``git submodule update --init --remote`` to update submodules to latest version
+
+.. note::
+ This is preferred option to use when you want to evaluate library and run prepared examples.
+ Repository consists of multiple submodules which can be automatically downloaded when cloning and pulling changes from root repository.
+
+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, 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
+^^^^^^^^^^^^^^^^^^^^
+
+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: Absolute minimum example \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/index.rst b/src/fluent-bit/lib/lwrb/docs/index.rst
new file mode 100644
index 000000000..bc9c15c71
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/index.rst
@@ -0,0 +1,96 @@
+LwRB |version| documentation
+============================
+
+Welcome to the documentation for version |version|.
+
+LwRB is a generic *FIFO* (First In; First Out) buffer library optimized for embedded systems.
+
+.. image:: static/images/logo.svg
+ :align: center
+
+.. rst-class:: center
+.. rst-class:: index_links
+
+ :ref:`download_library` :ref:`getting_started` `Open Github <https://github.com/MaJerle/lwrb>`_ `Donate <https://paypal.me/tilz0R>`_
+
+Features
+^^^^^^^^
+
+* Written in ANSI C99, compatible with ``size_t`` for size data types
+* Platform independent, no architecture specific code
+* FIFO (First In First Out) buffer implementation
+* No dynamic memory allocation, data is static array
+* Uses optimized memory copy instead of loops to read/write data from/to memory
+* Thread safe when used as pipe with single write and single read entries
+* Interrupt safe when used as pipe with single write and single read entries
+* Suitable for DMA transfers from and to memory with zero-copy overhead between buffer and application memory
+* Supports data peek, skip for read and advance for write
+* Implements support for event notifications
+* User friendly MIT license
+
+Requirements
+^^^^^^^^^^^^
+
+* C compiler
+* Less than ``1kB`` of non-volatile memory
+
+Contribute
+^^^^^^^^^^
+
+Fresh contributions are always welcome. Simple instructions to proceed:
+
+#. Fork Github repository
+#. Respect `C style & coding rules <https://github.com/MaJerle/c-code-style>`_ used by the library
+#. Create a pull request to ``develop`` branch with new features or bug fixes
+
+Alternatively you may:
+
+#. Report a bug
+#. Ask for a feature request
+
+Example code
+^^^^^^^^^^^^
+
+Minimalistic example code to read and write data to buffer
+
+.. literalinclude:: examples_src/example_index.c
+ :language: c
+ :linenos:
+ :caption: Example code
+
+License
+^^^^^^^
+
+.. literalinclude:: ../LICENSE
+
+Table of contents
+^^^^^^^^^^^^^^^^^
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Contents
+
+ self
+ get-started/index
+ user-manual/index
+ tips-tricks/index
+ api-reference/index
+
+.. toctree::
+ :maxdepth: 2
+ :caption: Other projects
+ :hidden:
+
+ LwDTC - DateTimeCron <https://github.com/MaJerle/lwdtc>
+ LwESP - ESP-AT library <https://github.com/MaJerle/lwesp>
+ LwEVT - Event manager <https://github.com/MaJerle/lwevt>
+ LwGPS - GPS NMEA parser <https://github.com/MaJerle/lwgps>
+ LwGSM - GSM-AT library <https://github.com/MaJerle/lwgsm>
+ LwJSON - JSON parser <https://github.com/MaJerle/lwjson>
+ LwMEM - Memory manager <https://github.com/MaJerle/lwmem>
+ LwOW - OneWire with UART <https://github.com/MaJerle/lwow>
+ LwPKT - Packet protocol <https://github.com/MaJerle/lwpkt>
+ LwPRINTF - Printf <https://github.com/MaJerle/lwprintf>
+ LwRB - Ring buffer <https://github.com/MaJerle/lwrb>
+ LwSHELL - Shell <https://github.com/MaJerle/lwshell>
+ LwUTIL - Utility functions <https://github.com/MaJerle/lwutil> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/make.bat b/src/fluent-bit/lib/lwrb/docs/make.bat
new file mode 100644
index 000000000..922152e96
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/make.bat
@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.http://sphinx-doc.org/
+ exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/src/fluent-bit/lib/lwrb/docs/requirements.txt b/src/fluent-bit/lib/lwrb/docs/requirements.txt
new file mode 100644
index 000000000..834b1bbe4
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/requirements.txt
@@ -0,0 +1,8 @@
+breathe>=4.9.1
+colorama
+docutils==0.16
+sphinx>=3.5.1
+sphinx_rtd_theme>=1.0.0
+sphinx-tabs
+sphinxcontrib-svg2pdfconverter
+sphinx-sitemap
diff --git a/src/fluent-bit/lib/lwrb/docs/static/css/common.css b/src/fluent-bit/lib/lwrb/docs/static/css/common.css
new file mode 100644
index 000000000..c4957d591
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/css/common.css
@@ -0,0 +1,64 @@
+/* Center aligned text */
+.center {
+ text-align: center;
+}
+
+/* Paragraph with main links on index page */
+.index-links {
+ text-align: center;
+ margin-top: 10px;
+}
+.index-links a {
+ display: inline-block;
+ border: 1px solid #0E4263;
+ padding: 5px 20px;
+ margin: 2px 5px;
+ background: #2980B9;
+ border-radius: 4px;
+ color: #FFFFFF;
+}
+.index-links a:hover, .index-links a:active {
+ background: #0E4263;
+}
+
+/* Table header p w/0 margin */
+.index-links a table thead th {
+ vertical-align: middle;
+}
+
+table thead th p {
+ margin: 0;
+}
+
+.table-nowrap td {
+ white-space: normal !important;
+}
+
+/* Breathe output changes */
+.breathe-sectiondef.container {
+ background: #f9f9f9;
+ padding: 10px;
+ margin-bottom: 10px;
+ border: 1px solid #efefef;
+}
+.breathe-sectiondef.container .breathe-sectiondef-title {
+ background: #2980b9;
+ color: #FFFFFF;
+ padding: 4px;
+ margin: -10px -10px 0 -10px;
+}
+.breathe-sectiondef.container .function,
+.breathe-sectiondef.container .member,
+.breathe-sectiondef.container .class,
+.breathe-sectiondef.container .type {
+ border-bottom: 1px solid #efefef;
+}
+.breathe-sectiondef.container .function:last-child,
+.breathe-sectiondef.container .member:last-child,
+.breathe-sectiondef.container .class:last-child,
+.breathe-sectiondef.container .type:last-child {
+ border-bottom: none;
+ margin-bottom: 0;
+}
+
+/*# sourceMappingURL=common.css.map */
diff --git a/src/fluent-bit/lib/lwrb/docs/static/css/custom.css b/src/fluent-bit/lib/lwrb/docs/static/css/custom.css
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/css/custom.css
diff --git a/src/fluent-bit/lib/lwrb/docs/static/dark-light/checked.svg b/src/fluent-bit/lib/lwrb/docs/static/dark-light/checked.svg
new file mode 100644
index 000000000..a78af8286
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/dark-light/checked.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M0 0h24v24H0z" fill="none"/><path d="M19 3H5c-1.11 0-2 .9-2 2v14c0 1.1.89 2 2 2h14c1.11 0 2-.9 2-2V5c0-1.1-.89-2-2-2zm-9 14l-5-5 1.41-1.41L10 14.17l7.59-7.59L19 8l-9 9z"/></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/dark-light/common-dark-light.css b/src/fluent-bit/lib/lwrb/docs/static/dark-light/common-dark-light.css
new file mode 100644
index 000000000..9a2dc1ddc
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/dark-light/common-dark-light.css
@@ -0,0 +1,143 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+:root {
+ --heading-color: red;
+ --duration: 0.5s;
+ --timing: ease;
+}
+
+*,
+::before,
+::after {
+ box-sizing: border-box;
+}
+
+body {
+ margin: 0;
+ transition:
+ color var(--duration) var(--timing),
+ background-color var(--duration) var(--timing);
+ font-family: sans-serif;
+ font-size: 12pt;
+ background-color: var(--background-color);
+ color: var(--text-color);
+ display: flex;
+ justify-content: center;
+}
+
+main {
+ margin: 1rem;
+ max-width: 30rem;
+ position: relative;
+}
+
+h1 {
+ color: var(--heading-color);
+ text-shadow: 0.1rem 0.1rem 0.1rem var(--shadow-color);
+ transition: text-shadow var(--duration) var(--timing);
+}
+
+img {
+ max-width: 100%;
+ height: auto;
+ transition: filter var(--duration) var(--timing);
+}
+
+p {
+ line-height: 1.5;
+ word-wrap: break-word;
+ overflow-wrap: break-word;
+ hyphens: auto;
+}
+
+fieldset {
+ border: solid 0.1rem;
+ box-shadow: 0.1rem 0.1rem 0.1rem var(--shadow-color);
+ transition: box-shadow var(--duration) var(--timing);
+}
+
+div {
+ padding: 0.5rem;
+}
+
+aside {
+ position: absolute;
+ right: 0;
+ padding: 0.5rem;
+}
+
+aside:nth-of-type(1) {
+ top: 0;
+}
+
+aside:nth-of-type(2) {
+ top: 3rem;
+}
+
+aside:nth-of-type(3) {
+ top: 7rem;
+}
+
+aside:nth-of-type(4) {
+ top: 12rem;
+}
+
+#content select,
+#content button,
+#content input[type="text"],
+#content input[type="search"] {
+ width: 15rem;
+}
+
+dark-mode-toggle {
+ --dark-mode-toggle-remember-icon-checked: url("checked.svg");
+ --dark-mode-toggle-remember-icon-unchecked: url("unchecked.svg");
+ --dark-mode-toggle-remember-font: 0.75rem "Helvetica";
+ --dark-mode-toggle-legend-font: bold 0.85rem "Helvetica";
+ --dark-mode-toggle-label-font: 0.85rem "Helvetica";
+ --dark-mode-toggle-color: var(--text-color);
+ --dark-mode-toggle-background-color: none;
+
+ margin-bottom: 1.5rem;
+}
+
+#dark-mode-toggle-1 {
+ --dark-mode-toggle-dark-icon: url("sun.png");
+ --dark-mode-toggle-light-icon: url("moon.png");
+}
+
+#dark-mode-toggle-2 {
+ --dark-mode-toggle-dark-icon: url("sun.svg");
+ --dark-mode-toggle-light-icon: url("moon.svg");
+ --dark-mode-toggle-icon-size: 2rem;
+ --dark-mode-toggle-icon-filter: invert(100%);
+}
+
+#dark-mode-toggle-3,
+#dark-mode-toggle-4 {
+ --dark-mode-toggle-dark-icon: url("moon.png");
+ --dark-mode-toggle-light-icon: url("sun.png");
+}
+
+#dark-mode-toggle-3 {
+ --dark-mode-toggle-remember-filter: invert(100%);
+}
+
+#dark-mode-toggle-4 {
+ --dark-mode-toggle-active-mode-background-color: var(--accent-color);
+ --dark-mode-toggle-remember-filter: invert(100%);
+}
diff --git a/src/fluent-bit/lib/lwrb/docs/static/dark-light/dark-mode-toggle.mjs b/src/fluent-bit/lib/lwrb/docs/static/dark-light/dark-mode-toggle.mjs
new file mode 100644
index 000000000..da22262d0
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/dark-light/dark-mode-toggle.mjs
@@ -0,0 +1,329 @@
+/**
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// @license © 2019 Google LLC. Licensed under the Apache License, Version 2.0.
+const doc = document;
+const store = localStorage;
+const PREFERS_COLOR_SCHEME = 'prefers-color-scheme';
+const MEDIA = 'media';
+const LIGHT = 'light';
+const DARK = 'dark';
+const MQ_DARK = `(${PREFERS_COLOR_SCHEME}:${DARK})`;
+const MQ_LIGHT = `(${PREFERS_COLOR_SCHEME}:${LIGHT})`;
+const LINK_REL_STYLESHEET = 'link[rel=stylesheet]';
+const REMEMBER = 'remember';
+const LEGEND = 'legend';
+const TOGGLE = 'toggle';
+const SWITCH = 'switch';
+const APPEARANCE = 'appearance';
+const PERMANENT = 'permanent';
+const MODE = 'mode';
+const COLOR_SCHEME_CHANGE = 'colorschemechange';
+const PERMANENT_COLOR_SCHEME = 'permanentcolorscheme';
+const ALL = 'all';
+const NOT_ALL = 'not all';
+const NAME = 'dark-mode-toggle';
+const DEFAULT_URL = 'https://googlechromelabs.github.io/dark-mode-toggle/demo/';
+
+// See https://html.spec.whatwg.org/multipage/common-dom-interfaces.html ↵
+// #reflecting-content-attributes-in-idl-attributes.
+const installStringReflection = (obj, attrName, propName = attrName) => {
+ Object.defineProperty(obj, propName, {
+ enumerable: true,
+ get() {
+ const value = this.getAttribute(attrName);
+ return value === null ? '' : value;
+ },
+ set(v) {
+ this.setAttribute(attrName, v);
+ },
+ });
+};
+
+const installBoolReflection = (obj, attrName, propName = attrName) => {
+ Object.defineProperty(obj, propName, {
+ enumerable: true,
+ get() {
+ return this.hasAttribute(attrName);
+ },
+ set(v) {
+ if (v) {
+ this.setAttribute(attrName, '');
+ } else {
+ this.removeAttribute(attrName);
+ }
+ },
+ });
+};
+
+const template = doc.createElement('template');
+// ⚠️ Note: this is a minified version of `src/template-contents.tpl`.
+// Compress the CSS with https://cssminifier.com/, then paste it here.
+// eslint-disable-next-line max-len
+template.innerHTML = `<style>*,::after,::before{box-sizing:border-box}:host{contain:content;display:block}:host([hidden]){display:none}form{background-color:var(--${NAME}-background-color,transparent);color:var(--${NAME}-color,inherit);padding:0}fieldset{border:none;margin:0;padding-block:.25rem;padding-inline:.25rem}legend{font:var(--${NAME}-legend-font,inherit);padding:0}input,label{cursor:pointer}label{white-space:nowrap}input{opacity:0;position:absolute;pointer-events:none}input:focus-visible+label{outline:#e59700 auto 2px;outline:-webkit-focus-ring-color auto 5px}label:not(:empty)::before{margin-inline-end:.5rem;}label::before{content:"";display:inline-block;background-size:var(--${NAME}-icon-size,1rem);background-repeat:no-repeat;height:var(--${NAME}-icon-size,1rem);width:var(--${NAME}-icon-size,1rem);vertical-align:middle;}[part=lightLabel]::before{background-image:var(--${NAME}-light-icon, url("${DEFAULT_URL}sun.png"))}[part=darkLabel]::before{filter:var(--${NAME}-icon-filter, none);background-image:var(--${NAME}-dark-icon, url("${DEFAULT_URL}moon.png"))}[part=toggleLabel]::before{background-image:var(--${NAME}-checkbox-icon,none)}[part=permanentLabel]::before{background-image:var(--${NAME}-remember-icon-unchecked, url("${DEFAULT_URL}unchecked.svg"))}[part=darkLabel],[part=lightLabel],[part=toggleLabel]{font:var(--${NAME}-label-font,inherit)}[part=darkLabel]:empty,[part=lightLabel]:empty,[part=toggleLabel]:empty{font-size:0;padding:0}[part=permanentLabel]{font:var(--${NAME}-remember-font,inherit)}input:checked+[part=permanentLabel]::before{background-image:var(--${NAME}-remember-icon-checked, url("${DEFAULT_URL}checked.svg"))}input:checked+[part=darkLabel],input:checked+[part=lightLabel]{background-color:var(--${NAME}-active-mode-background-color,transparent)}input:checked+[part=darkLabel]::before,input:checked+[part=lightLabel]::before{background-color:var(--${NAME}-active-mode-background-color,transparent)}input:checked+[part=toggleLabel]::before{filter:var(--${NAME}-icon-filter, none)}input:checked+[part=toggleLabel]+aside [part=permanentLabel]::before{filter:var(--${NAME}-remember-filter, invert(100%))}aside{visibility:hidden;margin-block-start:.15rem}[part=darkLabel]:focus-visible~aside,[part=lightLabel]:focus-visible~aside,[part=toggleLabel]:focus-visible~aside{visibility:visible;transition:visibility 0s}aside [part=permanentLabel]:empty{display:none}@media (hover:hover){aside{transition:visibility 3s}aside:hover{visibility:visible}[part=darkLabel]:hover~aside,[part=lightLabel]:hover~aside,[part=toggleLabel]:hover~aside{visibility:visible;transition:visibility 0s}}</style><form part=form><fieldset part=fieldset><legend part=legend></legend><input part=lightRadio id=l name=mode type=radio><label part=lightLabel for=l></label><input part=darkRadio id=d name=mode type=radio><label part=darkLabel for=d></label><input part=toggleCheckbox id=t type=checkbox><label part=toggleLabel for=t></label><aside part=aside><input part=permanentCheckbox id=p type=checkbox><label part=permanentLabel for=p></label></aside></fieldset></form>`;
+
+export class DarkModeToggle extends HTMLElement {
+ static get observedAttributes() {
+ return [MODE, APPEARANCE, PERMANENT, LEGEND, LIGHT, DARK, REMEMBER];
+ }
+
+ constructor() {
+ super();
+
+ installStringReflection(this, MODE);
+ installStringReflection(this, APPEARANCE);
+ installStringReflection(this, LEGEND);
+ installStringReflection(this, LIGHT);
+ installStringReflection(this, DARK);
+ installStringReflection(this, REMEMBER);
+
+ installBoolReflection(this, PERMANENT);
+
+ this._darkCSS = null;
+ this._lightCSS = null;
+
+ doc.addEventListener(COLOR_SCHEME_CHANGE, (event) => {
+ this.mode = event.detail.colorScheme;
+ this._updateRadios();
+ this._updateCheckbox();
+ });
+
+ doc.addEventListener(PERMANENT_COLOR_SCHEME, (event) => {
+ this.permanent = event.detail.permanent;
+ this._permanentCheckbox.checked = this.permanent;
+ });
+
+ this._initializeDOM();
+ }
+
+ _initializeDOM() {
+ const shadowRoot = this.attachShadow({mode: 'open'});
+ shadowRoot.appendChild(template.content.cloneNode(true));
+
+ // We need to support `media="(prefers-color-scheme: dark)"` (with space)
+ // and `media="(prefers-color-scheme:dark)"` (without space)
+ this._darkCSS = doc.querySelectorAll(`${LINK_REL_STYLESHEET}[${MEDIA}*=${PREFERS_COLOR_SCHEME}][${MEDIA}*="${DARK}"]`);
+ this._lightCSS = doc.querySelectorAll(`${LINK_REL_STYLESHEET}[${MEDIA}*=${PREFERS_COLOR_SCHEME}][${MEDIA}*="${LIGHT}"]`);
+
+ // Get DOM references.
+ this._lightRadio = shadowRoot.querySelector('[part=lightRadio]');
+ this._lightLabel = shadowRoot.querySelector('[part=lightLabel]');
+ this._darkRadio = shadowRoot.querySelector('[part=darkRadio]');
+ this._darkLabel = shadowRoot.querySelector('[part=darkLabel]');
+ this._darkCheckbox = shadowRoot.querySelector('[part=toggleCheckbox]');
+ this._checkboxLabel = shadowRoot.querySelector('[part=toggleLabel]');
+ this._legendLabel = shadowRoot.querySelector('legend');
+ this._permanentAside = shadowRoot.querySelector('aside');
+ this._permanentCheckbox =
+ shadowRoot.querySelector('[part=permanentCheckbox]');
+ this._permanentLabel = shadowRoot.querySelector('[part=permanentLabel]');
+
+ // Does the browser support native `prefers-color-scheme`?
+ const hasNativePrefersColorScheme =
+ matchMedia(MQ_DARK).media !== NOT_ALL;
+ // Listen to `prefers-color-scheme` changes.
+ if (hasNativePrefersColorScheme) {
+ matchMedia(MQ_DARK).addListener(({matches}) => {
+ this.mode = matches ? DARK : LIGHT;
+ this._dispatchEvent(COLOR_SCHEME_CHANGE, {colorScheme: this.mode});
+ });
+ }
+ // Set initial state, giving preference to a remembered value, then the
+ // native value (if supported), and eventually defaulting to a light
+ // experience.
+ const rememberedValue = store.getItem(NAME);
+ if (rememberedValue && [DARK, LIGHT].includes(rememberedValue)) {
+ this.mode = rememberedValue;
+ this._permanentCheckbox.checked = true;
+ this.permanent = true;
+ } else if (hasNativePrefersColorScheme) {
+ this.mode = matchMedia(MQ_LIGHT).matches ? LIGHT : DARK;
+ }
+ if (!this.mode) {
+ this.mode = LIGHT;
+ }
+ if (this.permanent && !rememberedValue) {
+ store.setItem(NAME, this.mode);
+ }
+
+ // Default to toggle appearance.
+ if (!this.appearance) {
+ this.appearance = TOGGLE;
+ }
+
+ // Update the appearance to either of toggle or switch.
+ this._updateAppearance();
+
+ // Update the radios
+ this._updateRadios();
+
+ // Make the checkbox reflect the state of the radios
+ this._updateCheckbox();
+
+ // Synchronize the behavior of the radio and the checkbox.
+ [this._lightRadio, this._darkRadio].forEach((input) => {
+ input.addEventListener('change', () => {
+ this.mode = this._lightRadio.checked ? LIGHT : DARK;
+ this._updateCheckbox();
+ this._dispatchEvent(COLOR_SCHEME_CHANGE, {colorScheme: this.mode});
+ });
+ });
+ this._darkCheckbox.addEventListener('change', () => {
+ this.mode = this._darkCheckbox.checked ? DARK : LIGHT;
+ this._updateRadios();
+ this._dispatchEvent(COLOR_SCHEME_CHANGE, {colorScheme: this.mode});
+ });
+
+ // Make remembering the last mode optional
+ this._permanentCheckbox.addEventListener('change', () => {
+ this.permanent = this._permanentCheckbox.checked;
+ this._dispatchEvent(PERMANENT_COLOR_SCHEME, {
+ permanent: this.permanent,
+ });
+ });
+
+ // Finally update the mode and let the world know what's going on
+ this._updateMode();
+ this._dispatchEvent(COLOR_SCHEME_CHANGE, {colorScheme: this.mode});
+ this._dispatchEvent(PERMANENT_COLOR_SCHEME, {
+ permanent: this.permanent,
+ });
+ }
+
+ attributeChangedCallback(name, oldValue, newValue) {
+ if (name === MODE) {
+ if (![LIGHT, DARK].includes(newValue)) {
+ throw new RangeError(`Allowed values: "${LIGHT}" and "${DARK}".`);
+ }
+ // Only show the dialog programmatically on devices not capable of hover
+ // and only if there is a label
+ if (matchMedia('(hover:none)').matches && this.remember) {
+ this._showPermanentAside();
+ }
+ if (this.permanent) {
+ store.setItem(NAME, this.mode);
+ }
+ this._updateRadios();
+ this._updateCheckbox();
+ this._updateMode();
+ } else if (name === APPEARANCE) {
+ if (![TOGGLE, SWITCH].includes(newValue)) {
+ throw new RangeError(`Allowed values: "${TOGGLE}" and "${SWITCH}".`);
+ }
+ this._updateAppearance();
+ } else if (name === PERMANENT) {
+ if (this.permanent) {
+ store.setItem(NAME, this.mode);
+ } else {
+ store.removeItem(NAME);
+ }
+ this._permanentCheckbox.checked = this.permanent;
+ } else if (name === LEGEND) {
+ this._legendLabel.textContent = newValue;
+ } else if (name === REMEMBER) {
+ this._permanentLabel.textContent = newValue;
+ } else if (name === LIGHT) {
+ this._lightLabel.textContent = newValue;
+ if (this.mode === LIGHT) {
+ this._checkboxLabel.textContent = newValue;
+ }
+ } else if (name === DARK) {
+ this._darkLabel.textContent = newValue;
+ if (this.mode === DARK) {
+ this._checkboxLabel.textContent = newValue;
+ }
+ }
+ }
+
+ _dispatchEvent(type, value) {
+ this.dispatchEvent(new CustomEvent(type, {
+ bubbles: true,
+ composed: true,
+ detail: value,
+ }));
+ }
+
+ _updateAppearance() {
+ // Hide or show the light-related affordances dependent on the appearance,
+ // which can be "switch" or "toggle".
+ const appearAsToggle = this.appearance === TOGGLE;
+ this._lightRadio.hidden = appearAsToggle;
+ this._lightLabel.hidden = appearAsToggle;
+ this._darkRadio.hidden = appearAsToggle;
+ this._darkLabel.hidden = appearAsToggle;
+ this._darkCheckbox.hidden = !appearAsToggle;
+ this._checkboxLabel.hidden = !appearAsToggle;
+ }
+
+ _updateRadios() {
+ if (this.mode === LIGHT) {
+ this._lightRadio.checked = true;
+ } else {
+ this._darkRadio.checked = true;
+ }
+ }
+
+ _updateCheckbox() {
+ if (this.mode === LIGHT) {
+ this._checkboxLabel.style.setProperty(`--${NAME}-checkbox-icon`,
+ `var(--${NAME}-light-icon,url("${DEFAULT_URL}moon.png"))`);
+ this._checkboxLabel.textContent = this.light;
+ if (!this.light) {
+ this._checkboxLabel.ariaLabel = DARK;
+ }
+ this._darkCheckbox.checked = false;
+ } else {
+ this._checkboxLabel.style.setProperty(`--${NAME}-checkbox-icon`,
+ `var(--${NAME}-dark-icon,url("${DEFAULT_URL}sun.png"))`);
+ this._checkboxLabel.textContent = this.dark;
+ if (!this.dark) {
+ this._checkboxLabel.ariaLabel = LIGHT;
+ }
+ this._darkCheckbox.checked = true;
+ }
+ }
+
+ _updateMode() {
+ if (this.mode === LIGHT) {
+ this._lightCSS.forEach((link) => {
+ link.media = ALL;
+ link.disabled = false;
+ });
+ this._darkCSS.forEach((link) => {
+ link.media = NOT_ALL;
+ link.disabled = true;
+ });
+ } else {
+ this._darkCSS.forEach((link) => {
+ link.media = ALL;
+ link.disabled = false;
+ });
+ this._lightCSS.forEach((link) => {
+ link.media = NOT_ALL;
+ link.disabled = true;
+ });
+ }
+ }
+
+ _showPermanentAside() {
+ this._permanentAside.style.visibility = 'visible';
+ setTimeout(() => {
+ this._permanentAside.style.visibility = 'hidden';
+ }, 3000);
+ }
+}
+
+customElements.define(NAME, DarkModeToggle); \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/dark-light/dark.css b/src/fluent-bit/lib/lwrb/docs/static/dark-light/dark.css
new file mode 100644
index 000000000..6ed8cfb96
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/dark-light/dark.css
@@ -0,0 +1,36 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+:root {
+ color-scheme: dark; /* stylelint-disable-line property-no-unknown */
+
+ --background-color: rgb(15 15 15);
+ --text-color: rgb(240 240 240);
+ --shadow-color: rgb(240 240 240 / 50%);
+ --accent-color: rgb(0 0 240 / 50%);
+}
+
+img {
+ filter: grayscale(50%);
+}
+
+.icon {
+ filter: invert(100%);
+}
+
+a {
+ color: yellow;
+}
diff --git a/src/fluent-bit/lib/lwrb/docs/static/dark-light/light.css b/src/fluent-bit/lib/lwrb/docs/static/dark-light/light.css
new file mode 100644
index 000000000..f73cf7b1f
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/dark-light/light.css
@@ -0,0 +1,24 @@
+/**
+ * @license
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+:root {
+ color-scheme: light; /* stylelint-disable-line property-no-unknown */
+
+ --background-color: rgb(240 240 240);
+ --text-color: rgb(15 15 15);
+ --shadow-color: rgb(15 15 15 / 50%);
+ --accent-color: rgb(240 0 0 / 50%);
+}
diff --git a/src/fluent-bit/lib/lwrb/docs/static/dark-light/moon.png b/src/fluent-bit/lib/lwrb/docs/static/dark-light/moon.png
new file mode 100644
index 000000000..0ad57d900
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/dark-light/moon.png
Binary files differ
diff --git a/src/fluent-bit/lib/lwrb/docs/static/dark-light/moon.svg b/src/fluent-bit/lib/lwrb/docs/static/dark-light/moon.svg
new file mode 100644
index 000000000..fad89a4ea
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/dark-light/moon.svg
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 20 20">
+ <title>
+ moon
+ </title>
+ <path d="M17.39 15.14A7.33 7.33 0 0 1 11.75 1.6c.23-.11.56-.23.79-.34a8.19 8.19 0 0 0-5.41.45 9 9 0 1 0 7 16.58 8.42 8.42 0 0 0 4.29-3.84 5.3 5.3 0 0 1-1.03.69z"/>
+</svg>
diff --git a/src/fluent-bit/lib/lwrb/docs/static/dark-light/sun.png b/src/fluent-bit/lib/lwrb/docs/static/dark-light/sun.png
new file mode 100644
index 000000000..40c9b362b
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/dark-light/sun.png
Binary files differ
diff --git a/src/fluent-bit/lib/lwrb/docs/static/dark-light/sun.svg b/src/fluent-bit/lib/lwrb/docs/static/dark-light/sun.svg
new file mode 100644
index 000000000..0b18941cf
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/dark-light/sun.svg
@@ -0,0 +1,5 @@
+<?xml version="1.0"?>
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24">
+<path d="M18.1 5.1c0 .3-.1.6-.3.9l-1.4 1.4-.9-.8 2.2-2.2c.3.1.4.4.4.7zm-.5 5.3h3.2c0 .3-.1.6-.4.9s-.5.4-.8.4h-2v-1.3zm-6.2-5V2.2c.3 0 .6.1.9.4s.4.5.4.8v2h-1.3zm6.4 11.7c-.3 0-.6-.1-.8-.3l-1.4-1.4.8-.8 2.2 2.2c-.2.2-.5.3-.8.3zM6.2 4.9c.3 0 .6.1.8.3l1.4 1.4-.8.9-2.2-2.3c.2-.2.5-.3.8-.3zm5.2 11.7h1.2v3.2c-.3 0-.6-.1-.9-.4s-.4-.5-.4-.8l.1-2zm-7-6.2h2v1.2H3.2c0-.3.1-.6.4-.9s.5-.3.8-.3zM6.2 16l1.4-1.4.8.8-2.2 2.2c-.2-.2-.3-.5-.3-.8s.1-.6.3-.8z"/>
+<circle cx="12" cy="11" r="4"/>
+</svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/dark-light/unchecked.svg b/src/fluent-bit/lib/lwrb/docs/static/dark-light/unchecked.svg
new file mode 100644
index 000000000..67023305b
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/dark-light/unchecked.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24"><path d="M19 5v14H5V5h14m0-2H5c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h14c1.1 0 2-.9 2-2V5c0-1.1-.9-2-2-2z"/><path d="M0 0h24v24H0z" fill="none"/></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_cases.svg b/src/fluent-bit/lib/lwrb/docs/static/images/buff_cases.svg
new file mode 100644
index 000000000..0461714df
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_cases.svg
@@ -0,0 +1,2 @@
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="501px" height="192px" viewBox="-0.5 -0.5 501 192" content="&lt;mxfile modified=&quot;2019-04-07T14:13:16.633Z&quot; host=&quot;www.draw.io&quot; agent=&quot;Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/7.8.7 Chrome/58.0.3029.110 Electron/1.7.5 Safari/537.36&quot; etag=&quot;HoWZY1gL1nGTm-rvHcic&quot; version=&quot;10.6.0&quot; type=&quot;device&quot;&gt;&lt;diagram id=&quot;HtfmYNPGudO8xS3rMpZ1&quot; name=&quot;Page-1&quot;&gt;7ZxNc6JAEIZ/DcdUCcMMeIwas3vYy6ZqU7uXLQKjUEHHRYxmf/3yMSjSWpWtBHrI4MHCHuSjH3q631YwyHR1uE+8TfhNBDw2rFFwMMjMsKwxM7P33PBaGhiVhmUSBaWpZniI/nJpHEnrLgr49mzFVIg4jTbnRl+s19xPz2xekoj9+WoLEZ/vdeMtOTA8+F4MrY9RkIbSarLxaeALj5ah3LVrOeXAk+c/LxOxW8v9GRZZFK9yeOVV25Inug29QOxrJnJnkGkiRFourQ5THueurdxWfm9+ZfR43Alfp2/5wtfJ7JfnRL8PP/f3u5C8hOmP+Y1Dys28ePFOOuS7PNz0tXJRcZI838zIIJN9GKX8YeP5+eg+uyYyW5iu4uyTmS0uxDqVlM189UUUx1MRi6TYFvF9TjMXkck2TcQzr43MzfF0PD6OVDCO25THc+G8pemFJyk/1EzSD/dcrHiavGaryFHblkzkNWu68vP+dAVU2MIa+8rmyWtuedzyye/ZgnT9/2CwAYZHw2Jxtt/JU5ItLfOlVsEsFr5fcz8OGGo1wNjIYGwIRoP4MBvxgR0eNh3Co3CwpRYXqmX2sBSLDjokj2KUNJMHQwbDtAwPolh4sCE8yqK3ER5Hj2OBqS4MvcKDqqY9XBNg0DI+mGrpA2YPs86lBoP92eVdhMIlN9vCz7fZCuZocyjQVePtwIRormNsgJ8WrzYUDGvAHEGYrFOYLqBpaYjhQs7pFsMYYCAaYrjQVukUgw1TP9MPg4U9Kdkw9VP9MFyqwLrFYAEMtoYYLtRb3WKABZejH4ZLsrBTDHBOGr2fwtxbRXF+hrdJ5MU9RYM+TzGARk1F0gAUUO4GNnbXWDVFYjuA5gcrkl5gwJ7ubCgMP1iR9AIDuiKBwlADRdLEgK5IKBSGGigSEA3YmZ7CIkwDRQIwYCsSCoWhBooETErYKZrCv590IUn6kLfRJ6pBkrzjl3rVJAnVUpIADOjznZaSBGDAliS0dUnSBwzokqTaWXuSpA8Y0CUJa12S9AIDtiRhQy18jQ16hAy18Dv+HalaLcy0rIUBBuxamLVeC6vYggEYsGthpmUt3MSAXgs7WtbCIBqwM72jZXseYMCuhR0LYPjg9nwfogG9Pe8MkuQaG+yJirUeISpOVKCFhR4hUBlqcA/I8eqvMFCIodunPEBJd/v5MZjKYYCSbvr5MRDlMEBJN/v8GGzVMLgwRQ9dwzffzKta19CF9zBo0DUEGLALLhc+c0CDX9ABBuyuoQuVoQZdwyYG9K6hC+WHBl1DEA3YYtyF8kODriHAgN01dKH80KBrCCYl9BQN5YeuXcMmG+yJagx/ZbrTYKLqThlmH0/PnS3Gas/2JXf/AA==&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><rect x="300" y="100" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(306.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="380" y="60" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(385.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="0" y="0" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(6.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="80" y="0" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(85.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="100" y="0" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(106.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="180" y="80" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(185.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="200" y="0" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(206.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="280" y="140" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(285.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="400" y="100" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(406.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="480" y="80" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(485.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="20" y="20" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="20" y="40" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="20" y="60" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="20" y="120" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="20" y="100" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="20" y="80" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="20" y="140" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="20" y="0" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="120" y="20" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="120" y="40" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="120" y="60" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="120" y="120" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="120" y="100" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="120" y="80" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="120" y="140" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="120" y="0" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="220" y="20" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="220" y="40" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="220" y="60" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="220" y="120" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="220" y="100" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="220" y="80" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="220" y="0" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="320" y="20" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(346.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="320" y="40" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(346.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="320" y="60" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(346.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="320" y="120" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(346.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="320" y="100" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(346.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="320" y="80" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(346.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="320" y="140" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(346.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="320" y="0" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(346.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="220" y="140" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="140" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">B</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">B</text></switch></g><rect x="40" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">A</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">A</text></switch></g><rect x="240" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">C</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">C</text></switch></g><rect x="340" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(346.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">D</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">D</text></switch></g><rect x="420" y="20" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(446.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="420" y="40" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(446.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="420" y="60" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(446.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="420" y="120" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(446.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="420" y="100" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(446.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="420" y="80" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(446.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="420" y="140" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(446.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="420" y="0" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(446.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="440" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(446.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">E</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">E</text></switch></g></g></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_cases.xml b/src/fluent-bit/lib/lwrb/docs/static/images/buff_cases.xml
new file mode 100644
index 000000000..3d75a5318
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_cases.xml
@@ -0,0 +1 @@
+<mxfile modified="2019-04-07T14:12:41.718Z" host="www.draw.io" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/7.8.7 Chrome/58.0.3029.110 Electron/1.7.5 Safari/537.36" etag="ChBLjDSEV2RB_HJn-Kfc" version="10.6.0" type="device"><diagram id="HtfmYNPGudO8xS3rMpZ1" name="Page-1">7ZxNc6JAEIZ/DcdUCcMMeIwas3vYy6ZqU7uXLQKjUEHHRYxmf/3yMSjSWpWtBHrI4MHCHuSjH3q631YwyHR1uE+8TfhNBDw2rFFwMMjMsKwxM7P33PBaGhiVhmUSBaWpZniI/nJpHEnrLgr49mzFVIg4jTbnRl+s19xPz2xekoj9+WoLEZ/vdeMtOTA8+F4MrY9RkIbSarLxaeALj5ah3LVrOeXAk+c/LxOxW8v9GRZZFK9yeOVV25Inug29QOxrJnJnkGkiRFourQ5THueurdxWfm9+ZfR43Alfp2/5wtfJ7JfnRL8PP/f3u5C8hOmP+Y1Dys28ePFOOuS7PNz0tXJRcZI838zIIJN9GKX8YeP5+eg+uyYyW5iu4uyTmS0uxDqVlM189UUUx1MRi6TYFvF9TjMXkck2TcQzr43MzfF0PD6OVDCO25THc+G8pemFJyk/1EzSD/dcrHiavGaryFHblkzkNWu68vP+dAVU2MIa+8rmyWtuedzyye/ZgnT9/2CwAYZHw2Jxtt/JU5ItLfOlVsEsFr5fcz8OGGo1wNjIYGwIRoP4MBvxgR0eNh3Co3CwpRYXqmX2sBSLDjokj2KUNJMHQwbDtAwPolh4sCE8yqK3ER5Hj2OBqS4MvcKDqqY9XBNg0DI+mGrpA2YPs86lBoP92eVdhMIlN9vCz7fZCuZocyjQVePtwIRormNsgJ8WrzYUDGvAHEGYrFOYLqBpaYjhQs7pFsMYYCAaYrjQVukUgw1TP9MPg4U9Kdkw9VP9MFyqwLrFYAEMtoYYLtRb3WKABZejH4ZLsrBTDHBOGr2fwtxbRXF+hrdJ5MU9RYM+TzGARk1F0gAUUO4GNnbXWDVFYjuA5gcrkl5gwJ7ubCgMP1iR9AIDuiKBwlADRdLEgK5IKBSGGigSEA3YmZ7CIkwDRQIwYCsSCoWhBooETErYKZrCv590IUn6kLfRJ6pBkrzjl3rVJAnVUpIADOjznZaSBGDAliS0dUnSBwzokqTaWXuSpA8Y0CUJa12S9AIDtiRhQy18jQ16hAy18Dv+HalaLcy0rIUBBuxamLVeC6vYggEYsGthpmUt3MSAXgs7WtbCIBqwM72jZXseYMCuhR0LYPjg9nwfogG9Pe8MkuQaG+yJirUeISpOVKCFhR4hUBlqcA/I8eqvMFCIodunPEBJd/v5MZjKYYCSbvr5MRDlMEBJN/v8GGzVMLgwRQ9dwzffzKta19CF9zBo0DUEGLALLhc+c0CDX9ABBuyuoQuVoQZdwyYG9K6hC+WHBl1DEA3YYtyF8kODriHAgN01dKH80KBrCCYl9BQN5YeuXcMmG+yJagx/ZbrTYKLqThlmH0/PnS3Gas/2JXf/AA==</diagram></mxfile> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_read_skip.svg b/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_read_skip.svg
new file mode 100644
index 000000000..647803431
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_read_skip.svg
@@ -0,0 +1,2 @@
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="302px" height="191px" viewBox="-0.5 -0.5 302 191" content="&lt;mxfile modified=&quot;2019-04-07T14:06:13.796Z&quot; host=&quot;www.draw.io&quot; agent=&quot;Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/7.8.7 Chrome/58.0.3029.110 Electron/1.7.5 Safari/537.36&quot; etag=&quot;Mfk5XVPxX1lWOlmA6YkX&quot; version=&quot;10.6.0&quot; type=&quot;device&quot;&gt;&lt;diagram id=&quot;H2Awghl36DGLnOgT-CbG&quot; name=&quot;Page-1&quot;&gt;7VvLbqMwFP0alpWwDZQsG/qSRpGidtHHZkTBBFQnzhBnQubrh4edkNxU09EUTN1hEZlrx8bnXIzPSbBIMC9u8nCZTnhMmYXtuLDIpYUxcf3yswpsm4Dr2U1glmdxE0L7wH32i8qgarbOYro6aCg4ZyJbHgYjvljQSBzEwjznm8NmCWeHoy7DGQWB+yhkMPqQxSKVUeSN9hW3NJulcmgfnzcVL2H0Osv5eiHHszBJ6qOpnoeqLznRVRrGfNMKkSuLBDnnoinNi4CyCloFW/O96zdqd9ed04V4zxe28dofrZ+L6ZOYTsbf2eOteD6TvfwM2VricSevVmwVQvUcadWLbZHxJs0EvV+GUVW7KVOijKVizsozVBYTvhCSZFQ1TzLGAs54XvdFooi6JUJkvBI5f6Wtmms0CkYj1YMc/cQk1RXTXNCiFZKTvqF8TkW+LZuoWpWQMkGRL883e7oVR2mLaBULZYLNdj3vQS4LEue/wBwDzB8s7LFy2PFLXpZmValTFpIkimqs+2MBO0cseJpZIIAF1GahBb33Y13dozUkZ6sa1YuyAbKXRU2Uqu+Futilfuz0ewP5R9TZkDqvT+ocQB02HnOsGXMXYE6Mx9zRjLkHMPdMxxzrXlvOAeau6Zif2hD1irkPMHc+FvP3YgvYCepj90z/WNhP7IB6hX0EYD83PdWx7seoUr0t0O1/B/06nGesmuJFnoXsUzChe81BUPledJr9u6WkR81lH2W/q1lzISh9jbMbsPfHRO8Xcyh0v4DdQIZmNyAoWv/7DW/cQUPzGxAUv8YZDgB07TslqH6NcxwA6LodBwTlb7eWg45d0dAsBwT1b7eewwBA1+45IKh+TTQdAO66TQfVcW+uwwCSXbvrgKHY/RquwzETulcdtW9sEdHt9l1D9pOhuQ4YKmDjXAdy/CcH3XoXQ737BWwHZ2i2A4bS9VPYDjrWraHZDhgq4G5thyGArn2rBBVwt7bDEEDXbTtgqICNsx2OQdduO2CogI2zHUCm6xYABMpfE20HgLtu24FABWyc7QBWGN3PUgLVrgbbYQBMaF91oAIOehZjGlhwNBoR3ybu5dkVWhXTu0f+xJPpZLI69feHIW5zAMIneBjCryvl6f7tmbqu9YYSufoN&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><rect x="0" y="100" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(5.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="80" y="80" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(84.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="20" y="20" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="20" y="40" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="20" y="60" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="20" y="120" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="20" y="100" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="20" y="80" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="20" y="140" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="20" y="0" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="40" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(45.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">A</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">A</text></switch></g><rect x="100" y="0" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(105.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="180" y="80" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(184.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="120" y="20" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="120" y="40" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="120" y="60" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="120" y="120" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="120" y="100" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="120" y="80" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="120" y="140" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="120" y="0" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="140" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(145.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">B</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">B</text></switch></g><rect x="200" y="80" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(205.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="280" y="80" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(284.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="220" y="20" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="220" y="40" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="220" y="60" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="220" y="120" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="220" y="100" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="220" y="80" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="220" y="140" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="220" y="0" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="240" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(245.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">C<br /></div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="120" y="120" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g></g></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_read_skip.xml b/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_read_skip.xml
new file mode 100644
index 000000000..82d2c713b
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_read_skip.xml
@@ -0,0 +1 @@
+<mxfile modified="2019-04-07T14:06:28.462Z" host="www.draw.io" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/7.8.7 Chrome/58.0.3029.110 Electron/1.7.5 Safari/537.36" etag="qhFJ-tthuZkL3qDfSqvM" version="10.6.0" type="device"><diagram id="H2Awghl36DGLnOgT-CbG" name="Page-1">7VvLbqMwFP0alpWwDZQsG/qSRpGidtHHZkTBBFQnzhBnQubrh4edkNxU09EUTN1hEZlrx8bnXIzPSbBIMC9u8nCZTnhMmYXtuLDIpYUxcf3yswpsm4Dr2U1glmdxE0L7wH32i8qgarbOYro6aCg4ZyJbHgYjvljQSBzEwjznm8NmCWeHoy7DGQWB+yhkMPqQxSKVUeSN9hW3NJulcmgfnzcVL2H0Osv5eiHHszBJ6qOpnoeqLznRVRrGfNMKkSuLBDnnoinNi4CyCloFW/O96zdqd9ed04V4zxe28dofrZ+L6ZOYTsbf2eOteD6TvfwM2VricSevVmwVQvUcadWLbZHxJs0EvV+GUVW7KVOijKVizsozVBYTvhCSZFQ1TzLGAs54XvdFooi6JUJkvBI5f6Wtmms0CkYj1YMc/cQk1RXTXNCiFZKTvqF8TkW+LZuoWpWQMkGRL883e7oVR2mLaBULZYLNdj3vQS4LEue/wBwDzB8s7LFy2PFLXpZmValTFpIkimqs+2MBO0cseJpZIIAF1GahBb33Y13dozUkZ6sa1YuyAbKXRU2Uqu+Futilfuz0ewP5R9TZkDqvT+ocQB02HnOsGXMXYE6Mx9zRjLkHMPdMxxzrXlvOAeau6Zif2hD1irkPMHc+FvP3YgvYCepj90z/WNhP7IB6hX0EYD83PdWx7seoUr0t0O1/B/06nGesmuJFnoXsUzChe81BUPledJr9u6WkR81lH2W/q1lzISh9jbMbsPfHRO8Xcyh0v4DdQIZmNyAoWv/7DW/cQUPzGxAUv8YZDgB07TslqH6NcxwA6LodBwTlb7eWg45d0dAsBwT1b7eewwBA1+45IKh+TTQdAO66TQfVcW+uwwCSXbvrgKHY/RquwzETulcdtW9sEdHt9l1D9pOhuQ4YKmDjXAdy/CcH3XoXQ737BWwHZ2i2A4bS9VPYDjrWraHZDhgq4G5thyGArn2rBBVwt7bDEEDXbTtgqICNsx2OQdduO2CogI2zHUCm6xYABMpfE20HgLtu24FABWyc7QBWGN3PUgLVrgbbYQBMaF91oAIOehZjGlhwNBoR3ybu5dkVWhXTu0f+xJPpZLI69feHIW5zAMIneBjCryvl6f7tmbqu9YYSufoN</diagram></mxfile> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_write_advance.svg b/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_write_advance.svg
new file mode 100644
index 000000000..951273505
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_write_advance.svg
@@ -0,0 +1,2 @@
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="301px" height="191px" viewBox="-0.5 -0.5 301 191" content="&lt;mxfile modified=&quot;2019-04-07T14:13:36.485Z&quot; host=&quot;www.draw.io&quot; agent=&quot;Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/7.8.7 Chrome/58.0.3029.110 Electron/1.7.5 Safari/537.36&quot; version=&quot;10.6.0&quot; etag=&quot;iZML-jSz4qVqWOg8aJG9&quot; type=&quot;device&quot;&gt;&lt;diagram id=&quot;c8f9f407-d7f0-a069-7240-1bffae08de81&quot; name=&quot;Page-1&quot;&gt;7ZvPc6IwFID/Go47QxKgemzZ2r3sZXvomUIEptG4MVbdv375kSj6cLYzuzxsXA8deEmI+V4I+QbrsXixe1LJqvguMy486mc7j331KA2YX/2tA/s2EN2RNpCrMmtDncBz+YuboGmXb8qMr08qaimFLlenwVQulzzVJ7FEKbk9rTaX4rTXVZJzEHhOEwGjL2WmizY6Cf1j/Bsv88L2THxT8pqkb7mSm6Xpz6Ns3nza4kVir2Xqr4skk9tOiD16LFZS6vZosYu5qNFabG272YXSw/dWfKk/0oC2Dd4TsTFD/2G+mN5bGM1weN3A99jDtig1f14laV26rbJfxQq9ENUZqQ7ncqlNPkldfV4KEUshVXMtlqY8rGCwh7VW8o13SmZkGk+n9gqm957xmNA7V5rvOiEzvicuF1yrfVXFlkaG9f7sfHvMrE1H0UmqjSVmLuWHKx95VgcGaT9eBvC+eDQSVQ8Pr6o6yuujQYHP52naYMUDToPxgAcAOOkC71COfm7qm6wZ/Zd1A/C+qkD81a7JiS1HyVLcfHBvi8lZlnyYpWigLIUgS9R5vBQPbwTwMufxBnh47wDeyHW8FHFxmAC8oet4D+cIeKcAb/Bv8X4U4+VEDEG4Zw8yFGErMR3Ed67PYIr4eCME8PX/nu8sWZSiHs29KhPxKaAjrhoEiuK9a3P68JCzczqEfIfyFgJN0TkRpyOKOIFieAMmzoI/LhiDAYeO99/EL9wXI5o4ga7onIoDvph7FSiLzrk44Ivo4gTa4rAynoV8kgWj8sWUcQJ1cVgbvwK+mDZurzGcjl8hX0QXp9AVh3XxK+CL6eJ2t3BzLn4OHXPNgK7o3J6YjejiPS8RnXNxNqKL97z+uwEXD87fivfskgcjDi3vU8j4CA9TNqKM97xZHFbGr4Ev5mYFyqJzMg74Isp4z7tF52T8nC+mjNtfVbos42D+Im6sGZRF52Qc8EWUcQZl0TkZB+sD4vONQTEcQcavADrmmgFlMUaWmRF2GQGenlenx5/DN2Wdfzlgj78B&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><rect x="0" y="80" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(6.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="80" y="80" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(85.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="20" y="20" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="20" y="40" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="20" y="60" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="20" y="120" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="20" y="100" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="20" y="80" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="20" y="140" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="20" y="0" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="40" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(46.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">A</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">A</text></switch></g><rect x="100" y="80" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(106.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="180" y="0" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(185.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="120" y="20" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="120" y="40" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="120" y="60" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="120" y="120" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="120" y="100" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="120" y="80" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="120" y="140" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="120" y="0" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="140" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(146.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">B</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">B</text></switch></g><rect x="200" y="80" width="20" height="20" fill="#cce5ff" stroke="#f19c99" pointer-events="none"/><g transform="translate(206.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">R</div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">R</text></switch></g><rect x="280" y="60" width="20" height="20" fill="#ffcc99" stroke="#f19c99" pointer-events="none"/><g transform="translate(285.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="9" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 10px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">W<br /></div></div></foreignObject><text x="5" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="220" y="20" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,24.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">1<br style="font-size: 10px" /></div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g><rect x="220" y="40" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,44.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">2</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">2</text></switch></g><rect x="220" y="60" width="60" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,64.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">3</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">3</text></switch></g><rect x="220" y="120" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,124.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">6</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">6</text></switch></g><rect x="220" y="100" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,104.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">5</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">5</text></switch></g><rect x="220" y="80" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,84.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">4</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">4</text></switch></g><rect x="220" y="140" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,144.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">7</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">7</text></switch></g><rect x="220" y="0" width="60" height="20" fill="#d5e8d4" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,4.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="6" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Arial; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 7px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">0</div></div></foreignObject><text x="3" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Arial" font-weight="bold">0</text></switch></g><rect x="240" y="170" width="20" height="20" fill="#cccccc" stroke="#f19c99" pointer-events="none"/><g transform="translate(246.5,174.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="7" height="10" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 10px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 8px; white-space: nowrap; word-wrap: normal; font-weight: bold; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;">C<br /></div></div></foreignObject><text x="4" y="10" fill="#000000" text-anchor="middle" font-size="10px" font-family="Helvetica" font-weight="bold">[Not supported by viewer]</text></switch></g></g></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_write_advance.xml b/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_write_advance.xml
new file mode 100644
index 000000000..a70faf0c5
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_lin_write_advance.xml
@@ -0,0 +1 @@
+<mxfile modified="2019-04-07T14:05:39.498Z" host="www.draw.io" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/7.8.7 Chrome/58.0.3029.110 Electron/1.7.5 Safari/537.36" version="10.6.0" etag="9Ql-lOCbt-RKsAaah9gV" type="device"><diagram id="c8f9f407-d7f0-a069-7240-1bffae08de81" name="Page-1">7ZvPc6IwFID/Go47QxKgemzZ2r3sZXvomUIEptG4MVbdv375kSj6cLYzuzxsXA8deEmI+V4I+QbrsXixe1LJqvguMy486mc7j331KA2YX/2tA/s2EN2RNpCrMmtDncBz+YuboGmXb8qMr08qaimFLlenwVQulzzVJ7FEKbk9rTaX4rTXVZJzEHhOEwGjL2WmizY6Cf1j/Bsv88L2THxT8pqkb7mSm6Xpz6Ns3nza4kVir2Xqr4skk9tOiD16LFZS6vZosYu5qNFabG272YXSw/dWfKk/0oC2Dd4TsTFD/2G+mN5bGM1weN3A99jDtig1f14laV26rbJfxQq9ENUZqQ7ncqlNPkldfV4KEUshVXMtlqY8rGCwh7VW8o13SmZkGk+n9gqm957xmNA7V5rvOiEzvicuF1yrfVXFlkaG9f7sfHvMrE1H0UmqjSVmLuWHKx95VgcGaT9eBvC+eDQSVQ8Pr6o6yuujQYHP52naYMUDToPxgAcAOOkC71COfm7qm6wZ/Zd1A/C+qkD81a7JiS1HyVLcfHBvi8lZlnyYpWigLIUgS9R5vBQPbwTwMufxBnh47wDeyHW8FHFxmAC8oet4D+cIeKcAb/Bv8X4U4+VEDEG4Zw8yFGErMR3Ed67PYIr4eCME8PX/nu8sWZSiHs29KhPxKaAjrhoEiuK9a3P68JCzczqEfIfyFgJN0TkRpyOKOIFieAMmzoI/LhiDAYeO99/EL9wXI5o4ga7onIoDvph7FSiLzrk44Ivo4gTa4rAynoV8kgWj8sWUcQJ1cVgbvwK+mDZurzGcjl8hX0QXp9AVh3XxK+CL6eJ2t3BzLn4OHXPNgK7o3J6YjejiPS8RnXNxNqKL97z+uwEXD87fivfskgcjDi3vU8j4CA9TNqKM97xZHFbGr4Ev5mYFyqJzMg74Isp4z7tF52T8nC+mjNtfVbos42D+Im6sGZRF52Qc8EWUcQZl0TkZB+sD4vONQTEcQcavADrmmgFlMUaWmRF2GQGenlenx5/DN2Wdfzlgj78B</diagram></mxfile> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_main_irq_write.svg b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_main_irq_write.svg
new file mode 100644
index 000000000..74b6c9c92
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_main_irq_write.svg
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="371px" height="101px" viewBox="-0.5 -0.5 371 101" content="&lt;mxfile host=&quot;Electron&quot; modified=&quot;2020-07-12T09:41:00.755Z&quot; agent=&quot;Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36&quot; etag=&quot;XVfJHSJ8wbVWtuzF_fyL&quot; version=&quot;12.3.2&quot; type=&quot;device&quot; pages=&quot;1&quot;&gt;&lt;diagram id=&quot;-rsuYHbGqsa_XvOsthcc&quot; name=&quot;Page-1&quot;&gt;7ZfbcpswEIafhst0DAJMLoMPaSbJ9OBpYl/KaG00lZFHyKc8fUWQOBg8dlrXnTa9Cvtrd0Hf/hHYQr3F9lbgZfzICTDL6ZCthfqW49idrqv+ZMouV649LxfmghKdVAoj+gKmUqsrSiCtJUrOmaTLuhjxJIFI1jQsBN/U02ac1e+6xHNoCKMIs6b6TImMczXwOqX+Eeg8Nne2O3plgU2yFtIYE76pSGhgoZ7gXOZXi20PWAbPcMnrhgdWiwcTkMhTCtDtE0mGwd14PAsfnkYvchxOrnSXNWYrvWH9sHJnCAi+SghkTToWCjcxlTBa4ihb3aiZKy2WC6YiW13OKGM9zrhQccITlRQSnMav5dl6KgX/DibDctDgxg99X63oBwEhYXtwh3bBTRkO+AKk2KkUU+Br1NprjpnFppyc7Wotrk7NJGLtlnnRuwSqLjTTdr5fBBqKKzF5uO+tP02u7/s4/NbC9xHTRCmM8+X5UCuQBEMwi9oQ+1EA01mBuMGzhfphxN09xHYLYqcFsfu7CDsNwneJBCFWS5kfC2pn8l8g7f1p0qhB+mt4XrAeBMRtAxs4U1Q5JX4JLLL3wKIm2OCSXN2LnRGzIIKo1bnTwHO9znkAuycAvqxzveNvOUjITfa5oKKI4TSlUZ2kwiF2Y039NZhkwQfPhP1tdbG/M9GWyrHpoa4rVSoqi7LA1BycQcpXIoLjrxuJxRzk8X9lILWPn+ZEKxPzWgZmNAEMS7qufzK1TVHf4TOniawcdV7dMKi7Z4R837qq+omz16h44ZtGzl6jHEyj0aupim3/vM/89+Iz56/0WXGs7x9Mb/VZ4SvTyL+sz7rvxWfoRJ+5/332Np+psPzlmaeXv9/R4Ac=&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><rect x="0" y="0" width="140" height="100" fill="none" stroke="#ea6b66" stroke-dasharray="3 3" pointer-events="all"/><rect x="10" y="10" width="120" height="40" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/><g transform="translate(43.5,23.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="52" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 53px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Main loop</div></div></foreignObject><text x="26" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Main loop</text></switch></g><rect x="10" y="50" width="120" height="40" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/><g transform="translate(26.5,63.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="87" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 87px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Interrupt context</div></div></foreignObject><text x="44" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Interrupt context</text></switch></g><rect x="150" y="30" width="80" height="40" fill="#d5e8d4" stroke="#82b366" pointer-events="all"/><g transform="translate(181.5,43.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="17" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 18px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">RB</div></div></foreignObject><text x="9" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">RB</text></switch></g><rect x="250" y="30" width="120" height="40" fill="#f8cecc" stroke="#b85450" pointer-events="all"/><g transform="translate(283.5,43.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="52" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 53px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Main loop</div></div></foreignObject><text x="26" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Main loop</text></switch></g><path d="M 130 30 L 145.5 45.5" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 149.21 49.21 L 141.78 46.73 L 145.5 45.5 L 146.73 41.78 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 130 70 L 145.5 54.5" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 149.21 50.79 L 146.73 58.22 L 145.5 54.5 L 141.78 53.27 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 230 50 L 243.63 50" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 248.88 50 L 241.88 53.5 L 243.63 50 L 241.88 46.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/></g></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_main_irq_write.xml b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_main_irq_write.xml
new file mode 100644
index 000000000..c946a6a90
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_main_irq_write.xml
@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2020-07-12T09:40:52.011Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36" etag="j1j50cUtcakPpFB5q8eu" version="12.3.2" type="device" pages="1"><diagram id="-rsuYHbGqsa_XvOsthcc" name="Page-1">7ZfbcpswEIafhst0DAJMLoMPaSbJ9OBpYl/KaG00lZFHyKc8fUWQOBg8dlrXnTa9Cvtrd0Hf/hHYQr3F9lbgZfzICTDL6ZCthfqW49idrqv+ZMouV649LxfmghKdVAoj+gKmUqsrSiCtJUrOmaTLuhjxJIFI1jQsBN/U02ac1e+6xHNoCKMIs6b6TImMczXwOqX+Eeg8Nne2O3plgU2yFtIYE76pSGhgoZ7gXOZXi20PWAbPcMnrhgdWiwcTkMhTCtDtE0mGwd14PAsfnkYvchxOrnSXNWYrvWH9sHJnCAi+SghkTToWCjcxlTBa4ihb3aiZKy2WC6YiW13OKGM9zrhQccITlRQSnMav5dl6KgX/DibDctDgxg99X63oBwEhYXtwh3bBTRkO+AKk2KkUU+Br1NprjpnFppyc7Wotrk7NJGLtlnnRuwSqLjTTdr5fBBqKKzF5uO+tP02u7/s4/NbC9xHTRCmM8+X5UCuQBEMwi9oQ+1EA01mBuMGzhfphxN09xHYLYqcFsfu7CDsNwneJBCFWS5kfC2pn8l8g7f1p0qhB+mt4XrAeBMRtAxs4U1Q5JX4JLLL3wKIm2OCSXN2LnRGzIIKo1bnTwHO9znkAuycAvqxzveNvOUjITfa5oKKI4TSlUZ2kwiF2Y039NZhkwQfPhP1tdbG/M9GWyrHpoa4rVSoqi7LA1BycQcpXIoLjrxuJxRzk8X9lILWPn+ZEKxPzWgZmNAEMS7qufzK1TVHf4TOniawcdV7dMKi7Z4R837qq+omz16h44ZtGzl6jHEyj0aupim3/vM/89+Iz56/0WXGs7x9Mb/VZ4SvTyL+sz7rvxWfoRJ+5/332Np+psPzlmaeXv9/R4Ac=</diagram></mxfile> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read.svg b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read.svg
new file mode 100644
index 000000000..8da9392ca
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read.svg
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="371px" height="101px" viewBox="-0.5 -0.5 371 101" content="&lt;mxfile host=&quot;Electron&quot; modified=&quot;2020-07-12T09:41:24.129Z&quot; agent=&quot;Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36&quot; etag=&quot;865qRRTVzJmbfsW35SML&quot; version=&quot;12.3.2&quot; type=&quot;device&quot; pages=&quot;1&quot;&gt;&lt;diagram id=&quot;cyf46QluELBuy1FbUENl&quot; name=&quot;Page-1&quot;&gt;7VdNc9owEP01HNOxLduYY/govXSSlkwKR2GtsSfCYmQBJr++Mpb8zQAZmqTTnqx90q6tt2+1Vg+N1umU4034nRGgPcsgaQ+Ne5ZlGn1bPjLkkCMDx8mBFY+IWlQCs+gVtKdCtxGBpLZQMEZFtKmDPotj8EUNw5yzfX1ZwGj9rRu8ghYw8zFto78iIsIc9RyjxL9BtAr1m01DzayxXqyAJMSE7SsQmvTQiDMm8tE6HQHNyNO85H5fT8wWH8YhFpc49F+f2cN44IyG3jy0Ar576s/vVJQdplu14UfOyNYHnhEdcsBEfb04aEo428YEsqhGDw33YSRgtsF+NruXIpBYKNZUWqYcBhGlI0YZP/oigsELfIkngrMXqMy4vgfLQM6096U/EriAtAKpfU6BrUHwg1yiZ13FuRJdkYN9mUJTY2ElfbbCsFLNqghdEisHitsreLZaPP8c3pZYBzxidxHrWUvkurchFhnnifXek1fU4vVJidYwb8pv4Pngdwp36Tm2Y9yGX7vJr/HRwrVbBLdohZjcZyettHyKkyTy60xKOvhhrlg/GovM+OJoc5xWJ8cHbaWRmOsYclzxklbplBna52QOErblPpw/CQXmKxDnKxlIrW+0M1rJmNORMI1xoFhEu3q36cqiesMji+TOypPOrgsGuQ0h5PtWXtXu0Aw0aAQyG4FyYlqBjqIqtv12nTn/is6sC3WGPpXOrP6Jg/9anRW60oGc99WZe7phtBX3FzYM+6MbRv9/IXcq7pMUMhqcqb9LC9luFjL6Y4X89LyY8rsf/cnLw1hgMV2M57Tj5nK78o1ZLBcNCU7Co7vZVcaTe3dY+a9u1WyHqk7/VzeyUnTjahnbHaoorptX1LE0y1tnno7y7o4mvwE=&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><rect x="0" y="30" width="120" height="40" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/><g transform="translate(16.5,43.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="86" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 87px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Producer thread</div></div></foreignObject><text x="43" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Producer thread</text></switch></g><rect x="140" y="30" width="80" height="40" fill="#d5e8d4" stroke="#82b366" pointer-events="all"/><g transform="translate(171.5,43.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="17" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 18px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">RB</div></div></foreignObject><text x="9" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">RB</text></switch></g><rect x="240" y="10" width="120" height="40" fill="#f8cecc" stroke="#b85450" pointer-events="all"/><g transform="translate(275.5,23.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="48" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 49px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Thread 1</div></div></foreignObject><text x="24" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Thread 1</text></switch></g><path d="M 120 50 L 133.63 50" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 138.88 50 L 131.88 53.5 L 133.63 50 L 131.88 46.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 220 50 L 235.5 34.5" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 239.21 30.79 L 236.73 38.22 L 235.5 34.5 L 231.78 33.27 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="240" y="50" width="120" height="40" fill="#f8cecc" stroke="#b85450" pointer-events="all"/><g transform="translate(275.5,63.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="48" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 49px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Thread 2</div></div></foreignObject><text x="24" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Thread 2</text></switch></g><path d="M 220 50 L 235.5 65.5" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 239.21 69.21 L 231.78 66.73 L 235.5 65.5 L 236.73 61.78 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="230" y="0" width="140" height="100" fill="none" stroke="#ea6b66" stroke-dasharray="3 3" pointer-events="all"/></g></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read.xml b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read.xml
new file mode 100644
index 000000000..dfba7056b
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read.xml
@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2020-07-12T09:41:15.697Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36" etag="fegna7Adfaxn-QJceuXr" version="12.3.2" type="device" pages="1"><diagram id="cyf46QluELBuy1FbUENl" name="Page-1">7VdNc9owEP01HNOxLduYY/govXSSlkwKR2GtsSfCYmQBJr++Mpb8zQAZmqTTnqx90q6tt2+1Vg+N1umU4034nRGgPcsgaQ+Ne5ZlGn1bPjLkkCMDx8mBFY+IWlQCs+gVtKdCtxGBpLZQMEZFtKmDPotj8EUNw5yzfX1ZwGj9rRu8ghYw8zFto78iIsIc9RyjxL9BtAr1m01DzayxXqyAJMSE7SsQmvTQiDMm8tE6HQHNyNO85H5fT8wWH8YhFpc49F+f2cN44IyG3jy0Ar576s/vVJQdplu14UfOyNYHnhEdcsBEfb04aEo428YEsqhGDw33YSRgtsF+NruXIpBYKNZUWqYcBhGlI0YZP/oigsELfIkngrMXqMy4vgfLQM6096U/EriAtAKpfU6BrUHwg1yiZ13FuRJdkYN9mUJTY2ElfbbCsFLNqghdEisHitsreLZaPP8c3pZYBzxidxHrWUvkurchFhnnifXek1fU4vVJidYwb8pv4Pngdwp36Tm2Y9yGX7vJr/HRwrVbBLdohZjcZyettHyKkyTy60xKOvhhrlg/GovM+OJoc5xWJ8cHbaWRmOsYclzxklbplBna52QOErblPpw/CQXmKxDnKxlIrW+0M1rJmNORMI1xoFhEu3q36cqiesMji+TOypPOrgsGuQ0h5PtWXtXu0Aw0aAQyG4FyYlqBjqIqtv12nTn/is6sC3WGPpXOrP6Jg/9anRW60oGc99WZe7phtBX3FzYM+6MbRv9/IXcq7pMUMhqcqb9LC9luFjL6Y4X89LyY8rsf/cnLw1hgMV2M57Tj5nK78o1ZLBcNCU7Co7vZVcaTe3dY+a9u1WyHqk7/VzeyUnTjahnbHaoorptX1LE0y1tnno7y7o4mvwE=</diagram></mxfile> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read_write.svg b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read_write.svg
new file mode 100644
index 000000000..a605a01d8
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read_write.svg
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="381px" height="101px" viewBox="-0.5 -0.5 381 101" content="&lt;mxfile host=&quot;Electron&quot; modified=&quot;2020-07-12T10:05:29.108Z&quot; agent=&quot;Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36&quot; etag=&quot;YNO30IBgRUC6y0mW7irz&quot; version=&quot;12.3.2&quot; type=&quot;device&quot; pages=&quot;1&quot;&gt;&lt;diagram id=&quot;cyf46QluELBuy1FbUENl&quot; name=&quot;Page-1&quot;&gt;7ZhLc9owEMc/jY/p2JJt7GN4JL10kjZMCqeOsARWYyxGFq98+sqxhF9ioIRAZtoT3pV2bf32rxcW7M039xwt4m8Mk8QCNt5YsG8B4IDAlj+5Z1t4OiAsHDNOsepUOp7oK1FOFTdbUkyyWkfBWCLoou6MWJqSSNR8iHO2rnebsqT+1gWakZbjKUJJ2/uTYhEX3sCzS/9XQmexfrNjq5Y50p2VI4sRZuuKCw4s2OOMieJpvumRJIenuRRxd3tadx/GSSqOCXicrMLwd9ab+7/omID18PVueAOKLCuULNWA1ceKrSbA2TLFJE9iW7C7jqkgTwsU5a1rWXPpi8U8kZYjH6c0SXosYVzaKUtlpy5GWfwWnrdngrMXontYAA5u/a7vyxb1IYQLstk7QmfHTQqOsDkRfCu76ABdFaU1J1T2uqyc4ypfXK2aLhpSapntcpdA5YNiaubbeX1mD/3Q63WDUQymfDXsjG6cFt9HzvAyIjwXcswJwucDLnFiRIJpZALtRwGZTHegW1QN7PeD9uuggW0ADQyg3Y/i3Nbxj+55wXokwK4JbAAmsKLgd4GFdgMsaIMNLskVtrgOlWht56x8p0FEIqNwJ4HnevZ5+LpNvlcXrnt4ASYpvs13MmlFCcoyGtVJShx8O1LU34xxbnzxtNnfVBv7W21tqBjpHPK5EiWtMig3dMzeGmRsySNyeCUUiM+IODyTCa7ty+2KVirmGQqmfZwkSNBVfTc3VVG94ZFRObJypXPrgoF+QwjFuFVUdfdtJgobiZxGogJMK9GbqHbDPl1n3r+iM3CkzuCn0hno7Fn4/1ZnO13pRN5ldebv3zDOeLS83obhXnvD6PyfyEbFfZKJDMMD8+/Yiew2JzL8sIk8fB7f85vvncHLQ18gcT/ujxLDzeV80/eUm+H7ztWNqlz2Zmi8eX/am+H7ruDNm+El10sj5ysefIwLk1HJx52Kr3Y4CRpFPfUQDOyPOgRLs/wnrehe/h8JB38A&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><rect x="0" y="0" width="140" height="100" fill="none" stroke="#ea6b66" stroke-dasharray="3 3" pointer-events="all"/><rect x="10" y="10" width="120" height="40" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/><g transform="translate(26.5,23.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="86" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 87px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Producer thread</div></div></foreignObject><text x="43" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Producer thread</text></switch></g><rect x="150" y="30" width="80" height="40" fill="#d5e8d4" stroke="#82b366" pointer-events="all"/><g transform="translate(180.5,43.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="17" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 18px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">RB</div></div></foreignObject><text x="9" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">RB</text></switch></g><rect x="250" y="10" width="120" height="40" fill="#f8cecc" stroke="#b85450" pointer-events="all"/><g transform="translate(285.5,23.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="48" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 50px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Thread 1</div></div></foreignObject><text x="24" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Thread 1</text></switch></g><path d="M 130 30 L 145.5 45.5" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 149.21 49.21 L 141.78 46.73 L 145.5 45.5 L 146.73 41.78 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 230 50 L 245.5 34.5" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 249.21 30.79 L 246.73 38.22 L 245.5 34.5 L 241.78 33.27 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="250" y="50" width="120" height="40" fill="#f8cecc" stroke="#b85450" pointer-events="all"/><g transform="translate(285.5,63.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="48" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 50px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Thread 2</div></div></foreignObject><text x="24" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Thread 2</text></switch></g><path d="M 230 50 L 245.5 65.5" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 249.21 69.21 L 241.78 66.73 L 245.5 65.5 L 246.73 61.78 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="240" y="0" width="140" height="100" fill="none" stroke="#ea6b66" stroke-dasharray="3 3" pointer-events="all"/><rect x="10" y="50" width="120" height="40" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/><g transform="translate(26.5,63.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="86" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 87px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Producer thread</div></div></foreignObject><text x="43" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Producer thread</text></switch></g><path d="M 130 70 L 145.5 54.5" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 149.21 50.79 L 146.73 58.22 L 145.5 54.5 L 141.78 53.27 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/></g></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read_write.xml b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read_write.xml
new file mode 100644
index 000000000..a72364010
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_read_write.xml
@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2020-07-12T10:05:22.522Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36" etag="Ioy17BWExHAahaKx-YXg" version="12.3.2" type="device" pages="1"><diagram id="cyf46QluELBuy1FbUENl" name="Page-1">7ZhLc9owEMc/jY/p2JJt7GN4JL10kjZMCqeOsARWYyxGFq98+sqxhF9ioIRAZtoT3pV2bf32rxcW7M039xwt4m8Mk8QCNt5YsG8B4IDAlj+5Z1t4OiAsHDNOsepUOp7oK1FOFTdbUkyyWkfBWCLoou6MWJqSSNR8iHO2rnebsqT+1gWakZbjKUJJ2/uTYhEX3sCzS/9XQmexfrNjq5Y50p2VI4sRZuuKCw4s2OOMieJpvumRJIenuRRxd3tadx/GSSqOCXicrMLwd9ab+7/omID18PVueAOKLCuULNWA1ceKrSbA2TLFJE9iW7C7jqkgTwsU5a1rWXPpi8U8kZYjH6c0SXosYVzaKUtlpy5GWfwWnrdngrMXontYAA5u/a7vyxb1IYQLstk7QmfHTQqOsDkRfCu76ABdFaU1J1T2uqyc4ypfXK2aLhpSapntcpdA5YNiaubbeX1mD/3Q63WDUQymfDXsjG6cFt9HzvAyIjwXcswJwucDLnFiRIJpZALtRwGZTHegW1QN7PeD9uuggW0ADQyg3Y/i3Nbxj+55wXokwK4JbAAmsKLgd4GFdgMsaIMNLskVtrgOlWht56x8p0FEIqNwJ4HnevZ5+LpNvlcXrnt4ASYpvs13MmlFCcoyGtVJShx8O1LU34xxbnzxtNnfVBv7W21tqBjpHPK5EiWtMig3dMzeGmRsySNyeCUUiM+IODyTCa7ty+2KVirmGQqmfZwkSNBVfTc3VVG94ZFRObJypXPrgoF+QwjFuFVUdfdtJgobiZxGogJMK9GbqHbDPl1n3r+iM3CkzuCn0hno7Fn4/1ZnO13pRN5ldebv3zDOeLS83obhXnvD6PyfyEbFfZKJDMMD8+/Yiew2JzL8sIk8fB7f85vvncHLQ18gcT/ujxLDzeV80/eUm+H7ztWNqlz2Zmi8eX/am+H7ruDNm+El10sj5ysefIwLk1HJx52Kr3Y4CRpFPfUQDOyPOgRLs/wnrehe/h8JB38A</diagram></mxfile> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_write.svg b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_write.svg
new file mode 100644
index 000000000..5f653d1f9
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_write.svg
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="371px" height="101px" viewBox="-0.5 -0.5 371 101" content="&lt;mxfile host=&quot;Electron&quot; modified=&quot;2020-07-12T09:41:51.131Z&quot; agent=&quot;Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36&quot; etag=&quot;u1ZxjGBDPpTYnDsvWuWJ&quot; version=&quot;12.3.2&quot; type=&quot;device&quot; pages=&quot;1&quot;&gt;&lt;diagram id=&quot;-rsuYHbGqsa_XvOsthcc&quot; name=&quot;Page-1&quot;&gt;7Vffk5owEP5reLQDBJB7PNR6czN2nNr29N4iWYU7JE6Iiv3rGyThh+CN9hw77fXJ7LfZDfn2k1001FulQ4bXwYgSiDRTJ6mG+pppGnrXEj8Zss+RO9vOgSULidxUApPwJ6hIiW5CAkltI6c04uG6Dvo0jsHnNQwzRnf1bQsa1U9d4yU0gImPoyb6FBIe5Khr6yX+AOEyUCcbuvSssNosgSTAhO4qEBpoqMco5flqlfYgyshTvORxn094iwdjEPNzAmLr0Ru/dpLEY3j7Mn3EPzp+JwvI0mxxtJE3/hYwwERg8oSE7xUZjG5iAlk+XUPeLgg5TNbYz7w7UX6BBXwVCcsQy0UYRT0aUXaIRQSDu/AFnnBGX6HicXwX5gvhad5IPsIWGIe0AskbDoGugLO92KK8jmRbys1U5diVxTNURYJK4SyJYamXZZG6pFQsJKuXMIxOM2z+Cwxbf5xhq8HwV++6zNrgEquNWdecI8e5DrNIP2LWbDLr3pRY+7R00VUJXrg++K3Snbu2ZevXIdg6g+AbS9dpMNzgFWJynzUyYfkRTpLQr1Mp+GD7qaT9YMwy45OtzH5adfb3ykpDPlU5xLoSJawyKDNUzMkiJHTDfDij0XDMlsDP+DcDqTXmZlErRbNbaqYwBhHm4bbeztsKKU8Y01DcrXzdWXXNIOdIC/nNZVS1/R4nujtKZBwlyplpJDroqrj2O6TW/TBSQ3+n1MzuidfTpVIrpKUS2TeWmvthpGadKzX7v9TeKbXn2Swdjr48jJ8mw+fBy2T0nfOOmgHeUNpvzyUxjcUmj+AkOIQbbfPJ4N7xKgNgYxhp0dXp0dquk1m0jOp8YrWoovjovGBAEWb57ZmXo/yCR4Nf&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><rect x="10" y="10" width="120" height="40" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/><g transform="translate(45.5,23.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="48" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 49px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Thread 1</div></div></foreignObject><text x="24" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Thread 1</text></switch></g><rect x="10" y="50" width="120" height="40" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/><g transform="translate(45.5,63.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="48" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 49px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Thread 2</div></div></foreignObject><text x="24" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Thread 2</text></switch></g><rect x="150" y="30" width="80" height="40" fill="#d5e8d4" stroke="#82b366" pointer-events="all"/><g transform="translate(181.5,43.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="17" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 18px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">RB</div></div></foreignObject><text x="9" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">RB</text></switch></g><rect x="250" y="30" width="120" height="40" fill="#f8cecc" stroke="#b85450" pointer-events="all"/><g transform="translate(285.5,43.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="48" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 49px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Thread 3</div></div></foreignObject><text x="24" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Thread 3</text></switch></g><path d="M 130 30 L 145.5 45.5" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 149.21 49.21 L 141.78 46.73 L 145.5 45.5 L 146.73 41.78 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 130 70 L 145.5 54.5" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 149.21 50.79 L 146.73 58.22 L 145.5 54.5 L 141.78 53.27 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 230 50 L 243.63 50" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 248.88 50 L 241.88 53.5 L 243.63 50 L 241.88 46.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><rect x="0" y="0" width="140" height="100" fill="none" stroke="#ea6b66" stroke-dasharray="3 3" pointer-events="all"/></g></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_write.xml b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_write.xml
new file mode 100644
index 000000000..85a701cc2
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_2_thread_write.xml
@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2020-07-12T09:41:42.068Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36" etag="doj6m2iLduerqMsM9VND" version="12.3.2" type="device" pages="1"><diagram id="-rsuYHbGqsa_XvOsthcc" name="Page-1">7Vffk5owEP5reLQDBJB7PNR6czN2nNr29N4iWYU7JE6Iiv3rGyThh+CN9hw77fXJ7LfZDfn2k1001FulQ4bXwYgSiDRTJ6mG+pppGnrXEj8Zss+RO9vOgSULidxUApPwJ6hIiW5CAkltI6c04uG6Dvo0jsHnNQwzRnf1bQsa1U9d4yU0gImPoyb6FBIe5Khr6yX+AOEyUCcbuvSssNosgSTAhO4qEBpoqMco5flqlfYgyshTvORxn094iwdjEPNzAmLr0Ru/dpLEY3j7Mn3EPzp+JwvI0mxxtJE3/hYwwERg8oSE7xUZjG5iAlk+XUPeLgg5TNbYz7w7UX6BBXwVCcsQy0UYRT0aUXaIRQSDu/AFnnBGX6HicXwX5gvhad5IPsIWGIe0AskbDoGugLO92KK8jmRbys1U5diVxTNURYJK4SyJYamXZZG6pFQsJKuXMIxOM2z+Cwxbf5xhq8HwV++6zNrgEquNWdecI8e5DrNIP2LWbDLr3pRY+7R00VUJXrg++K3Snbu2ZevXIdg6g+AbS9dpMNzgFWJynzUyYfkRTpLQr1Mp+GD7qaT9YMwy45OtzH5adfb3ykpDPlU5xLoSJawyKDNUzMkiJHTDfDij0XDMlsDP+DcDqTXmZlErRbNbaqYwBhHm4bbeztsKKU8Y01DcrXzdWXXNIOdIC/nNZVS1/R4nujtKZBwlyplpJDroqrj2O6TW/TBSQ3+n1MzuidfTpVIrpKUS2TeWmvthpGadKzX7v9TeKbXn2Swdjr48jJ8mw+fBy2T0nfOOmgHeUNpvzyUxjcUmj+AkOIQbbfPJ4N7xKgNgYxhp0dXp0dquk1m0jOp8YrWoovjovGBAEWb57ZmXo/yCR4Nf</diagram></mxfile> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_single_read_write.svg b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_single_read_write.svg
new file mode 100644
index 000000000..c931f11eb
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_single_read_write.svg
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="361px" height="41px" viewBox="-0.5 -0.5 361 41" content="&lt;mxfile host=&quot;Electron&quot; modified=&quot;2020-07-12T09:33:45.423Z&quot; agent=&quot;Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36&quot; etag=&quot;WdRnUwxDEZ_xf72e8Hrg&quot; version=&quot;12.3.2&quot; type=&quot;device&quot; pages=&quot;1&quot;&gt;&lt;diagram id=&quot;-rsuYHbGqsa_XvOsthcc&quot; name=&quot;Page-1&quot;&gt;5VZdb9owFP01eWQK+Wr2OKDtVGkSGtLGHo19Sbw6MXIMhP362djOBwGVaqyq1Kf4nut7bZ9z4sQLp0X9KNAm/8YJMC/wSe2FMy8Igjjx1UMjB4OMo/jOIJmgxGItsKB/wIK2MNtSAlVvouScSbrpg5iXJWDZw5AQfN+ftuasv+oGZTAAFhixIfqTEpkbNI39Fv8KNMvdymPfZgrkJlugyhHh+w4U3nvhVHAuzaiop8A0e44XU/dwIdtsTEAprykoo6fJ/HlUVROBdr+XT+jHCI90gW6zQ2xrT7ygZaZOHySo2HjhpFxV+rEXVGqQqbUmK6FGmR6ptcVBb4NTtQtzTnlw5Am+LQno9X3dIlctFhuEdXav/KKwXBZMRWM1XFPGppxxcawNCYJ0jRVeScGfoZNJcAqrtcoMGbCk7EBIqDuQZeQReAFmwy7rDGr92ai1b8UeOyzvCB1ZDFl/ZU3rVgI1sCq8RpFooMj3yW2ZjSEl0Tlm02AVJsltmA39l5lN35TY+KLVfQGInDF3TeV/8fY6xYDPenuVxlHs30aB6AoF3tjbyUCCAa9Qki/63lYRZqiqKO5Tebxxlpb2Y/BLB59iF87qbnJ2cJESc+l6qHGnSkVtkQ5czUURKr4VGK64VyUSGcgrXncgve/QUNSOaPEZzRwmgCFJd/2v1zkh7QpzY+7mPoz6ngmTEy+Yk8+bV+LhUqPPJ43GJ40MM4NGR181x/4Hq6UfxmrRtVaL35XVgrsL19NrrdZYyzWKb2U1Fbb/Z2Z6+5sb3v8F&lt;/diagram&gt;&lt;/mxfile&gt;"><defs/><g><rect x="0" y="0" width="120" height="40" fill="#dae8fc" stroke="#6c8ebf" pointer-events="all"/><g transform="translate(28.5,6.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="62" height="27" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 63px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Single write<br />entry point</div></div></foreignObject><text x="31" y="20" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">[Not supported by viewer]</text></switch></g><rect x="140" y="0" width="80" height="40" fill="#d5e8d4" stroke="#82b366" pointer-events="all"/><g transform="translate(171.5,13.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="17" height="12" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 18px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">RB</div></div></foreignObject><text x="9" y="12" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">RB</text></switch></g><rect x="240" y="0" width="120" height="40" fill="#f8cecc" stroke="#b85450" pointer-events="all"/><g transform="translate(269.5,6.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="61" height="27" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 12px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 62px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">Single read<br />exit point</div></div></foreignObject><text x="31" y="20" fill="#000000" text-anchor="middle" font-size="12px" font-family="Helvetica">Single read&lt;br&gt;exit point</text></switch></g><path d="M 120 20 L 133.63 20" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 138.88 20 L 131.88 23.5 L 133.63 20 L 131.88 16.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/><path d="M 220 20 L 233.63 20" fill="none" stroke="#000000" stroke-miterlimit="10" pointer-events="stroke"/><path d="M 238.88 20 L 231.88 23.5 L 233.63 20 L 231.88 16.5 Z" fill="#000000" stroke="#000000" stroke-miterlimit="10" pointer-events="all"/></g></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_single_read_write.xml b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_single_read_write.xml
new file mode 100644
index 000000000..f605c5a8d
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/buff_thread_safety_single_read_write.xml
@@ -0,0 +1 @@
+<mxfile host="Electron" modified="2020-07-12T09:31:36.670Z" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36" etag="F-j8S_b5-iBsrb99uoaa" version="12.3.2" type="device" pages="1"><diagram id="-rsuYHbGqsa_XvOsthcc" name="Page-1">5VZNj9owEP01OVLle7PHArutVqqEitRuj8YeEnedGDkGQn99bWzng4CWVen20FM8z57x+L0XJ140K5tPAm2KL5wA80KfNF4098IwCDNfPTRyMMhdeG+AXFBiF3XAkv4CC9q8fEsJ1IOFknMm6WYIYl5VgOUAQ0Lw/XDZmrPhrhuUwwhYYsTG6HdKZGHQLPE7/DPQvHA7B76dKZFbbIG6QITve1D04EUzwbk0o7KZAdPkOV5M3uOF2bYxAZW8JqGKn6aLl0ldTwXa/Xx+Qt8meKITdJkdYlt74iWtcnX6MEXlxoum1arWj72gUoNM7TVdCTXK9UjtLQ66DU5VF+ac8uDIE3xbEdD7+7pEoUosNwjr2b2yi8IKWTIVBWq4pozNOOPimBsRBNkaK7yWgr9AbybFGazWasa2DkJCc5GUoKVaeRR4CaZhl5Badaw9W7X2ndiBw4qe0LHFkPVX3pbuJFADq8JbFIlHinyd3pbZBDISn2M2C1dRmt6G2ch/ndnsXYlNLlrdF4DIGXM3VP4Vb68zDPist1dZEif+bRSIr1Dgnb2djiQY8QoV+ajvbRVhhuqa4iGVxxvn2dJ+DH7o4EPiwnnTn5wfXKTEfHY11LiXpaIuSQcuxzQHZPSJOJFAHYBvBYYrLlqJRA7y1fd/LGpPtOSMZg4TwJCku2HD54S0OyyMudv7MB56JkpPvGAOumhficdLhe5PCgUnhQwRo0JHX7XH/gOrZf+v1eJrrZb8S6uFdxeup7darbWWK5Tcymoq7P7PzPLuLzd6+A0=</diagram></mxfile> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/logo.drawio b/src/fluent-bit/lib/lwrb/docs/static/images/logo.drawio
new file mode 100644
index 000000000..da4d31893
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/logo.drawio
@@ -0,0 +1 @@
+<mxfile modified="2020-12-05T00:16:42.437Z" host="Electron" agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36" etag="U11Z96L21UU_GpCirp-U" version="12.3.2" type="device" pages="1"><diagram id="I-N_G4gh3ujyhIfbbh0O" name="Page-1">jZJNb4MwDIZ/DcdJQNSKXcu6Tto6TTCp54i4JFogKLgD9usXhgNFVaWdEj/+iPPaAUur/mB5I49GgA7iUPQBewriOAqTxB0jGSbyuCVQWiUoaAG5+oEJbghelIB2FYfGaFTNGhamrqHAFePWmm4ddjZ6/WjDS7gBecH1LT0pgXKiySZc+AuoUvqXo5A8FffBBFrJhemuqrJ9wFJrDE63qk9Bj9p5Waa85zveuTELNf4noeVMvOeDyrg6vn6cs1NSfj7EU5Vvri/04bcu21HDOHgVrLnUAsZCUcB2nVQIecOL0du5sTsmsdLkbtGar1mtrSNnUyNNlo32LEXoDOoALEJ/92uLYG7RwFSAdnAhlMD8OGjHYm93y8iiLTF5NS4fx2lLyrn0IqS7kJbeXGb257tafLb/BQ==</diagram></mxfile> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/logo.svg b/src/fluent-bit/lib/lwrb/docs/static/images/logo.svg
new file mode 100644
index 000000000..21227616a
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/logo.svg
@@ -0,0 +1,3 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="172" height="62" viewBox="-0.5 -0.5 172 62" content="&lt;mxfile modified=&quot;2020-12-05T00:16:48.280Z&quot; host=&quot;Electron&quot; agent=&quot;Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.3.2 Chrome/78.0.3904.113 Electron/7.1.2 Safari/537.36&quot; etag=&quot;eB8u7GvUIOumasQDYpck&quot; version=&quot;12.3.2&quot; type=&quot;device&quot; pages=&quot;1&quot;&gt;&lt;diagram id=&quot;I-N_G4gh3ujyhIfbbh0O&quot; name=&quot;Page-1&quot;&gt;jZJNb4MwDIZ/DcdJQNSKXcu6Tto6TTCp54i4JFogKLgD9usXhgNFVaWdEj/+iPPaAUur/mB5I49GgA7iUPQBewriOAqTxB0jGSbyuCVQWiUoaAG5+oEJbghelIB2FYfGaFTNGhamrqHAFePWmm4ddjZ6/WjDS7gBecH1LT0pgXKiySZc+AuoUvqXo5A8FffBBFrJhemuqrJ9wFJrDE63qk9Bj9p5Waa85zveuTELNf4noeVMvOeDyrg6vn6cs1NSfj7EU5Vvri/04bcu21HDOHgVrLnUAsZCUcB2nVQIecOL0du5sTsmsdLkbtGar1mtrSNnUyNNlo32LEXoDOoALEJ/92uLYG7RwFSAdnAhlMD8OGjHYm93y8iiLTF5NS4fx2lLyrn0IqS7kJbeXGb257tafLb/BQ==&lt;/diagram&gt;&lt;/mxfile&gt;"><defs><filter id="dropShadow"><feGaussianBlur in="SourceAlpha" stdDeviation="1.7" result="blur"/><feOffset in="blur" dx="3" dy="3" result="offsetBlur"/><feFlood flood-color="#3D4574" flood-opacity="0.4" result="offsetColor"/><feComposite in="offsetColor" in2="offsetBlur" operator="in" result="offsetBlur"/><feBlend in="SourceGraphic" in2="offsetBlur"/></filter></defs><g filter="url(#dropShadow)"><rect x="3" y="3" width="160" height="50" rx="7.5" ry="7.5" fill="#ffffff" stroke="#000000" stroke-width="6" pointer-events="all"/><g transform="translate(34.5,6.5)"><switch><foreignObject style="overflow:visible;" pointer-events="all" width="96" height="41" requiredFeatures="http://www.w3.org/TR/SVG11/feature#Extensibility"><div xmlns="http://www.w3.org/1999/xhtml" style="display: inline-block; font-size: 36px; font-family: Helvetica; color: rgb(0, 0, 0); line-height: 1.2; vertical-align: top; width: 97px; white-space: nowrap; overflow-wrap: normal; text-align: center;"><div xmlns="http://www.w3.org/1999/xhtml" style="display:inline-block;text-align:inherit;text-decoration:inherit;white-space:normal;">LwRB</div></div></foreignObject><text x="48" y="39" fill="#000000" text-anchor="middle" font-size="36px" font-family="Helvetica">LwRB</text></switch></g></g></svg> \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/logo_tm.png b/src/fluent-bit/lib/lwrb/docs/static/images/logo_tm.png
new file mode 100644
index 000000000..51ef5776e
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/logo_tm.png
Binary files differ
diff --git a/src/fluent-bit/lib/lwrb/docs/static/images/logo_tm_full.png b/src/fluent-bit/lib/lwrb/docs/static/images/logo_tm_full.png
new file mode 100644
index 000000000..3e5ba6544
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/static/images/logo_tm_full.png
Binary files differ
diff --git a/src/fluent-bit/lib/lwrb/docs/tips-tricks/index.rst b/src/fluent-bit/lib/lwrb/docs/tips-tricks/index.rst
new file mode 100644
index 000000000..feb81ce4b
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/tips-tricks/index.rst
@@ -0,0 +1,28 @@
+.. _tips_tricks:
+
+Tips & tricks
+=============
+
+Application buffer size
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Buffer size shall always be ``1`` byte bigger than anticipated data size.
+
+When application uses buffer for some data block ``N`` times, it is advised to set buffer size to ``1`` byte more than ``N * block_size`` is.
+This is due to ``R`` and ``W`` pointers alignment.
+
+.. note::
+ For more information, check :ref:`how_it_works`.
+
+.. literalinclude:: ../examples_src/example_tt_buff_size.c
+ :language: c
+ :linenos:
+ :caption: Application buffer size assignment
+
+When the code is executed, it produces following output:
+
+.. literalinclude:: ../examples_src/example_tt_buff_size_log.c
+ :caption: Application buffer size assignment output
+
+.. toctree::
+ :maxdepth: 2 \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/user-manual/events.rst b/src/fluent-bit/lib/lwrb/docs/user-manual/events.rst
new file mode 100644
index 000000000..b55f67f50
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/user-manual/events.rst
@@ -0,0 +1,28 @@
+.. _events:
+
+Events
+======
+
+When using LwRB in the application, it may be useful to get notification on different events,
+such as info when something has been written or read to/from buffer.
+
+Library has support for events that get called each time there has been a modification
+in the buffer data, that means on every read or write operation.
+
+Some use cases:
+
+* Notify application layer that LwRB operation has been executed and send debug message
+* Unlock semaphore when sufficient amount of bytes have been written/read from/to buffer when application uses operating system
+* Write notification to message queue at operating system level to wakeup another task
+
+.. note:: Every operation that modified `read` or `write` internal pointers,
+ is considered as read or write operation. An exception is *reset* event that sets
+ both internal pointers to `0`
+
+.. literalinclude:: ../examples_src/example_events.c
+ :language: c
+ :linenos:
+ :caption: Example code for events
+
+.. toctree::
+ :maxdepth: 2 \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/user-manual/how-it-works.rst b/src/fluent-bit/lib/lwrb/docs/user-manual/how-it-works.rst
new file mode 100644
index 000000000..e935fd1b3
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/user-manual/how-it-works.rst
@@ -0,0 +1,61 @@
+.. _how_it_works:
+
+How it works
+============
+
+This section shows different buffer corner cases and provides basic understanding how data are managed internally.
+
+.. figure:: ../static/images/buff_cases.svg
+ :align: center
+ :alt: Different buffer corner cases
+
+ Different buffer corner cases
+
+Let's start with reference of abbreviations in picture:
+
+* ``R`` represents `Read` pointer. Read on read/write operations. Modified on read operation only
+* ``W`` represents `Write` pointer. Read on read/write operations. Modified on write operation only
+* ``S`` represents `Size` of buffer. Used on all operations, never modified (atomic value)
+
+ * Valid number of ``W`` and ``R`` pointers are between ``0`` and ``S - 1``
+
+* Buffer size is ``S = 8``, thus valid number range for ``W`` and ``R`` pointers is ``0 - 7``.
+
+ * ``R`` and ``W`` numbers overflow at ``S``, thus valid range is always ``0, 1, 2, 3, ..., S - 2, S - 1, 0, 1, 2, 3, ..., S - 2, S - 1, 0, ...``
+ * Example ``S = 4``: ``0, 1, 2, 3, 0, 1, 2, 3, 0, 1, ...``
+
+* Maximal number of bytes buffer can hold is always ``S - 1``, thus example buffer can hold up to ``7`` bytes
+* ``R`` and ``W`` pointers always point to the next read/write operation
+* When ``W == R``, buffer is considered empty.
+* When ``W == R - 1``, buffer is considered full.
+
+ * ``W == R - 1`` is valid only if ``W`` and ``R`` overflow at buffer size ``S``.
+ * Always add ``S`` to calculated number and then use modulus ``S`` to get final value
+
+.. note::
+
+ Example 1, add ``2`` numbers: ``2 + 3 = (3 + 2 + S) % S = (3 + 2 + 4) % 4 = (5 + 4) % 4 = 1``
+
+ Example 2, subtract ``2`` numbers: ``2 - 3 = (2 - 3 + S) % S = (2 - 3 + 4) % 4 = (-1 + 4) % 4 = 3``
+
+
+.. figure:: ../static/images/buff_cases.svg
+ :align: center
+ :alt: Different buffer corner cases
+
+ Different buffer corner cases
+
+Different image cases:
+
+* Case **A**: Buffer is empty as ``W == R = 0 == 0``
+* Case **B**: Buffer holds ``W - R = 4 - 0 = 4`` bytes as ``W > R``
+* Case **C**: Buffer is full as ``W == R - 1`` or ``7 == 0 - 1`` or ``7 = (0 - 1 + S) % S = (0 - 1 + 8) % 8 = (-1 + 8) % 8 = 7``
+
+ * ``R`` and ``W`` can hold ``S`` different values, from ``0`` to ``S - 1``, that is modulus of ``S``
+ * Buffer holds ``W - R = 7 - 0 = 7`` bytes as ``W > R``
+* Case **D**: Buffer holds ``S - (R - W) = 8 - (5 - 3) = 6`` bytes as ``R > W``
+* Case **E**: Buffer is full as ``W == R - 1`` (``4 = 5 - 1``) and holds ``S - (R - W) = 8 - (5 - 4) ) = 7`` bytes
+
+
+.. toctree::
+ :maxdepth: 2 \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/user-manual/hw-dma-usage.rst b/src/fluent-bit/lib/lwrb/docs/user-manual/hw-dma-usage.rst
new file mode 100644
index 000000000..2ffd38095
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/user-manual/hw-dma-usage.rst
@@ -0,0 +1,96 @@
+DMA for embedded systems
+========================
+
+One of the key features of LwRB library is that it can be seamlessly integrated with DMA controllers on embedded systems.
+
+.. note::
+
+ DMA stands for *Direct Memory Access* controller and is usually used to off-load CPU.
+ More about DMA is available on `Wikipedia <https://en.wikipedia.org/wiki/Direct_memory_access>`_.
+
+DMA controllers normally use source and destination memory addresses to transfer data in-between.
+This features, together with LwRB, allows seamless integration and zero-copy of application data at interrupts after DMA transfer has been completed.
+Some manual work is necessary to be handled, but this is very minor in comparison of writing byte-by-byte to buffer at (for example) each received character.
+
+Below are ``2`` common use cases:
+
+* DMA transfers data from LwRB memory to (usually) some hardware IP
+* DMA transfers data from hardware IP to memory
+
+Zero-copy data from LwRB memory
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This describes how to pass LwRB output memory address as pointer to DMA (or any other processing function).
+After data is successfully processed, application can skip processed data and mark buffer as free for new data being written to it.
+
+.. figure:: ../static/images/buff_lin_read_skip.svg
+ :align: center
+ :alt: Data transfer from memory to hardware IP
+
+ Data transfer from memory to hardware IP
+
+* Case **A**: Initial state, buffer is full and holds ``7`` bytes
+* Case **B**: State after skipping ``R`` pointer for ``3`` bytes. Buffer now holds ``4`` remaining bytes
+* Case **C**: Buffer is empty, no more memory available for read operation
+
+Code example:
+
+.. literalinclude:: ../examples_src/example_skip_1.c
+ :language: c
+ :linenos:
+ :caption: Skip buffer data after usage
+
+Part **A** on image clearly shows that not all data bytes are linked in single contiguous block of memory.
+To send all bytes from lwrb, it might be necessary to repeat procedure multiple times
+
+.. literalinclude:: ../examples_src/example_skip_2.c
+ :language: c
+ :linenos:
+ :caption: Skip buffer data for non-contiguous block
+
+Zero-copy data to LwRB memory
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Similar to reading data from buffer with zero-copy overhead, it is possible to write to lwrb with zero-copy overhead too.
+Only difference is that application now needs pointer to write memory address and length of maximal number of bytes to directly copy into buffer.
+After successful processing, buffer advance operation is necessary to manually increase write pointer and to increase number of bytes in buffer.
+
+.. figure:: ../static/images/buff_lin_write_advance.svg
+ :align: center
+ :alt: Data transfer from memory to hardware IP
+
+* Case **A**: Initial state, buffer is empty as ``R == W``
+
+ * Based on ``W`` pointer position, application could write ``4`` bytes to contiguous block of memory
+* Case **B**: State after advancing `W` pointer for `4` bytes. Buffer now holds `4` bytes and has ``3`` remaining available
+* Case **C**: Buffer is full, no more free memory available for write operation
+
+Code example:
+
+.. literalinclude:: ../examples_src/example_advance_1.c
+ :language: c
+ :linenos:
+ :caption: Advance buffer pointer for manually written bytes
+
+Example for DMA transfer from memory
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This is an example showing pseudo code for implementing data transfer using DMA with zero-copy overhead.
+For read operation purposes, application gets direct access to LwRB read pointer and length of contiguous memory.
+
+It is assumed that after DMA transfer completes, interrupt is generated (embedded system) and buffer is skipped in the interrupt.
+
+.. note::
+
+ Buffer skip operation is used to mark sent data as processed and to free memory for new writes to buffer
+
+.. literalinclude:: ../examples_src/example_dma_skip.c
+ :language: c
+ :linenos:
+ :caption: DMA usage with buffer
+
+.. tip::
+ Check `STM32 UART DMA TX RX Github <https://github.com/MaJerle/stm32-usart-uart-dma-rx-tx>`_ repository for use cases.
+
+.. toctree::
+ :maxdepth: 2
diff --git a/src/fluent-bit/lib/lwrb/docs/user-manual/index.rst b/src/fluent-bit/lib/lwrb/docs/user-manual/index.rst
new file mode 100644
index 000000000..f874d6933
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/user-manual/index.rst
@@ -0,0 +1,12 @@
+.. _um:
+
+User manual
+===========
+
+.. toctree::
+ :maxdepth: 2
+
+ how-it-works
+ events
+ hw-dma-usage
+ thread-safety \ No newline at end of file
diff --git a/src/fluent-bit/lib/lwrb/docs/user-manual/thread-safety.rst b/src/fluent-bit/lib/lwrb/docs/user-manual/thread-safety.rst
new file mode 100644
index 000000000..3986d959c
--- /dev/null
+++ b/src/fluent-bit/lib/lwrb/docs/user-manual/thread-safety.rst
@@ -0,0 +1,84 @@
+.. _thread_safety:
+
+Thread safety
+=============
+
+Ring buffers are effectively used in embedded systems with or without operating systems.
+Common problem most of implementations have is linked to multi-thread environment (when using OS) or reading/writing from/to interrupts.
+This is linked to common question *What happens if I write to buffer while another thread is reading from it?*
+
+One of the main requirements (beside being lightweight) of *LwRB* was to allow *read-while-write* or *write-while-read* operations.
+This can be (and it is) achieved only when there is single write entry point and single read exit point.
+
+.. figure:: ../static/images/buff_thread_safety_single_read_write.svg
+ :align: center
+ :alt: Write and read operation with single entry and exit points
+
+ Write and read operation with single entry and exit points
+
+This is most often used as *pipe* to write (for example) raw data to the buffer allowing another task
+to process the data from another thread.
+
+.. note::
+ No race-condition is introduced when application uses LwRB with single write entry and single read exit point.
+
+Thread safety gets broken when application does one of the following:
+
+* Uses multiple write entry points to the single LwRB instance
+* Uses multiple read exit points to the single LwRB instance
+* Uses multiple read/write exit/entry points to the same LwRB instance
+
+.. figure:: ../static/images/buff_thread_safety_2_thread_write.svg
+ :align: center
+ :alt: Write operation to same LwRB instance from 2 threads
+
+ Write operation to same LwRB instance from 2 threads.
+ Write protection is necessary to ensure thread safety.
+
+.. figure:: ../static/images/buff_thread_safety_2_main_irq_write.svg
+ :align: center
+ :alt: Write operation to same LwRB instance from main loop and interrupt context
+
+ Write operation to same LwRB instance from main loop and interrupt context.
+ Write protection is necessary to ensure thread safety.
+
+.. figure:: ../static/images/buff_thread_safety_2_thread_read.svg
+ :align: center
+ :alt: Read operation from same LwRB instance from 2 threads
+
+ Read operation from same LwRB instance from 2 threads.
+ Read protection is necessary to ensure thread safety.
+
+.. figure:: ../static/images/buff_thread_safety_2_thread_read_write.svg
+ :align: center
+ :alt: Read from and write to operations using LwRB instance from multiple threads
+
+ Read and write operations are executed from multiple threads.
+ Both, read and write, operations require exclusive access.
+
+Above use cases are examples when thread safety gets broken. Application must ensure
+exclusive access only to the part in *dashed-red* rectangle.
+
+.. literalinclude:: ../examples_src/example_thread_safety.c
+ :language: c
+ :linenos:
+ :caption: Thread safety example
+
+Read and write operations can be used simultaneously hence it is perfectly valid if
+access is granted to *read* operation while *write* operation from one thread takes place.
+
+.. note::
+ ``2`` different mutexes are used for read and write due to the implementation,
+ allowing application to use buffer in *read-while-write* and *write-while-read* mode.
+ Mutexes are used to prevent *write-while-write* and *read-while-read* operations respectively
+
+.. tip::
+ For *multi-entry-point-single-exit-point* use case, *read* mutex is not necessary.
+ For *single-entry-point-multi-exit-point* use case, *write* mutex is not necessary.
+
+.. tip::
+ Functions considered as *read* operation are ``read``, ``skip``, ``peek`` and ``linear read``.
+ Functions considered as *write* operation are ``write``, ``advance`` and ``linear write``.
+
+.. toctree::
+ :maxdepth: 2 \ No newline at end of file