kopia lustrzana https://github.com/espressif/esp-idf
73592d9bc4
spin_lock: cleaned-up port files and removed portmux files components/soc: decoupled compare and set operations from FreeRTOS soc/spinlock: filled initial implementation of spinlock refactor It will decouple the spinlocks into separated components with not depencences of freertos an similar interface was provided focusing the readabillity and maintenance, also naming to spinlocks were adopted. On FreeRTOS side the legacy portMUX macros gained a form of wrapper functions that calls the spinlocks component thus minimizing the impact on RTOS side. This feature aims to close IDF-967 soc/spinlock: spinlocks passed on unit test, missing test corner cases components/compare_set: added better function namings plus minor performance optimization on spinlocks soc/spinlock: code reordering to remove ISC C90 mix error freertos/portmacro: gor rid of critical sections multiline macros, placed inline functions instead soc/spinlock: improved spinlock performance from internal RAM For cases where the spinlock is executed from IRAM, there is no need to check where the spinlock object is placed on memory, removing this checks caused a great improvement on performance. |
||
|---|---|---|
| .. | ||
| _static | ||
| en | ||
| zh_CN | ||
| Doxyfile | ||
| README.md | ||
| TEMPLATE_EXAMPLE_README.md | ||
| check_doc_warnings.sh | ||
| check_lang_folder_sync.sh | ||
| conf_common.py | ||
| docs_common.mk | ||
| gen-dxd.py | ||
| gen-toolchain-links.py | ||
| gen-version-specific-includes.py | ||
| html_redirects.py | ||
| link-roles.py | ||
| local_util.py | ||
| page_redirects.txt | ||
| requirements.txt | ||
| sphinx-known-warnings.txt | ||
README.md
Documentation Source Folder
This folder contains source files of ESP-IDF documentation available in English and 中文.
The sources do not render well in GitHub and some information is not visible at all.
Use actual documentation generated within about 20 minutes on each commit:
Hosted Documentation
- English: https://docs.espressif.com/projects/esp-idf/en/latest/
- 中文: https://docs.espressif.com/projects/esp-idf/zh_CN/latest/
The above URLs are all for the master branch latest version. Click the drop-down in the bottom left to choose a stable version or to download a PDF.
Building Documentation
- Install
makeanddoxygenfor your platform (makemay already be installed as an ESP-IDF prerequisite). - Change to either the docs/en or docs/zh_CN subdirectory and run
make html makewill probably prompt you to run a python pip install step to get some other Python-related prerequisites. Run the command as shown, then re-runmake htmlto build the docs.
For MSYS2 MINGW32 on Windows
If using Windows and the MSYS2 MINGW32 terminal, run this command before running "make html" the first time:
pacman -S doxygen mingw-w64-i686-python2-pillow
Note: Currently it is not possible to build docs on Windows without using a Unix-on-Windows layer such as MSYS2 MINGW32.