Crash_Override/OVMS3-idf
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
10204 commits 10 branches 75 tags 114 MiB
Commit graph

1209 commits

Author SHA1 Message Date
Angus Gratton 229fe8e2e4 Merge branch 'feature/esp-wrover-kit-v4_1' into 'master' 
Included ESP-WROVER-KIT V4.1 in documenation: Added 'Get Started' guide and updated 'HW Reference'. Closes https://github.com/espressif/esp-idf/issues/2363. Closes https://github.com/espressif/esp-idf/issues/2365.

See merge request idf/esp-idf!3161
 2018-09-10 14:48:41 +08:00
Roland Dobai f5a642840a docs: Make the Python scripts Python 2&3 compatible 2018-09-10 08:37:43 +02:00
Angus Gratton e7243a2cdd Merge branch 'doc/eclipse_parallel_build' into 'master' 
doc: Add parallel builds to the Eclipse setup guide

See merge request idf/esp-idf!3209
 2018-09-07 16:03:53 +08:00
morris 1e9ce6a2e1 doc: translate parallel build in Eclipse 2018-09-07 14:39:40 +08:00
Angus Gratton 4eeed31a04 Merge branch 'feature/cmake' into 'master' 
Merge experimental CMake support to master

See merge request idf/esp-idf!3024
 2018-09-07 13:44:17 +08:00
Angus Gratton 70cacc8b4e doc: Add parallel builds to the Eclipse setup guide 2018-09-07 11:48:17 +08:00
Ivan Grokhotkov 8893438f08 Merge branch 'feature/cpp_exceptions_example' into 'master' 
examples: add C++ exception handling example

See merge request idf/esp-idf!3178
 2018-09-07 10:34:18 +08:00
Angus Gratton cff2ef695a Merge branch 'master' into feature/cmake 2018-09-06 20:23:04 +08:00
krzychb 91c7149f6e Included information about power on and diagnostics LEDs. Closes https://github.com/espressif/esp-idf/issues/2365. 2018-09-06 11:28:23 +02:00
Ivan Grokhotkov 6fbf585703 docs/sleep: mention new wakeup sources, use generated API reference 2018-09-06 15:42:34 +08:00
Angus Gratton 0bc5dcc2c2 cmake: Post-merge fixups 2018-09-06 11:14:30 +08:00
krzychb 1d99531328 Corrected RGB LED pin assignment. Closes https://github.com/espressif/esp-idf/issues/2363. 2018-09-05 22:10:42 +02:00
krzychb 62389b6be6 Included ESP-WROVER-KIT V4.1 in documenation: Added 'Get Started' guide and updated 'HW Reference' 2018-09-05 22:10:42 +02:00
Ivan Grokhotkov a0d2dd0385 Merge branch 'bugfix/eclipse_compiler_command_cpp' into 'master' 
docs/eclipse: update command to get compiler specs

See merge request idf/esp-idf!3167
 2018-09-05 18:35:25 +08:00
Ivan Grokhotkov 312424b5ac docs: update command to get compiler specs in a few more places 2018-09-05 11:05:52 +08:00
Ivan Grokhotkov bcd384eb87 Merge branch 'doc/get_started_override_options' into 'master' 
doc: Add environent variable overriding to get started

See merge request idf/esp-idf!3160
 2018-09-05 11:02:47 +08:00
Angus Gratton b355854d4d Merge branch 'master' into feature/cmake 2018-09-05 10:35:04 +08:00
Darian Leung d268677017 doc: Add environemt variable overriding to get started 
This comit adds details about the overriding of environment variables such as
ESPPORT and ESPBAUD to the get started guide.
 2018-09-05 02:05:31 +08:00
Ivan Grokhotkov cb2876ff4e examples: add C++ exception handling example 2018-09-04 21:00:14 +08:00
Ivan Grokhotkov 97b2281c49 Merge branch 'bugfix/can_driver_multiple_bugs' into 'master' 
CAN: Add pm_lock, fix gpio bug, update docs

See merge request idf/esp-idf!3138
 2018-09-04 20:34:06 +08:00
Angus Gratton 2ec0fd8fd6 Merge branch 'feature/signature_verify_updates' into 'master' 
secure boot: Support signed app verification without hardware secure boot

See merge request idf/esp-idf!2814
 2018-09-04 18:56:47 +08:00
Konstantin Kondrashov 4fc84306a2 esp32/task_wdt: Add esp_task_wdt_isr_user_handler function 
Added esp_task_wdt_isr_user_handler function to receive twdt events in
the user code.

Closes https://github.com/espressif/esp-idf/issues/2270
 2018-09-03 14:31:20 +08:00
Angus Gratton 27a1758908 Merge branch 'mesh/rewrite_docs' into 'master' 
docs/rewrite_mesh_docs

See merge request idf/esp-idf!2990
 2018-09-03 10:52:33 +08:00
Darian Leung f4c3917712 docs/rewrite_mesh_docs 
The following commit rewrites the ESP-MESH docs. This commit includes
new diagrams and a structure approach to the mesh docs. Some mesh api references
have also been modified.
 2018-09-02 21:34:21 +08:00
Darian Leung dc3fa14a26 CAN: Add pm_lock, fix gpio bug, update docs 
This commit does the following

- Add power management lock to CAN driver so that APB frequency does not change
whilst CAN driver is in use
- Fix incorrect flag in can_transmit()
- Refactor can_driver_install() and can_driver_uninstall() so that critical sections
are shorter
- Fix CAN gpio configuration bug on RX pin. Closes #2302
- Add docs about multiple ID configuration and fix example links
 2018-09-01 02:46:05 +08:00
Angus Gratton c921f14128 cmake: Generate list of components with dependent items first, use deterministic ordering 
Guarantees that a component's project_include.cmake will be called after its dependent components'
project_include.cmake. Because of cycles in the dependency graph, this is less useful than you'd
think but it gives a strong guarantee for any component which is not part of a cycle.

Also applies deterministic ordering (ordering is initialised as COMPONENT_REQUIRES_COMMON then all
COMPONENTS in alphabetical order, but then the sorting by dependencies is applied.)
 2018-08-31 12:29:13 +08:00
Dennis Damen d8cf8074ec
Updated command to get compiler specs. 
Eclipse was unable to resolve the std::mutex type eventhough the mutex header file was succesfully included. By adding this modification, the issues was resolved.
 2018-08-30 22:00:47 +02:00
Roland Dobai 7cfef29eb8 Docs: Check Python packages 2018-08-30 13:20:42 +02:00
Angus Gratton 5fbfd20f10 Merge branch 'master' into feature/cmake 2018-08-30 18:52:31 +08:00
Angus Gratton a9c4ed7139 Merge branch 'master' into feature/cmake 2018-08-30 18:51:01 +08:00
Ivan Grokhotkov da34e3eb68 sdmmc: document eMMC support, host features 2018-08-30 13:14:26 +08:00
Jitin George 458b167f1a docs/en/security: Add documentation for signed apps without hardware secure boot feature 2018-08-29 17:05:34 +08:00
Angus Gratton 1abd346943 docs: Call 'python -m sphinx' instead of sphinx-build 
Fixes mismatches where default Python interpreter may not match the most recently
installed sphinx-build wrapper script (if sphinx 2 & 3 both installed, pip will
clobber any previous copy of /bin/sphinx-build when it installs the new one.)
 2018-08-29 14:43:42 +08:00
Alexey Gerenkov ac07c23e37 docs: Adds description of OpenOCD command to configure custom app image location 2018-08-27 14:08:36 +03:00
morris 988dfc6546 doc: additional translation in get_stated 2018-08-27 10:44:28 +08:00
morris 5e36837752 doc: translate build_system from en to zh_CN 2018-08-24 12:31:34 +08:00
Roland Dobai 52d11dcfb0 docs: make the use of pip install clear 2018-08-23 11:41:56 +02:00
morris 1a79900970 translated some parts in get-started section to zh_CN 
1. "install required python packages" in docs/zh_CN/get-started/index.rst
2. docs/zh_CN/get-started/linux-setup-scratch.rst
3. docs/zh_CN/get-started/linux-setup.rst
4. docs/zh_CN/get-started/macos-setup-scratch.rst
5. docs/zh_CN/get-started/macos-setup.rst
 2018-08-23 08:28:57 +02:00
Roland Dobai 62cad3a7d7 Add python-future by using python requirements file 2018-08-23 08:28:57 +02:00
Angus Gratton 7c9439dcbf Merge branch 'bugfix/wrover-kit-camera-socket-pinout' into 'master' 
Corrected pinout of the Camera / J4 connector

See merge request idf/esp-idf!3054
 2018-08-23 09:06:04 +08:00
Ivan Grokhotkov 90f5456dba Merge branch 'feature/rtc_cpu_freq_config' into 'master' 
soc/rtc: Refactoring, support CPU frequencies lower than XTAL

See merge request idf/esp-idf!2856
 2018-08-22 11:32:08 +08:00
krzychb 1857bca871 Corrected pinout of the Camera / J4 connector 2018-08-21 22:01:28 +02:00
Jeroen Domburg 9de884f586 Merge branch 'feat/spi_non_dma_64byte' into 'master' 
spi_master: change high part config to allow transactions of 64 bytes

See merge request idf/esp-idf!3025
 2018-08-21 16:53:37 +08:00
Ivan Grokhotkov e3d76d13b4 docs: update power management section on esp_pm_configure 2018-08-21 13:02:46 +08:00
Ivan Grokhotkov 4dd7233b20 Merge branch 'feature/reset_reason' into 'master' 
Add API to get reset reason

