OVMS3-idf/docs/en
Darian Leung 8a597b865f esp_ringbuf: Add static allocation, refactor, and update API reference
This commit updates does the following:
    - xRingbufferCreateStatic() added to allow ringbuffers via to be statically
      allocated. Docs and unit tests update accordingly. Closes #3064

    - Fix doc typos, closes #3248. Updated API reference regarding to mention
      item size limits of no-split buffers when calling
      xRingbufferGetCurFreeSize() or xRingbufferGetMaxItemSize(), closes #3117.

    - Remove the following deprecated types/functions for v4.0
        - xRingbufferIsNextItemWrapped()
        - xRingbufferAddToQueueSetWrite()
        - xRingbufferRemoveFromQueueSetWrite()
2019-06-26 16:04:38 +08:00
..
api-guides Merge branch 'bugfix/idfpy_print_filter' into 'master' 2019-06-25 13:36:03 +08:00
api-reference esp_ringbuf: Add static allocation, refactor, and update API reference 2019-06-26 16:04:38 +08:00
contribute docs: Introduced custom 404 page in readthedocs documentation to replace… 2019-03-28 01:38:31 +08:00
get-started docs: update msys environment links for esp32-2019r1 toolchain 2019-06-11 22:22:14 +08:00
get-started-cmake Add click package to linux setup instructions 2019-06-14 19:51:39 +02:00
hw-reference Review the file hw-reference/modules-and-boards.rst 2019-06-24 08:22:43 +08:00
libraries-and-frameworks docs: Add cloud frameworks doc 2019-04-17 10:29:05 +00:00
security Improve flash encryption documentation and add Development & Release modes 2019-06-25 23:41:18 +00:00
404.rst Updated 404 page not found pages, both Chinese and English versions. 2019-03-28 19:06:43 +08:00
about.rst Doc/translate idf about 2019-06-12 19:17:04 +08:00
cmake-pending-features.rst cmake: add ulp components build support 2018-09-13 14:54:59 +08:00
cmake-warning.rst docs: Copy CMake docs to a separate set of directories 2018-08-13 15:37:03 +10:00
conf.py Download font file only is not exists in target location 2019-05-21 09:51:39 +08:00
COPYRIGHT.rst Port NimBLE Host Stack on ESP-IDF 2019-06-25 09:03:58 +08:00
index.rst docs: Add cloud frameworks doc 2019-04-17 10:29:05 +00:00
languages.rst There are now visible links to change between English and Chinese version of documentation. Therefore information on the home page how to switch between languages has been removed. Added 'Download' link to the menu to provide a more visible access to documentation in PDF format for people who prefer to read it offline. 2018-09-12 04:48:50 +02:00
Makefile docs: Combine the common en/zh_CN Makefiles to one common file 2018-08-09 11:08:03 +10:00
resources.rst Included missing links between English and Chinese documentation, where translation into Chinese is available 2019-01-27 19:01:34 +01:00
versions.rst Add translation for version file 2019-05-10 19:17:49 +08:00