alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
a65944a8cb
esp-idf/docs/api/storage/vfs.rst

48 lines
988 B
ReStructuredText
Raw Normal View History

Updated relative paths to included documents
2017-01-16 17:08:35 -05:00
.. include:: ../../../components/vfs/README.rst
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04:00
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs>
2016-11-05 12:18:25 -04:00
Application Example
-------------------
Updated relative paths to included documents
2017-01-16 17:08:35 -05:00
`Instructions`_
.. _Instructions: ../template.html
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs>
2016-11-05 12:18:25 -04:00
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04:00
API Reference
-------------
Revised api files - Included UART API - Addedd "Header Files" - Improved template - deleted redundat nvs.rst
2016-11-10 16:50:55 -05:00
Header Files
^^^^^^^^^^^^
docs: use custom roles to generate GitHub links This change replaces direct links to GitHub master branch with auto-generated links using docutils custom roles. These auto-generated links point to the tree or blob for the git commit ID (or tag) of the repository. This is needed to ensure that links don’t become broken when files in master branch are moved around or deleted. The following roles are introduced: - :idf:`path` - points to directory inside ESP-IDF - :idf_blob:`path` - points to file inside ESP-IDF - :idf_raw:`path` - points to raw view of the file inside ESP-IDF - :component:`path` - points to directory inside ESP-IDF components dir - :component_blob:`path` - points to file inside ESP-IDF components dir - :component_raw:`path` - points to raw view of the file inside ESP-IDF components dir - :example:`path` - points to directory inside ESP-IDF examples dir - :example_blob:`path` - points to file inside ESP-IDF examples dir - :example_raw:`path` - points to raw view of the file inside ESP-IDF examples dir A check is added to the CI build script, which searches RST files for presence of hard-coded links (identified by tree/master, blob/master, or raw/master part of the URL). This check can be run manually: cd docs && make gh-linkcheck Additionally, Sphinx linkcheck build type is used to create new CI test, which check for broken links. This test has to be triggered explicitly, because including it in normal build process (when the commit is not yet deployed to Github) will not work. It can be triggered in a regular fashion using a combination of cron and Curl, similar to stress tests.
2017-01-19 03:16:06 -05:00
* :component_file:`vfs/include/esp_vfs.h`
* :component_file:`vfs/include/esp_vfs_dev.h`
Revised api files - Included UART API - Addedd "Header Files" - Improved template - deleted redundat nvs.rst
2016-11-10 16:50:55 -05:00
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs>
2016-11-05 12:18:25 -04:00
Macros
^^^^^^
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04:00
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs>
2016-11-05 12:18:25 -04:00
.. doxygendefine:: ESP_VFS_PATH_MAX
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04:00
.. doxygendefine:: ESP_VFS_FLAG_DEFAULT
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs>
2016-11-05 12:18:25 -04:00
.. doxygendefine:: ESP_VFS_FLAG_CONTEXT_PTR
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04:00
Structures
^^^^^^^^^^
.. doxygenstruct:: esp_vfs_t
doc: API Reference - examples & fixes
2016-11-16 14:14:48 -05:00
:members:
API samples - Logging library - Virtual file system component
2016-10-29 17:00:30 -04:00
Functions
^^^^^^^^^
.. doxygenfunction:: esp_vfs_register
vfs: implement vfs_unregister
2016-12-29 09:21:29 -05:00
.. doxygenfunction:: esp_vfs_unregister
All API Reference docs updated to match header files 1. Wi-Fi <api/esp_wifi> 2. Bluetooth <api/bt> 2. GPIO <api/gpio> 4. LED Control <api/ledc> 5. Logging <api/log> 6. Non-Volatile Storage <api/nvs_flash> 7. Virtual Filesystem <api/vfs>
2016-11-05 12:18:25 -04:00
.. doxygenfunction:: esp_vfs_write
.. doxygenfunction:: esp_vfs_lseek
.. doxygenfunction:: esp_vfs_read
.. doxygenfunction:: esp_vfs_open
.. doxygenfunction:: esp_vfs_close
.. doxygenfunction:: esp_vfs_fstat
.. doxygenfunction:: esp_vfs_stat
.. doxygenfunction:: esp_vfs_link
.. doxygenfunction:: esp_vfs_unlink
.. doxygenfunction:: esp_vfs_rename
.. doxygenfunction:: esp_vfs_dev_uart_register
Reference in New Issue Copy Permalink