See merge request idf/esp-idf!2871
 2018-08-21 11:34:12 +08:00
Ivan Grokhotkov 8403adf4e0 docs: add API reference section for esp_system.h 2018-08-20 16:49:20 +08:00
Angus Gratton 76f864511d Merge branch 'feature/docs_new_logo_typeface' into 'master' 
Replaced Espressif logo with a new, consistent, modern and neutral typeface design.

See merge request idf/esp-idf!2988
 2018-08-20 08:22:02 +08:00
Jiang Jiang Jian 98eaa5c2ec Merge branch 'docs/security' into 'master' 
docs: Added more wordings to capture secure boot and flash encryption dependency.

See merge request idf/esp-idf!2947
 2018-08-16 19:31:36 +08:00
michael 404e99965d spi_master: change high part config to allow transactions of 64 bytes 2018-08-16 18:55:09 +08:00
Angus Gratton ff2404a272 Merge branch 'master' into feature/cmake 2018-08-16 17:14:17 +10:00
Krzysztof Budzynski df5d3ea692 Provided a table with development boards by Espressif together with USB-to-serial driver names 2018-08-16 05:24:40 +08:00
Ivan Grokhotkov 73e18a4c96 Merge branch 'docs/simplified_rtd_theme_configuration' into 'master' 
Removed redundant code to configure 'sphinx-rtd-theme' for documentation

See merge request idf/esp-idf!2921
 2018-08-16 05:23:54 +08:00
Angus Gratton 802fc7236d Merge branch 'doc/unit_test_zh_CN' into 'master' 
doc: translate the unit-tests.rst into Chinese

See merge request idf/esp-idf!2998
 2018-08-15 09:05:17 +08:00
morris 90350cb82d doc/unit-tests:translate the unit-tests into zh_CN 2018-08-14 15:47:08 +08:00
Sagar Bijwe b27773e87c docs: Added more wordings to capture secure boot and flash encryption dependency. 2018-08-14 11:27:29 +05:30
Ivan Grokhotkov 1fbff01799 docs: update esp32ulp-binutils download link 2018-08-13 16:48:27 +00:00
Ivan Grokhotkov 1bd7d404fe ulp: add documentation for JUMPS instruction conditions 
Hardware implements conditions LE, LT, GE, and conditions EQ and GT
are implemented in the assembler by emitting two JUMPS instructions
with other conditions.
 2018-08-13 16:48:27 +00:00
Angus Gratton 04238fa5e5 docs: Python 3 Sphinx compatibility 2018-08-13 15:37:03 +10:00
Angus Gratton 191557db02 docs: Copy CMake docs to a separate set of directories 
Required first step before merging back to mainline.
 2018-08-13 15:37:03 +10:00
krzychb 4946850e82 Replaced Espressif logo with a new, consistent, modern and neutral typeface design. 2018-08-13 07:22:41 +02:00
Angus Gratton 69f73eb5ee docs: Move version-related includes to run in sphinx-build not make 
Means they show up on ReadTheDocs(!)
 2018-08-13 12:24:55 +10:00
Angus Gratton 383a3f788d Merge branch 'doc/heap_tracing' into 'master' 
heap docs: Fix some bad links & errors in the heap docs

See merge request idf/esp-idf!2942
 2018-08-10 16:46:52 +08:00
Angus Gratton c9cbc6b30c heap docs: Fix some bad links & errors in the heap docs 
Also add a note about printf() sometimes causing on-demand allocations.
 2018-08-10 15:54:58 +10:00
Angus Gratton f341c5c944 Merge branch 'doc/versions' into 'master' 
docs: Add version-specific include files, version documentation

See merge request idf/esp-idf!2858
 2018-08-10 08:08:10 +08:00
Angus Gratton 13ff99867d docs: Combine the common en/zh_CN Makefiles to one common file 2018-08-09 11:08:03 +10:00
Michael (XIAO Xufeng) 522f9c4b4a docs: translate the version include script to Chinese 2018-08-09 11:08:03 +10:00
Ivan Grokhotkov 80c5547b97 Merge branch 'bugfix/ulp_fixes' into 'master' 
ULP fixes

See merge request idf/esp-idf!2948
 2018-08-08 15:37:25 +08:00
Ivan Grokhotkov 479af576ca ulp: fix calculation or ulp_run argument 
The argument to ulp_run should be expressed in 32-bit words. Both the
address of ulp_entry and RTC_SLOW_MEM already are uint32_t*, so their
difference is the difference in addresses divided by sizeof(uint32_t).
Therefore the extra division by sizeof(uint32_t) is not needed.
 2018-08-07 16:14:57 +03:00
Angus Gratton ffaa71bcd6 docs: Add version-specific include files, version documentation 
* "git clone" command and a small version header are generated
  depending on git properties.
* Add Versions page with details about each version
* Make it clear using master branch is living on the "bleeding
  edge"
 2018-08-06 15:38:32 +10:00
Jitin George 1fecdc3891 esp_https_ota: Add support for HTTPS based ota feature 2018-08-03 16:47:07 +05:30
Angus Gratton b3ff68a935 Merge branch 'bugfix/hard_error_partition_offset' into 'master' 
partition_table: Hard error if CSV contains invalid/overlapping offsets

See merge request idf/esp-idf!2755
 2018-08-03 14:52:43 +08:00
krzychb df9c701864 Removed redundant code to configure 'sphinx-rtd-theme' for documentation 2018-08-02 22:10:33 +02:00
Angus Gratton d3ae52afd2 Merge branch 'feature/add_logo_to_docs' into 'master' 
Added Espressif logo to documentation

See merge request idf/esp-idf!2763
 2018-08-02 08:26:14 +08:00
Angus Gratton f2a3429812 partition table: Document 'flags' properly 2018-08-01 19:23:38 +10:00
Angus Gratton 28801449e3 partition_table: Hard error if CSV contains invalid/overlapping offsets 
Based on report on forum here:
https://esp32.com/viewtopic.php?f=13&t=6382&p=27514

Previous versions were much more relaxed about what could be in the partition
table, erroring out avoids unexpected changes on upgrade like different
partition offsets.
 2018-08-01 19:23:38 +10:00
Angus Gratton 7457054c1f Merge branch 'feature/add_rom_elf' into 'master' 
Support for ROM functions in core dump backtraces

See merge request idf/esp-idf!2672
 2018-08-01 15:21:03 +08:00
Jiang Jiang Jian a539754c2e Merge branch 'doc/wifi_update_channel_state_information_document' into 'master' 
docs: update channel state information document

See merge request idf/esp-idf!2793
 2018-08-01 14:49:14 +08:00
Roland Dobai 1d1533ee8e expat: Move libexpat into submodule and update to version 2.2.5 2018-07-31 13:25:00 +02:00
krzychb 42cf4429a9 Fixed logo width to display correctly in Chinese version of documentation 2018-07-30 21:16:27 +02:00
David Cermak 1ef13c524c asio: initial idf port of asio library without ssl 2018-07-30 06:28:43 +00:00
Angus Gratton 97286b3107 Merge branch 'feature/cmd_flash_reset_ota_data' into 'master' 
make: Add feature to cmd 'make flash' - reset ota_data partition

See merge request idf/esp-idf!2611
 2018-07-30 13:52:43 +08:00
Alexey Gerenkov 821fe3dc5a esp32: Adds SW flash breakpoints description 2018-07-26 13:56:45 +03:00
Konstantin Kondrashov de2b1cb02a make: Add feature to cmd 'make flash' - reset ota_data partition 
Add a command `make erase_ota` - erases otadata if it there is in the
partition table otherwise error 'Partition table does not have ota_data partition'.

Closes https://github.com/espressif/esp-idf/issues/1821
 2018-07-25 11:22:15 +00:00
krzychb c7ab37143b Logo version 8, vector graphics and a new typeface 2018-07-23 19:18:50 +02:00
Angus Gratton 5f2f84c220 Merge branch 'feature/http_server_finalize' into 'master' 
Feature add HTTP Web Server component

See merge request idf/esp-idf!2606
 2018-07-23 13:11:04 +08:00
Angus Gratton 57342c449d Merge branch 'feature/tools_mass_mfg' into 'master' 
Add files for mass manufacturing tool

See merge request idf/esp-idf!2716
 2018-07-23 13:10:17 +08:00
krzychb 992ead0671 Logo version 7 - gray logo background, improved contrast, simplified css overrides 2018-07-21 20:06:27 +02:00
Ivan Grokhotkov 999c3dbf0e Merge branch 'feature/test_exclude_components' into 'master' 
build: Add TEST_EXCLUDE_COMPONENTS

See merge request idf/esp-idf!2648
 2018-07-20 19:43:46 +08:00
Ivan Grokhotkov 0e3694b542 Merge branch 'feature/freertos_vtasklist_xcoreid' into 'master' 
freertos: Add option to display xCoreID in vTaskList

See merge request idf/esp-idf!2728
 2018-07-20 18:46:41 +08:00
Anurg Kar 656bef7bb7 Http Server : Add a simple light weight HTTP Server Component. 
Also add examples, docs and test apps for the HTTP Server.
 2018-07-20 15:49:17 +05:30
Shivani Tipnis 35205d8513 Add files and docs for mass mfg 2018-07-20 10:41:11 +05:30
Angus Gratton a7d00f44ab Merge branch 'feature/esp32-pico-kit_v4.1' into 'master' 
Added description of ESP32-PICO-KIT V4.1 board

See merge request idf/esp-idf!2762
 2018-07-19 08:05:00 +08:00
krzychb ca15dbd05e Added description of ESP32-PICO-KIT V4.1 board 2018-07-18 20:02:43 +02:00
Ivan Grokhotkov 0b78959070 Merge branch 'bugfix/deep_sleep_flush_uart' into 'master' 
sleep: fix flushing UARTs when entering deep sleep

See merge request idf/esp-idf!2698
 2018-07-18 14:55:13 +08:00
krzychb 2506a9416e Version 2 of the logo, without a frame an with uniform color 2018-07-18 07:03:00 +02:00
krzychb 2fd5ce3022 Made the logo smaller 2018-07-18 07:03:00 +02:00
krzychb da86681f21 Added Espressif logo to documentation 2018-07-18 07:03:00 +02:00
kittinson ae728d66c8 Update theme_overrides.css 
Changed colors in css file, in order to make documentation website look like official website.
 2018-07-18 07:03:00 +02:00
Ivan Grokhotkov cffaa9f5b5 freertos: add configTASKLIST_INCLUDE_COREID 2018-07-17 10:57:26 +00:00
XiaXiaotian 85ad8cfcfc docs: update channel state information document 
1. Move channel to the first row of the table.

    2. Remove the condition of HT20/HT40 for they are determined by
    secondary channel.

    3. Clean up the CSI table.
 2018-07-17 14:50:30 +08:00
Angus Gratton e5d2406b1d Merge branch 'bugfix/spi_cs_setup_fulldup' into 'master' 
fix(spi_master): allow to use cs_ena_pretrans in full duplex mode without…

See merge request idf/esp-idf!2576
 2018-07-16 16:30:36 +08:00
Angus Gratton 68e01045f1 Merge branch 'bugfix/secure_boot_regression_partitions' into 'master' 
Fix secure boot & flash encryption regression, don't verify partitions as part of secure boot

See merge request idf/esp-idf!2764
 2018-07-16 12:07:56 +08:00
Angus Gratton cee6d7d5a9 docs: Add more ReST-isms in secure boot & flash encryption docs 
(Original version of these docs were in Markdown.)
 2018-07-16 11:52:52 +10:00
Angus Gratton 6a498bfe2b docs: Add note about bootloader size for flash encryption & secure boot 2018-07-16 11:52:52 +10:00
Ivan Grokhotkov b354770f42 Merge branch 'bugfix/fixes_from_github' into 'master' 
Fixes from Github

See merge request idf/esp-idf!2730
 2018-07-13 15:03:50 +08:00
Angus Gratton 8b5a2ccb8d docs: Update Flash Encryption docs to clarify reflashing options 2018-07-13 16:18:07 +10:00
Angus Gratton a67d5d89e0 Replace all DOS line endings with Unix 
Command run was:
git ls-tree -r HEAD --name-only | xargs dos2unix
 2018-07-12 19:10:37 +08:00
Angus Gratton 74245d27d3 ci: Add line endings check for CRLF in repository 2018-07-12 19:10:37 +08:00
Angus Gratton 064261cd3a Merge branch 'bugfix/adc_two_point_cal_val_update' into 'master' 
Updated information in  documentation about  'Two Point Values' used to calibrate ADC readings

See merge request idf/esp-idf!2678
 2018-07-11 12:53:33 +08:00
Konstantin Kondrashov bec14ad8ee build: Add TEST_EXCLUDE_COMPONENTS 
To exclude during the build process of unit tests some components.
 2018-07-10 13:44:41 +05:00
Carney Wu 7ccc28de6c alias 需要添加到 .bashrc 文件中 
Merges https://github.com/espressif/esp-idf/pull/2097
 2018-07-09 14:36:47 +08:00
Carney Wu fab55e3266 alias should set in .bashrc 
Merges https://github.com/espressif/esp-idf/pull/2097
 2018-07-09 14:36:47 +08:00
Avraham Shukron 0cab3cecfd doc/wifi: small fixup 
The WiFi station connect sequence diagram does not have any "successful" ending.
It looks like a copy-paste error, because there are two consequent `SYSTEM_EVENT_STA_DISCONNECTED` events firing with nothing happening in between.

I think the original meaning was that the last event should be `SYSTEM_EVENT_STA_CONNECTED` to signify that if all goes well, that is the event that will be fired.

Merges https://github.com/espressif/esp-idf/pull/2065
 2018-07-09 14:35:51 +08:00
Alexey Gerenkov 8fe2a77c46 coredump: Adds support for ROM ELF file to 'espcoredump' script 2018-07-05 22:20:20 +03:00
Darian Leung 1d2727f4c8 CAN Driver 
The following commit contains the first version of the ESP32 CAN Driver.

closes #544
 2018-07-04 14:01:57 +08:00
Ivan Grokhotkov 10c2cddddf sleep: fix flushing UARTs when entering deep sleep 
Since 94250e42a0, UART output is suspended when entering sleep mode
(deep or light sleep). This makes sense for light sleep, where sleep
normally takes small amount of time, and flushing the UART would add
a lot of latency. But this breaks existing behaviour for deep sleep,
where UART output was previously sent out before entering sleep mode.

Closes https://github.com/espressif/esp-idf/issues/2145
 2018-07-04 12:11:25 +08:00
Angus Gratton 909eec9c3b Merge branch 'feature/uart_add_rs485_interface_support' into 'master' 
driver: add rs485 half duplex interface support to uart driver

See merge request idf/esp-idf!2415
 2018-07-03 14:34:33 +08:00
Angus Gratton 52f4ff6220 Merge branch 'feature/spi_little_endien' into 'master' 
feature(spi): provide macro to write multi-byte data straightly

See merge request idf/esp-idf!2634
 2018-07-03 14:32:41 +08:00
Alex Lisitsyn ef5dc73f6f driver: add rs485 half duplex interface support to uart driver (update after review) 
An existing UART driver does not support RS485 half duplex mode.
This task adds this functionality to ESP_IDF UART driver.
driver/uart.c/h: updated to add support of RS485 half duplex mode
examples/peripherals/uart_echo_rs485/main/rs485_example.c: added test example
components/driver/test/test_uart.c: added test of RS485 half duplex mode
docs/en/api-reference/peripherals/uart.rst: updated documentation
test_uart.c: suppress GCC warnings about discarded const qualifiers
uart.rst: remove sphinx warning - "Duplicate explicit target name"
simple change in uart.h file
update (test_uart.c) after rebase from master
update uart.rst, uart.c, rs485_example.c
Update example description in file Readme.md
update uart.c/h, uart.rst, test_uart.c according to review results
update uart.h (uart_set_rx_timeout() description
test_uart.c remove ignore tag
uart.c/h: fix param errors
test_uart.c: Remove GCC warning supress
uart.rst: fix the notes
rs485_example.c: fix output

The tests are completed using RS485 adapters hardware connected to two ESP32 WROVER KITs.

TW#13812
Closes https://github.com/espressif/esp-idf/pull/667
Closes https://github.com/espressif/esp-idf/pull/1006
 2018-07-02 15:24:58 +02:00
Alex Lisitsyn 51e9cf6848 driver: add rs485 half duplex interface support to uart driver (update after review) 
An existing UART driver does not support RS485 half duplex mode.
This task adds this functionality to ESP_IDF UART driver.
driver/uart.c/h: updated to add support of RS485 half duplex mode
examples/peripherals/uart_echo_rs485/main/rs485_example.c: added test example
components/driver/test/test_uart.c: added test of RS485 half duplex mode
docs/en/api-reference/peripherals/uart.rst: updated documentation
test_uart.c: suppress GCC warnings about discarded const qualifiers
uart.rst: remove sphinx warning - "Duplicate explicit target name"
simple change in uart.h file
update (test_uart.c) after rebase from master
update uart.rst, uart.c, rs485_example.c
Update example description in file Readme.md
update uart.c/h, uart.rst, test_uart.c according to review results

The tests are completed using RS485 adapters hardware connected to two ESP32 WROVER KITs.

TW#13812
Closes https://github.com/espressif/esp-idf/pull/667
Closes https://github.com/espressif/esp-idf/pull/1006
 2018-07-02 15:24:58 +02:00
Michael (XIAO Xufeng) 3d23fe9a61 feature(spi): provide macro to write multi-byte data straightly 
resolves https://github.com/espressif/esp-idf/issues/2062
 2018-07-02 15:34:47 +08:00
Angus Gratton fdee0b64a0 Merge branch 'bugfix/doc_blufi' into 'master' 
bugfix/doc_blufi

See merge request idf/esp-idf!2644
 2018-07-02 12:12:48 +08:00
Angus Gratton a8fa4201b9 Merge branch 'docs/eclipse_regex' into 'master' 
Docs: Fix bugs in Eclipse setup in CN

See merge request idf/esp-idf!2620
 2018-07-02 09:18:26 +08:00
krzychb 8a7ee46b7f Fixed link to 'TEMPLATE_EXAMPLE_README.md' 2018-07-01 19:33:37 +02:00
krzychb f4ef7689bd The 'Two Point Values' used to calibrate ADC readings, unlike 'eFuse Vref', are not measured and burned into eFuse BLOCK3 for each individual chip during factory calibration. This operation should be done by user, if more accurate calibration is required. 2018-06-29 19:01:11 +02:00
Jin Fang Cheng Cheng 9e3c3f267e Update eclipse-setup.rst 2018-06-28 17:58:19 +08:00
Jin Fang Cheng Cheng 3d6d252b3e Update eclipse-setup-windows.rst 2018-06-28 17:57:55 +08:00
Jin Fang Cheng Cheng d9653e75e9 Update eclipse-setup.rst 2018-06-28 15:16:20 +08:00
Jin Fang Cheng Cheng 084a6b54e2 Update eclipse-setup-windows.rst 2018-06-28 15:10:36 +08:00
Jin Fang Cheng Cheng a0928b4ce2 Update eclipse-setup-windows.rst 2018-06-28 15:00:40 +08:00
Jin Fang Cheng Cheng f1acb27a66 Fix the tables. 2018-06-28 14:09:14 +08:00
Jin Fang Cheng Cheng dd66dda11e Fix the typo and tables. 2018-06-28 14:06:26 +08:00
Angus Gratton c07ec696dc Merge branch 'bugfix/eclipse_regex' into 'master' 
Docs: Fix bugs in Eclipse setup

See merge request idf/esp-idf!2617
 2018-06-27 09:38:47 +08:00
Angus Gratton d096cac97d Merge branch 'docs/update_resources.rst' into 'master' 
docs/update_resources.rst

See merge request idf/esp-idf!2532
 2018-06-27 08:09:57 +08:00
Angus Gratton e9029fd8de Merge branch 'docs/esp32-devkitv-v4_updates' into 'master' 
Renamed ESP-WROOM-32 to ESP32-WROOM-32/D/U including links to data sheets,…

See merge request idf/esp-idf!2567
 2018-06-27 07:29:52 +08:00
Jin Fang Cheng Cheng c4eff744b3 Fixed link to documentation and updated some wording 2018-06-26 18:28:15 +02:00
krzychb b101e118f2 Renamed ESP-WROOM-32 to ESP32-WROOM-32/D/U including links to data sheets, reflected upcoming ESP32-SOLO-1 as one of options for ESP32-DevKitC, provided updated schematics and notes on C15. 2018-06-26 18:08:47 +02:00
Angus Gratton 2074d36d43 doc: Clarify some Eclipse setup steps 2018-06-26 17:34:29 +10:00
Jin Fang Cheng Cheng 6a1250cf19 Update eclipse-setup.rst 2018-06-26 13:15:13 +08:00
Jin Fang Cheng Cheng fe7647936a Update eclipse-setup-windows.rst 2018-06-26 13:13:08 +08:00
Jin Fang Cheng Cheng d57649aed1 Update eclipse-setup-windows.rst according to https://gitlab.espressif.cn:6688/idf/esp-idf/merge_requests/2617. 2018-06-26 12:55:34 +08:00
Jin Fang Cheng Cheng 0a033b5e05 Update eclipse-setup.rst according to https://gitlab.espressif.cn:6688/idf/esp-idf/merge_requests/2617 2018-06-26 12:54:15 +08:00
Angus Gratton 75dc2f5800 doc: Fix Build Output Parser command pattern to include C++ correctly 
Previously only C files had build output correctly parsed.

Closes https://github.com/espressif/esp-idf/issues/2056

May also relate to:
https://github.com/espressif/esp-idf/issues/529
https://github.com/espressif/esp-idf/issues/17
 2018-06-26 13:47:14 +10:00
Michael (XIAO Xufeng) fe076f5cb9 doc(sdio_slave): add some information of slave protocol 2018-06-25 06:55:19 +00:00
Ivan Grokhotkov 86d6c09387 Merge branch 'bugfix/esp_err_name_idf_path' into 'master' 
docs: fix error code reference build issue

See merge request idf/esp-idf!2587
 2018-06-25 13:41:17 +08:00
michael 8676830e61 fix(spi_master): allow to use cs_ena_pretrans in full duplex mode without command and address phases 2018-06-25 04:30:14 +00:00
Angus Gratton 0a02d824fc partition_table: Warn if the partition table name doesn't match type & subtype 2018-06-22 17:51:34 +10:00
Ivan Grokhotkov 8c87df538e docs: conf.py: check return code when calling os.system 
Several calls were made but results were not checked, obfuscating the
errors.
 2018-06-21 15:22:56 +08:00
Angus Gratton 75d732887b Merge branch 'doc/examples_guide' into 'master' 
docs: Add "Creating Examples" docs page, template example README

See merge request idf/esp-idf!2536
 2018-06-21 13:59:44 +08:00
Ivan Grokhotkov 4b91c82cc4 Merge branch 'feat/sdio_pullup' into 'master' 
feature(sdio): add features to make SDIO slave compatible with more devkits

See merge request idf/esp-idf!2454
 2018-06-20 13:58:56 +08:00
Angus Gratton d0b8f2865f docs: Switch base URL from esp-idf.readthedocs.io to docs.espressif.com 2018-06-19 11:23:33 +00:00
Angus Gratton 86148a740b Merge branch 'feature/fatfs_without_wl' into 'master' 
FATFS support without wear levelling

See merge request idf/esp-idf!2526
 2018-06-18 12:26:02 +08:00
Sagar Bijwe fd7b794e81 FATFS support without wear levelling 
This change allows readonly FATFS to be mounted without wear levelling
support. This will provide the customers a simple way to mount FATFS images
generated on host and flashed onto the chip during factory provisioning.
Since NVS encryption is not supported yet and NVS entry size is limited,
the change will provide an easy alternative for securing the provisioning data
by just marking FATFS parition as encrypted.
 2018-06-16 16:02:35 +08:00
Michael (XIAO Xufeng) 9377575415 docs(spi_master): fix wavedrom image and comment mistake 2018-06-15 17:38:27 +08:00
Ivan Grokhotkov efd16673bc docs: add pages about error handling 2018-06-15 15:53:23 +08:00
Ivan Grokhotkov d9f8311b9d docs: add error codes reference 2018-06-15 15:49:24 +08:00
Ivan Grokhotkov 5e0a3d99e8 Kconfig: split out compiler options, add them to reference 2018-06-15 15:49:23 +08:00
Ivan Grokhotkov b1b1257476 docs/ulp: fix instruction fetch and execution times 2018-06-14 19:42:31 +08:00
Angus Gratton df4e227855 docs: Add "Creating Examples" docs page, template example README 2018-06-14 16:49:22 +10:00
Angus Gratton 59ab2136e8 Merge branch 'doc/kconfig_item' into 'master' 
doc: fix the level inconsistent issue in Kconfig document

See merge request idf/esp-idf!2460
 2018-06-14 12:51:50 +08:00
michael 85b08684e3 doc(sdio_slave): add descriptions about conflicts on MTDI pin 2018-06-14 12:04:23 +08:00
Ivan Grokhotkov 70eed4c284 Merge branch 'docs/update_eclipse-setup' into 'master' 
Docs/update_eclipse-setup

See merge request idf/esp-idf!2528
 2018-06-11 23:20:24 +08:00
Angus Gratton 84f78110dd Merge branch 'feature/esp_timer_example' into 'master' 
examples: add esp_timer example

See merge request idf/esp-idf!2494
 2018-06-11 11:44:45 +08:00
Ivan Grokhotkov 03d78e7afb Merge branch 'feature/Add_noinit_rtc_noinit_sections' into 'master' 
esp32: Add .noinit and .rtc_noinit sections to the linker script

See merge request idf/esp-idf!1996
 2018-06-08 16:01:30 +08:00
Angus Gratton bcd4fb9944 Merge branch 'doc/jtag_startup_command_fix' into 'master' 
docs/jtag: use 'flushregs' instead of 'x $a1=0' in gdbinit

See merge request idf/esp-idf!2520
 2018-06-08 15:15:29 +08:00
XuanZe dc30603242 Translate the resources.rst Merges https://github.com/espressif/esp-idf/pull/1979 2018-06-08 14:58:36 +08:00
Ivan Grokhotkov f47af6185d docs/jtag: use ‘flushregs’ instead of ‘x $a1=0” in gdbinit 
The old command caused was incorrect (x is “examine”, not “execute”)
and caused GDB register update only by chance. This replaces it with
“flushregs” command which purpose is exactly that — force GDB to
fetch registers from the remote.
 2018-06-08 11:45:46 +08:00
Jin Fang Cheng Cheng f9a3368f28 Update eclipse-setup.rst 2018-06-08 11:00:29 +08:00
Angus Gratton c8d3c6a494 Merge branch 'feature/monitor_filter_output' into 'master' 
idf_monitor: add support for filtering options

See merge request idf/esp-idf!2486
 2018-06-08 08:09:40 +08:00
Ivan Grokhotkov ab538bb9f3 Merge branch 'feat/spi_master_timing' into 'master' 
feature(spi_master): fine tune the timing of spi master

See merge request idf/esp-idf!2301
 2018-06-07 20:19:06 +08:00
Angus Gratton 950dd8e3e5 docs: Standardise CMake vs cmake 2018-06-07 15:18:48 +10:00
Angus Gratton 6065d2fd08 kconfig: Add confserver.py to expose sdkconfig to clients 2018-06-07 14:23:08 +10:00
Ivan Grokhotkov 2f5cd89833 examples: add esp_timer example 2018-06-07 11:59:36 +08:00
Angus Gratton d7d559a489 Merge branch 'doc/api-guides_blufi' into 'master' 
Doc/api guides blufi

See merge request idf/esp-idf!2376
 2018-06-07 08:54:27 +08:00
Angus Gratton 70c6f8a803 Merge branch 'bugfix/few_typos_in_docs' into 'master' 
Fix few typos in documentation

See merge request idf/esp-idf!2519
 2018-06-07 08:24:23 +08:00
krzychb 713141e631 Replaced ASCII art drawings with blockdiag drawings 2018-06-06 23:27:05 +02:00
Mahavir Jain 6e48e52478 docs: fix flash_encryption key generation command 
Signed-off-by: Mahavir Jain <mahavir@espressif.com>
 2018-06-06 18:21:00 +05:30
michael 5cf7d3768d feat(spi_master): fine tune the timing of SPI 2018-06-06 06:08:39 +00:00
Jin Fang Cheng Cheng b889305c1b Update blufi.rst 2018-06-06 12:11:57 +08:00
Jin Fang Cheng Cheng 4a25f18f21 Update blufi.rst 2018-06-06 12:05:27 +08:00
Jin Fang Cheng Cheng ad48c2689f Update blufi.rst 2018-06-06 11:58:46 +08:00
Jin Fang Cheng Cheng 3a15efd3c3 Delete api-guides_blufi.png 2018-06-06 11:46:13 +08:00
michael 3ba8461928 doc: fix the level inconsistent issue in Kconfig document 2018-06-05 10:36:18 +00:00
Roland Dobai 51e42d8e92 idf_monitor: add support for filtering options 2018-06-05 12:23:27 +02:00
Angus Gratton b2ff235bd0 Merge branch 'bugfix/github_prs' into 'master' 
Merge some small fixes from Github

See merge request idf/esp-idf!2500
 2018-06-05 11:51:35 +08:00
Angus Gratton a8504b9628 docs: eclipse: Reword sentence, copy to Windows Eclipse guide also 
Ref https://github.com/espressif/esp-idf/pull/1990
 2018-06-05 09:53:59 +10:00
Jiang Jiang Jian 8a4c9d7dfb Merge branch 'doc/wifi_channel_state_information' into 'master' 
add document of channel state information

See merge request idf/esp-idf!2468
 2018-06-04 17:59:05 +08:00
wushifu32 736e10749f correct eclipse build command 
Merges https://github.com/espressif/esp-idf/pull/2024
 2018-06-04 17:19:28 +10:00
Wenderson Oliveira 2a6c35c9af Update eclipse-setup.rst 
This is workaround for eclipse indexer problems. When I disable that option, my problems with eclipse and header files are gone.

Merges https://github.com/espressif/esp-idf/pull/1990
 2018-06-04 16:47:03 +10:00
Jin Fang Cheng Cheng 27d1a5d51e Update index.rst 2018-06-04 14:24:40 +08:00
Jin Fang Cheng Cheng bf29c7ca57 Update index.rst 2018-06-04 14:24:10 +08:00
Jin Fang Cheng Cheng 4232f69f98 Update blufi.rst 2018-06-04 14:22:04 +08:00
Jin Fang Cheng Cheng aff4696cc4 Update blufi.rst 2018-06-04 14:21:12 +08:00
Xia Xiaotian 7d5ef3c765 add document of channel state information 2018-06-01 15:45:00 +08:00
Angus Gratton 8bb4c694ce cmake: Add COMPONENT_SRCEXCLUDE option 2018-05-31 14:46:39 +10:00
Angus Gratton 6b9784cc45 Merge branch 'master' into feature/cmake_update 2018-05-31 14:46:23 +10:00
Ivan Grokhotkov cb649e452f remove executable permission from source files 2018-05-29 20:07:45 +08:00
Angus Gratton e100acbb73 docs: Minor cleanup of getting started docs 2018-05-29 16:34:45 +10:00
Angus Gratton 580cfeaaae idf.py: Print flashing steps at the end of each build 2018-05-29 16:34:45 +10:00
Angus Gratton 955e84a3bc docs: Add some clarifications for Mac OS users 2018-05-29 16:34:45 +10:00
Angus Gratton f6cd55d2ac config: Rename mconf to mconf-idf & conf to conf-idf 
These versions of conf/mconf are forked from the upstream, and the CMake system allows mconf-idf to
be installed externally on the path. So the best option is to rename.

Includes changes to Windows installer for v1.1
 2018-05-29 16:34:45 +10:00
Angus Gratton 11980a9ad4 docs: Add port argument to idf.py monitor 2018-05-29 16:34:45 +10:00
Angus Gratton 6cc5971516 docs: Add some clarification about ~/.profile 2018-05-29 16:34:45 +10:00
Angus Gratton be4956fe7c docs: Add some tips about setting the Python interpreter, and a specific check in idf.py 
Don't show the "Python 2 interpreter" option in menuconfig when using CMake.

This is a stop-gap until we support Python 2 & 3 together in ESP-IDF (soon).

Closes https://github.com/espressif/esp-idf/issues/1924
 2018-05-29 16:34:45 +10:00
Angus Gratton a1fac97f1a cmake: Fix set_default using value from environment 
Fixes issue with idf.py passing through Python interpreter, as reported in
https://github.com/espressif/esp-idf/issues/1924
 2018-05-29 16:34:45 +10:00
Angus Gratton 979568fa0b docs: Separate "build and flash" into building then flashing 
Explains idf.py build as mentioned here: https://github.com/espressif/esp-idf/issues/1906#issuecomment-387557050
 2018-05-29 16:34:45 +10:00
Angus Gratton f07c1ca94f docs: Fix some Windows Command Prompt paths 
Reported in https://github.com/espressif/esp-idf/issues/1906
 2018-05-29 16:34:45 +10:00
Angus Gratton cc104eb05b cmake: Add sdkconfig.h directory to include paths list not just compiler args 
Also move into 'build/config/' subdir, remove creation of empty include/config dir.
 2018-05-29 16:34:45 +10:00
Jin Fang Cheng Cheng 8b884c4deb Update blufi.rst 2018-05-25 15:09:34 +08:00
Jin Fang Cheng Cheng 1001083b1b Update blufi.rst 2018-05-25 15:09:34 +08:00
Jin Fang Cheng Cheng ad3af2cfc1 Update blufi.rst 2018-05-25 15:09:34 +08:00
Jin Fang Cheng Cheng 02d4168d68 Update blufi.rst 2018-05-25 15:09:34 +08:00
Jin Fang Cheng Cheng 27e4bea699 Update blufi.rst 2018-05-25 15:09:34 +08:00
Jin Fang Cheng Cheng d0bf4a0e23 Update blufi.rst 2018-05-25 15:09:33 +08:00
Jin Fang Cheng Cheng 5a3f351207 Update blufi.rst 2018-05-25 15:09:33 +08:00
Jin Fang Cheng Cheng 27d22a7574 Update index.rst 2018-05-25 15:09:33 +08:00
Jin Fang Cheng Cheng 0ea39a72b0 Update blufi.rst 2018-05-25 15:09:33 +08:00
Jin Fang Cheng Cheng b443075133 Update index.rst 2018-05-25 15:09:33 +08:00
Jin Fang Cheng Cheng 7db69b4da3 Update blufi.rst 2018-05-25 15:09:33 +08:00
Jin Fang Cheng Cheng 241048c9f9 Update blufi.rst 2018-05-25 15:09:33 +08:00
Jin Fang Cheng Cheng 75021e376a Upload api-guides_blufi.png 2018-05-25 15:09:33 +08:00
Jin Fang Cheng Cheng dd0bbebd4a Upload blufi.rst 2018-05-25 15:09:33 +08:00
Jin Fang Cheng Cheng 799771b3fa Upload blufi.rst 2018-05-25 15:09:33 +08:00
Angus Gratton c7bedc80c1 Merge branch 'feature/bootloader_factory_reset' into 'master' 
bootloader: Add factory reset and start test app

See merge request idf/esp-idf!2291
 2018-05-25 08:17:48 +08:00
Konstantin Kondrashov ae10abff2f bootloader: Add factory reset and start test app 
Added feature:
- reset firmware to Factory app.(by long pressing of the button)
- boot Test app. (by long pressing of the button)
- Added feature erase data partitions from factory reset.

TW10281
TW10280
 2018-05-24 16:56:49 +05:00
Ivan Grokhotkov c03dff473b Merge branch 'docs/make_core_dump_doc_clear' into 'master' 
docs: Makes core dump's documentation slightly clearer

See merge request idf/esp-idf!2433
 2018-05-24 17:38:28 +08:00
Angus Gratton 21e085d235 Merge branch 'feature/xRingBufferCanRead_pr1672' into 'master' 
freeRTOS/Re-factor ring buffers and add xRingbufferCanRead, xRingbufferCanWrite

See merge request idf/esp-idf!2214
 2018-05-23 15:09:40 +08:00
Alexey Gerenkov 3fd199c54a docs: Makes core dump's documentation slightly clearer 
Merges https://github.com/espressif/esp-idf/pull/1968
 2018-05-22 20:24:29 +03:00
Jiang Jiang Jian f453877759 Merge branch 'feature/multi_antenna_v3.1' into 'master' 
esp32: add multiple antenna

See merge request idf/esp-idf!2400
 2018-05-22 23:04:01 +08:00
Liu Zhi Fu 04c74efedd esp32: add multiple antenna 
1. Support multiple antenna support
2. libphy.a is updated to v3910
 2018-05-22 22:28:00 +08:00
Jiang Jiang Jian 72c2a6f1c6 Merge branch 'feature/proto-client' into 'master' 
HTTP Client

See merge request idf/esp-idf!1521
 2018-05-22 21:06:46 +08:00
Ivan Grokhotkov d7726e8f97 Merge branch 'bugfix/docs_fix_vcp_driver_link_v2' into 'master' 
docs: fix (in remaining places) link for FTDI VCP drivers

See merge request idf/esp-idf!2424
 2018-05-22 16:55:59 +08:00
Ivan Grokhotkov 9da4df8f55 Merge branch 'bugfix/docs_esp-wrover-kit_and_touch-sensor' into 'master' 
docs: updated esp wrover kit jumpers and touch sensor links

See merge request idf/esp-idf!2422
 2018-05-22 16:22:30 +08:00
Mahavir Jain 8ad8a44709 docs: fix (in remaining places) link for FTDI VCP drivers 
Signed-off-by: Mahavir Jain <mahavir@espressif.com>
 2018-05-22 08:21:37 +00:00
krzychb 42b1ec76b7 Provided links to 'Touch Sensor Application Note' and 'Guide for ESP32-Sense Development Kit' 2018-05-21 19:29:36 +02:00
krzychb 6d85d159d6 Updated pictures of user configurable jumpers to reflect Version 3 of ESP-WROVER-KIT. 
This includes changing the picture of JTAG jumper block by removing the jumper on S_TDI. It has been reported by a number of users that removing this jumper fixes random communication issues observed in OpenOCD.
 2018-05-21 19:29:36 +02:00
michael 1b45e1117b doc(sdio_slave): documentation for SDIO slave driver 2018-05-21 23:48:56 +08:00
Jiang Jiang Jian adcad91c55 Merge branch 'feature/btdm_hfp_hf' into 'master' 
component/bt: implement HFP Hands Free Unit Role

See merge request idf/esp-idf!2306
 2018-05-21 13:56:52 +08:00
wangmengyang 4c4e143a2f component/bt: implement HFP Hands Free Unit Role 2018-05-21 11:33:30 +08:00
Angus Gratton 9802c3e32c Merge branch 'doc/language_link' into 'master' 
docs: add language link to easily change to Chinese version.

See merge request idf/esp-idf!2051
 2018-05-21 11:00:37 +08:00
Angus Gratton 6363396eba Merge branch 'feature/freertos_tickless_idle' into 'master' 
freertos,esp32: automatic light sleep support

See merge request idf/esp-idf!2247
 2018-05-21 10:59:00 +08:00
Tuan PM ff528d13c7 Add esp_http_client 
Add error handling for http client

set ssid password correct with Example_WIFI test, and clear password before free

Fixed the CI failure due to HTTP errror names
 2018-05-21 09:35:07 +07:00
michael d4deb9319a doc(global): build cross-language links for translated documents 2018-05-21 10:30:13 +08:00
Michael (Xiao Xufeng) 2852dd37fb docs: add language link to easily change to Chinese version 2018-05-21 10:30:12 +08:00
krzychb d754b53ae2 Implemented docutils custom role that renders a link to current documentation page on Read The Docs in another language version 
Provided documentation of the role.
 2018-05-21 10:30:07 +08:00
Darian Leung 4bfa30967f freeRTOS/Re-factor ring buffers 
This fixes multiple bugs with ring buffers and re-factors the code. The public
API has not changed, however the underlying implementation have various private
functions have been changed. The following behavioral changes have been made

-   Size of ring buffers for No-Split/Allow-Split buffers will not be rounded
    up to the nearest 32-bit aligned size. This was done to simplify the
    implementation

-   Item size for No-Split/Allow-Split buffers will also be rounded up to the
    nearest 32-bit aligned size.

The following bugs have been fixed

-   In copyItemToRingbufAllowSplit(), when copying an item where the aligned
    size is smaller than the remaining length, the function does not consider
    the case where the true size of the item is less than 4 bytes.

-   The copy functions will automatically wrap around the write pointers when
    the remaining length of the buffer is not large enough to fit a header, but
    does not consider if wrapping around will cause an overlap with the read
    pointer. This will make a full buffer be mistaken for an empty buffer

closes #1711
-   xRingbufferSend() can get stuck in a infinite loop when the size of the
    free memory is larger than the needed_size, but too small to fit in the ring
    buffer due to alignment and extra overhead of wrapping around.

closes #1846
-   Fixed documentation with ring buffer queue set API

-   Adding and removing from queue set does not consider the case where the
    read/write semaphores actually hold a value.

The following functions have been deprecated
    - xRingbufferIsNextItemWrapped() due to lack of thread safety
    - xRingbufferAddToQueueSetWrite() and xRingbufferRemoveFromQueueSetWrite()
    as adding the queue sets only work under receive operations.

The following functions have been added
    - xRingbufferReceiveSplit() and xRingbufferReceiveSplitFromISR() as a thread
    safe way to receive from allow-split buffers
    - vRingbufferGetInfo()

Documentation for ring buffers has also been added.
 2018-05-21 01:04:58 +00:00
Lin Meiling 6e77e68c96 Update idf-monitor.rst 2018-05-21 00:20:08 +00:00
Mahavir Jain b2ec58af1c docs: fix link for FTDI VCP drivers 
Signed-off-by: Mahavir Jain <mahavir@espressif.com>
 2018-05-18 17:09:53 +05:30
Roland Dobai 18e83bcd53 Allow VFS file descriptors in select() 2018-05-18 08:06:33 +02:00
Ivan Grokhotkov 45d3b1f4b1 docs: update information about automatic light sleep 2018-05-18 03:14:46 +00:00
Alex Lisitsyn 44b1bc0ab9 esp32: Add .noinit and .rtc_noinit sections to the linker script 
Added .rtc_noinit and .noinit section definitions into linker file /esp32/ld/esp32.common.ld.
The macro __NOINIT_ATTR, RTC_NOINIT_ATTR declared in esp32/esp_attr.h file.
Added unit test file to test added behavior for noinit variables and its attributes.
Added documentation changes for new added attributes.
Make some corrections after code review:
The linker file has been corrected to place noinit section before bss_start to make it safer.
Documentation file has been modified to clarify reset behavior of allocated data .
Corrected typos in test_noinit.c and removed assertion of noinit variable to avoid possible issues with ROM boot loader memory allocation.
The linker file has been corrected to place noinit section before bss_start to make it safer.
Documentation file has been modified to clarify reset behavior of allocated data .
Corrected typos in test_noinit.c and removed assertion of noinit variable to avoid possible issues with ROM boot loader memory allocation.
Update test_noinit.c file to address RTCWDT_RTC_RESET reset reason instead of POWERON_RESET.
Test optimized to pass automated unit testing.
esp32: Add .noinit and .rtc_noinit sections to the linker script
Update of general-notes.rst documentation to fomat examples as code and attributes as identifiers.
Test test_noinit.c corrected to pass automated testing (support ofTEST_CASE_MULTIPLE_STAGES())

https://ezredmine.espressif.cn:8765/issues/15878
 2018-05-16 17:33:37 +05:00
Angus Gratton f147a8d73d Merge branch 'bugfix/docs_small_updates' into 'master' 
Bugfix/docs small updates

See merge request idf/esp-idf!2392
 2018-05-16 19:53:40 +08:00
Liu Zhi Fu 846b848bfc esp32/docs: fully support esp_wifi_80211_tx 
Closes https://github.com/espressif/esp-idf/issues/1256
Closes https://github.com/espressif/esp-idf/issues/1332
 2018-05-16 13:37:54 +08:00
krzychb d19dbea059 Fixed git command 2018-05-15 22:36:34 +02:00
Wenderson Oliveira 6722a78684 Fix git command. Merges https://github.com/espressif/esp-idf/pull/1943 2018-05-15 22:34:01 +02:00
Angus Gratton c522f44276 Merge branch 'doc/update_licenses' into 'master' 
docs: update list of third-party libraries, copyrights, and licenses

See merge request idf/esp-idf!2381
 2018-05-15 11:13:20 +08:00
Ivan Grokhotkov 79de77107f docs: update list of third-party libraries, copyrights, and licenses 2018-05-15 10:01:20 +08:00
krzychb 684d211af3 Corrected link rendering and additional translations 2018-05-14 19:06:43 +02:00
XuanZe 3b44e24db0 Update index.rst. Merges https://github.com/espressif/esp-idf/pull/1747 2018-05-09 07:30:54 +02:00
Angus Gratton 829e6c44f1 cmake docs: Specify feature/cmake branch when cloning from Github 
As mentioned here https://github.com/espressif/esp-idf/issues/1906#issuecomment-387377493
 2018-05-08 22:05:43 +08:00
Angus Gratton 6f31674b28 cmake: Add ESPORT/ESPBAUD environment variables to idf.py & docs 2018-05-07 18:45:49 +08:00
Angus Gratton b7ddb0c3d3 Revert "docs: Temporarily allow cmake docs to be in English only" 
This reverts commit d5a5897140.
 2018-05-07 18:45:49 +08:00
Angus Gratton c7f19e76d7 docs: Move main docs to cover CMake 
Add "GNU Make build system" doc with "cheat sheet" for moving to new system
 2018-05-07 18:45:49 +08:00
Angus Gratton 06082d9308 Merge branch 'doc/spi_master_thread_safety' into 'master' 
driver: Add notes to SPI driver docs about thread safety

See merge request idf/esp-idf!2354
 2018-05-07 14:49:41 +08:00
Ivan Grokhotkov 60a0f25450 Merge branch 'bugfix/docs_conf_py3_compat' into 'master' 
docs: make conf.py python3 compatible

See merge request idf/esp-idf!2344
 2018-05-07 09:07:44 +08:00
Angus Gratton b90ad81f22 driver: Add notes to SPI driver docs about thread safety 2018-05-07 09:03:48 +08:00
Ivan Grokhotkov e3a5974651 docs: make conf.py python3 compatible 2018-05-04 02:31:57 +08:00
Hrishikesh Dhayagude d530036ad1 Fix few typos in the docs 
Signed-off-by: Hrishikesh Dhayagude <hrishi@espressif.com>
 2018-05-03 18:20:16 +05:30
Ivan Grokhotkov 5f956125c1 Merge branch 'feature/mfg_bin_create_utility' into 'master' 
nvs_flash: Add external binary creation support for NVS partition.

See merge request idf/esp-idf!2031
 2018-05-02 11:58:38 +08:00
Angus Gratton 48c3ad37f1 docs/cmake: Add some notes about need to set IDF_PATH and/or PATH in certain configurations 2018-05-01 17:27:39 +10:00
Angus Gratton 2fadf8a000 cmake docs: Fix variable expansion when adding tools dir to PATH 2018-05-01 17:27:39 +10:00
Angus Gratton f6db61e4f4 cmake docs: Fix Windows tools installer download URL 2018-04-30 15:44:05 +10:00
Angus Gratton d5a5897140 docs: Temporarily allow cmake docs to be in English only 2018-04-30 10:18:33 +10:00
Angus Gratton 99e02d4e42 windows: New ESP-IDF Tools Installer 
Working on 64-bit Windows only due to Ninja binary.
 2018-04-30 10:18:33 +10:00
Angus Gratton 381be65472 cmake: Build all examples in CI 
Includes some fixes for compile errors/warnings in examples.
 2018-04-30 10:18:33 +10:00
Angus Gratton 1cb5712463 cmake: Add component dependency support 
Components should set the COMPONENT_REQUIRES & COMPONENT_PRIVATE_REQUIRES variables to define their
requirements.
 2018-04-30 09:59:20 +10:00
Angus Gratton f1d3bfc0c7 cmake: Add new flasher_args.json file for IDE parsing, document metadata files better 2018-04-30 09:59:20 +10:00
Angus Gratton 2a3e2b8eed doc: Use confgen.py to build docs from same code path as config generation 2018-04-30 09:59:20 +10:00
Angus Gratton 88df8fd293 cmake: Use cmake_lint project, tidy up all CMake source files 2018-04-30 09:59:20 +10:00
Angus Gratton 15d5e88618 cmake: Automatically include ccache if it's on the path 2018-04-30 09:59:20 +10:00
Angus Gratton 9f8cdd3572 cmake: Add "Preview release" getting start guide & build system documentation 2018-04-30 09:59:20 +10:00
Tian Hao adada3f67e component/bt : modify header files to avoid conflict 
1. add the L1 include path with a prefix, such like osi/list.h, stack/a2d_api.h and etc.
2. modify component, only bluedroid/api/include/api is export to another component and application,
   other include path just for bluedroid used
3. put bluedroid/include into common/include/common, so the root directory of bluedroid have no include path.
4. modify doxygen to use esp_bt.h and redirect to
component/bt/bluedroid/api/include/api/

fix compile
 2018-04-26 19:32:06 +08:00
Ivan Grokhotkov f885e8b8de Merge branch 'doc/openocd_release_update' into 'master' 
docs: update download links for OpenOCD

See merge request idf/esp-idf!2259
 2018-04-25 12:22:21 +08:00
Amit Sheth aa357a32bc nvs_flash: Add binary creation support for NVS partition. 
Ideally suited for generating a binary externally, containing key-value pairs specific
to device manufacturers. Utility allows creation of a binary, compatible
with NVS structure, which can be separately flashed onto a new
partition. This helps device manufacturers set different values for
different devices, e.g. serial numbers, but using a single firmaware
image.
 2018-04-23 00:27:29 +05:30
Ivan Grokhotkov 6185e722c3 Revert "Merge branch 'feature/vfs_select' into 'master'" 
This reverts merge request !2074
 2018-04-20 11:51:41 +08:00
Ivan Grokhotkov 88d0d6ffb0 Merge branch 'feature/vfs_select' into 'master' 
Allow VFS file descriptors in select()

See merge request idf/esp-idf!2074
 2018-04-19 15:06:02 +08:00
Ivan Grokhotkov fbb3610c0b Merge branch 'feature/bootloader_refactoring_common' into 'master' 
bootloader: Refactoring

See merge request idf/esp-idf!2251
 2018-04-19 14:58:00 +08:00
Ivan Grokhotkov 96b4a45cde Merge branch 'feature/remove_make_dependency_on_git' into 'master' 
make: remove build system dependency on `git` using some hooks

See merge request idf/esp-idf!2211
 2018-04-19 13:01:12 +08:00
Mahavir Jain 8fd4ee1b1f docs: add note regarding ESP-IDF version 
Signed-off-by: Mahavir Jain <mahavir@espressif.com>
 2018-04-18 18:30:58 +05:30
Ivan Grokhotkov bcc5bad7b5 docs: update download links for OpenOCD 
Point to the latest release on Github, which can now be produced by CI.

Ref. https://github.com/espressif/openocd-esp32/issues/30
Ref. https://github.com/espressif/openocd-esp32/issues/18
 2018-04-18 20:58:04 +08:00
Konstantin Kondrashov 86256b3541 bootloader: Refactoring 
Need to make the bootloader modular so that users can redefine its functional part.

- refactoring and moving functions to the bootloader_support component
- Changed function to `void` bootloader_utility_load_image(...);

TW19596
 2018-04-17 16:36:49 +05:00
Roland Dobai 6852d653bd Allow VFS file descriptors in select() 2018-04-17 11:25:30 +02:00
michael bb69dbbef1 add github issue template for users to report issues easily 2018-04-16 08:16:13 +00:00
Ivan Grokhotkov d18c284df6 Merge branch 'bugfix/docs_wrap_text_in_tables' into 'master' 
Bugfix/docs wrap text in tables

See merge request idf/esp-idf!2209
 2018-04-13 19:37:49 +08:00
Ivan Grokhotkov c876ab390b Merge branch 'bugfix/cn_windows_setup_doc_fixes' into 'master' 
Update windows-setup.rst

See merge request idf/esp-idf!2232
 2018-04-12 16:37:41 +08:00
Angus Gratton e2cad1a048 Merge branch 'doc/esp_idf_requires_gcc' into 'master' 
doc: Add gcc to list of ESP-IDF prerequisite packages

See merge request idf/esp-idf!2221
 2018-04-12 08:48:39 +08:00
Ivan Grokhotkov e148c2a12c docs: update SDMMC and SDSPI documentation 
- Split SDMMC page into pages about SDMMC/SDSPI hosts and a page about
   the protocol layer.
- Use autogenerated API reference instead of manually generated one.
- Add information about SDIO APIs.
 2018-04-11 11:07:13 +08:00
Angus Gratton eb731030a4 doc: Add gcc to list of ESP-IDF prerequisite packages 
Closes https://github.com/espressif/esp-idf/issues/1842#issuecomment-380274150
 2018-04-11 10:19:24 +10:00
Angus Gratton 2bfef060ba Merge branch 'bugfix/small_fixes_from_github' into 'master' 
Bugfix/small fixes from github

See merge request idf/esp-idf!2200
 2018-04-10 09:19:19 +08:00
Ivan Grokhotkov d88f2582cf Merge branch 'feature/build_exclude_components' into 'master' 
make: EXCLUDE_COMPONENTS

See merge request idf/esp-idf!2204
 2018-04-09 19:13:39 +08:00
krzychb 43fb8033ec ReadTheDocs theme has an annoying bug of text not being wrapped inside table cells. Each row is extended to fit the text as a single line. For a table with multiple columns and long sentences the table may get wide, with long scrollbar underneath and is not convenient to read. This MR makes the text wrap inside table cells. There is an open PR to fix this issue - https://github.com/rtfd/sphinx_rtd_theme/pull/432. 2018-04-09 05:47:36 +02:00
krzychb d56a44ac79 Fixed issues with tables 2018-04-09 05:46:57 +02:00
Daniel Miller 9acebb08fe doc: spelling 
Merges https://github.com/espressif/esp-idf/pull/1800
 2018-04-09 12:28:21 +10:00
Daniel Miller 32e0903561 doc: Spelling 
Merges https://github.com/espressif/esp-idf/pull/1798
 2018-04-09 12:28:15 +10:00
ndotb 765824e1fd make: EXCLUDE_COMPONENTS 
Add project build variable, documentation for EXCLUDE_COMPONENTS
 2018-04-08 13:07:43 -04:00
Lv Xin Yue 4810f5d02e Update windows-setup.rst 2018-04-08 17:05:02 +08:00
Jitin George 254212b02b changes to accomodate new Doc structure 2018-04-06 17:16:27 +05:30
Jitin George e29294b49a Resolved Issues 2018-04-06 17:16:27 +05:30
Jeroen Domburg f586f5e690 Merge branch 'feature/get-started-20180130' into 'master' 
Feature/get started 20180130

See merge request idf/esp-idf!1898
 2018-04-05 09:54:17 +08:00
qiyueixa 2984cdbbe3 add mesh feature 2018-04-04 22:57:45 +08:00
Xia Xiaotian e72f7e7ec4 Add more description for WiFi modem sleep in document and example. 2018-04-04 16:47:03 +08:00
Ivan Grokhotkov d7c8866896 Merge branch 'test/support_multi_stage_unit_test_case' into 'master' 
unit-test-app: support multi stage unit test case

See merge request idf/esp-idf!2139
 2018-04-03 18:20:16 +08:00
Ivan Grokhotkov 139d49894c Merge branch 'feature/deactivate_wakeup_trigger' into 'master' 
esp32: Add deactivation of wake up trigger for different sources

See merge request idf/esp-idf!2079
 2018-04-03 15:19:10 +08:00
Ivan Grokhotkov 5fdc978626 Merge branch 'doc/spi_speed' into 'master' 
doc(spi_master): add descriptions about the SPI master speed

See merge request idf/esp-idf!2145
 2018-04-03 15:17:25 +08:00
michael e0b05c29f1 doc(spi_master): add descriptions about the SPI master speed 
Closes https://github.com/espressif/esp-idf/issues/1542, Closes https://github.com/espressif/esp-idf/issues/1008
 2018-04-02 12:44:19 +00:00
island 9b7454de0c support wifi&bt coexist (v0.9.1) 
1. refactor wifi modem sleep
2. refactor wifi and bt phy enable/diable coexistence
3. support wifi&bt coexist (v0.9.1)
3. add coex pause resume
4. fix bt library interrupt reaction slowly
5. make a2dp more smooth when coex
6. add coexist preference option
7. Make CI do not check libcoexist.a printf/ets_printf
8. disable Wifi RX AMPDU when software coexistence enable && update wifi lib
9. bluetooth call modem sleep api
 2018-04-02 13:44:48 +08:00
He Yin Ling fee844d22c unit-test-app: support multi stages test 2018-03-30 11:38:49 +08:00
Lin Meiling 707785c306 Update idf-monitor.rst 2018-03-29 14:16:22 +08:00
Roland Dobai 7c4b3d50f8 Make error codes globally unique 2018-03-27 08:12:54 +02:00
Ivan Grokhotkov 9ea38560ec Merge branch 'feature/docs_check_lang_folder_sync' into 'master' 
Introduced a CI check if folders with localized documentation are in sync, i.e.…

See merge request idf/esp-idf!2073
 2018-03-26 16:54:04 +08:00
Lin Meiling 8e7fce51a2 docs: add get-started doc Chinese translation 2018-03-23 14:42:14 +01:00
Ivan Grokhotkov 5bc724d3f9 Merge branch 'feature/configure_pthread_behaviour' into 'master' 
pthread: Allow configuration of priority and stacksize

See merge request idf/esp-idf!1978
 2018-03-21 00:41:20 +08:00
Kedar Sovani 7a0cab0a5b pthread: Allow configuration of priority and stacksize 
The expected usage is:
  esp_pthread_set_cfg(cfg);
  pthread_create()

If the inherit flag is set, then all subsequent threads forked by this
thread will also inherit this configuration. This avoids having to
change/prefix this for each and every pthread_create() call.
 2018-03-20 18:06:32 +05:30
Alex Lisitsyn d91e2703f4 esp32: Deactivate wakeup trigger after first wakeup 
The files updated according to code review discussions.
In the sleep_modes.c removed immidiate disable of ULP  mode and leave just trigger deactivation.
The esp_sleep.h is updated to have the same defines for source as esp_sleep_wakeup_cause_t.
Updated documentation in sleep_modes.rst file to include cross references and address esp_sleep_wakeup_cause_t type.
Some minor changes in test_sleep.c unit test.

(TW#18952)
Closes https://github.com/espressif/esp-idf/issues/1677
 2018-03-20 14:58:43 +05:00
Alex Lisitsyn 1e9bb5bb7c esp32: Deactivate wakeup trigger after first wakeup 
The files updated according to code review discussions.
In the sleep_modes.c removed immidiate disable of ULP  mode and leave just trigger deactivation.
The esp_sleep.h is updated to have the same defines for source as esp_sleep_wakeup_cause_t.
Updated documentation in sleep_modes.rst file to include cross references.
Some minor changes in test_sleep.c unit test.

(TW#18952)
Closes https://github.com/espressif/esp-idf/issues/1677
 2018-03-20 12:23:32 +05:00
Ivan Grokhotkov 7e2028d598 Merge branch 'bugfix/gpio_timer_doc_fixes' into 'master' 
Minor fixes of GPIO and timer group driver docs

See merge request idf/esp-idf!2081
 2018-03-20 10:49:36 +08:00
Ivan Grokhotkov e56897b7a4 Merge branch 'bugfix/docs_updates_from_github' into 'master' 
Bugfix/docs updates from github

See merge request idf/esp-idf!2057
 2018-03-20 09:50:43 +08:00
Stefan Tauner 757c1d6739 docs: explicitly note that timer alarms are not recurring 
Merges https://github.com/espressif/esp-idf/pull/1740
 2018-03-19 11:56:57 +08:00
John f32abada86 Update building-openocd-linux.rst. Merges https://github.com/espressif/esp-idf/pull/1714 
replace - for -- in line 16 to make it run
 2018-03-18 20:02:54 +01:00
Alex Lisitsyn ce09cfd99b esp32: Deactivate wakeup trigger after first wakeup 
Added function esp_sleep_disable_wakeup_source() to deactivate wakeup trigger for selected source.
Updated documentation for this function in sleep_modes.rst file.
Updated unit test to check this functionality for light sleep.
The test_sleep.c unit test is updated to add reliability for unit testing.

(TW#18952)
Closes https://github.com/espressif/esp-idf/issues/1677
 2018-03-16 18:49:24 +05:00
Alex Lisitsyn 2d90da0817 esp32: Deactivate wakeup trigger after first wakeup 
The timer wakeup function once activated cannot be disabled later using existing api. If user wants to use different wakeup sources after first sleep but it does not work. This change disables timer wakeup trigger in configuration that will be set into appropriate RTC registers in esp_light_sleep_start() function.

Added function esp_sleep_disable_wakeup_source() to deactivate wakeup trigger for selected source.
Updated documentation for this function in sleep_modes.rst file to pass make html.
Updated unit test to check this functionality for light sleep.
The test_sleep.c unit test is updated to add reliability for auto unit testing.

(TW#18952)
Closes https://github.com/espressif/esp-idf/issues/1677
 2018-03-16 18:22:02 +05:00
krzychb 621076f329 Introduced a CI check if folders with localized documentation are in sync, i.e. if they contain the same list of files 2018-03-16 07:54:58 +01:00
Angus Gratton 748fef4363 doc: Move non-language-specific RTD/Sphinx config to conf_common.py 2018-03-16 12:00:01 +11:00
krzychb 36bbfbb4bf Updated instructions to install Eclipse. Closes https://github.com/espressif/esp-idf/issues/1509. 2018-03-14 19:26:59 +01:00
krzychb 852f7f8a36 Updated get started instructions for windows following https://esp32.com/viewtopic.php?f=13&t=4232 2018-03-14 19:26:59 +01:00
krzychb b7f7ac3b28 Implemented review comments to zh_CN version of eclipse setup and PICO-KIT get started guides. Resolved issues after rebasing on master of several commits. 2018-03-13 22:31:54 +01:00
krzychb 6a1b2c6ad0 Included zh_CN version of Eclipse setup and PICO-KIT get started guides 2018-03-13 22:07:31 +01:00
krzychb c63d7a4b5e Adjusted CI configuration to handle 'en' and 'zh_CN' language versions 2018-03-13 22:07:31 +01:00
krzychb 56d5647d3f Adjusted Sphinx configuration to handle 'en' and 'zh_CN' language versions 2018-03-13 22:07:31 +01:00
krzychb 40bc387bae Restored back original 'zh_CN' version files and updated links between versions 2018-03-13 21:57:08 +01:00
krzychb 097adc3a33 Moved files into separate folders per 'en' and 'zh_CN' language version and linked 'zh_CN' files back to 'en' files if translation is not yet available 2018-03-13 21:57:08 +01:00
krzychb c8d8cdbf38 Make search / include path one level deeper to prepare for moving documentation into new dedicated folders per a language version 2018-03-13 21:57:08 +01:00
Ivan Grokhotkov 7a1e3265fe Merge branch 'bugfix/docs_small_corrections' into 'master' 
Bugfix/docs small corrections

See merge request idf/esp-idf!2025
 2018-03-13 17:43:00 +08:00
Ivan Grokhotkov c54ce12853 Merge branch 'bugfix/docs_incremental_build' into 'master' 
docs: speed up incremental builds

See merge request idf/esp-idf!2012
 2018-03-13 17:41:08 +08:00
Ivan Grokhotkov e1cfa133bd Merge branch 'bugfix/docs_from_github' into 'master' 
Bugfix/docs from github

See merge request idf/esp-idf!2015
 2018-03-13 17:40:26 +08:00
krzychb e437c7d6ad Exposed important information regrading the flash bus signals 2018-03-12 05:56:35 +01:00
XuanZe bf2a7fd2c9 fix: fatfs link 2018-03-12 05:56:35 +01:00
krzychb ef76ae3d29 Extra links in 'Resources' section 2018-03-12 05:56:35 +01:00
krzychb 53e01bfb96 Added missing link to sdkconfig 2018-03-08 10:03:32 +01:00
Ivan Grokhotkov 2e0f8b5a70 docs: speed up incremental builds 
On each documentation build (‘make html’), doxygen regenerates XML
files. In addition to that, gen-dxd.py regenerates API reference
files under _build/inc/. This results in Sphinx flagging about half
of the input files as modified, and incremental builds taking long
time.

With this change, XML files generated by Doxygen are copied into
docs/xml_in directory only when they are changed. Breathe is pointed
to docs/xml_in directory instead of docs/xml. In addition to that,
gen-dxd.py is modified to only write to the output file when contents
change.

Overall, incremental build time (with no source files changed) is
reduced from ~7 minutes to ~8 seconds (on a particular OS X
computer).

Due to the way Breathe includes Doxygen XML files, there is still
going to be a massive rebuild every time functions, enums, macros,
structures are added or removed from the header files scanned
by Doxygen, but at least individual .rst files can be edited
at a much faster pace.
 2018-03-07 17:45:15 +08:00