Merge branch 'docs/update_docs_based_on_the_second_batch_of_customer_feedbacks' into 'master'

docs: update documents based on doc-855, doc-885, doc-889, doc-897

See merge request espressif/esp-idf!12124
This commit is contained in:
Krzysztof Budzynski
2021-01-26 16:21:26 +08:00
8 changed files with 32 additions and 30 deletions

View File

@@ -260,7 +260,7 @@ The command-line interface of `parttool.py` has the following structure:
parttool.py --port "/dev/ttyUSB1" erase_partition --partition-name=storage
# Read partition with type 'data' and subtype 'spiffs' and save to file 'spiffs.bin'
parttool.py --port "/dev/ttyUSB1" read_partition --partition-type=data --partition-subtype=spiffs "spiffs.bin"
parttool.py --port "/dev/ttyUSB1" read_partition --partition-type=data --partition-subtype=spiffs --output "spiffs.bin"
# Write to partition 'factory' the contents of a file named 'factory.bin'
parttool.py --port "/dev/ttyUSB1" write_partition --partition-name=factory "factory.bin"

View File

@@ -126,29 +126,29 @@ Configuration Client/Server Models
Health Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include-build-file:: inc/esp_ble_mesh_generic_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_health_model_api.inc
Generic Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include-build-file:: inc/esp_ble_mesh_health_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_generic_model_api.inc
Sensor Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include-build-file:: inc/esp_ble_mesh_lighting_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_sensor_model_api.inc
Time and Scenes Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include-build-file:: inc/esp_ble_mesh_sensor_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_time_scene_model_api.inc
Lighting Client/Server Models
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. include-build-file:: inc/esp_ble_mesh_time_scene_model_api.inc
.. include-build-file:: inc/esp_ble_mesh_lighting_model_api.inc

View File

@@ -9,14 +9,14 @@
try:
from conf_common import * # noqa: F403,F401
except ImportError:
import sys
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
from conf_common import * # noqa: F403,F401
# General information about the project.
project = u'ESP-IDF Programming Guide'
copyright = u'2016 - 2020, Espressif Systems (Shanghai) CO., LTD'
copyright = u'2016 - 2021, Espressif Systems (Shanghai) Co., Ltd'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

View File

@@ -7,24 +7,25 @@ Standard Setup of Toolchain for Linux
Install Prerequisites
=====================
To compile with ESP-IDF you need to get the following packages:
- CentOS 7::
sudo yum -y update && sudo yum install git wget flex bison gperf python3 cmake ninja-build ccache dfu-util libusbx
CentOS 7 is still supported but CentOS version 8 is recommended for a better user experience.
To compile with ESP-IDF you need to get the following packages. The command to run depends on which distribution of Linux you are using:
- Ubuntu and Debian::
sudo apt-get install git wget flex bison gperf python3 python3-pip python3-setuptools cmake ninja-build ccache libffi-dev libssl-dev dfu-util libusb-1.0-0
- CentOS 7 & 8::
sudo yum -y update && sudo yum install git wget flex bison gperf python3 cmake ninja-build ccache dfu-util libusbx
CentOS 7 is still supported but CentOS version 8 is recommended for a better user experience.
- Arch::
sudo pacman -S --needed gcc git make flex bison gperf python-pip cmake ninja ccache dfu-util libusb
.. note::
CMake version 3.5 or newer is required for use with ESP-IDF. Older Linux distributions may require updating, enabling of a "backports" repository, or installing of a "cmake3" package rather than "cmake".
- CMake version 3.5 or newer is required for use with ESP-IDF. Older Linux distributions may require updating, enabling of a "backports" repository, or installing of a "cmake3" package rather than "cmake".
- If you do not see your Linux distribution in the above list then please check its documentation to find out which command to use for package installation.
Additional Tips
===============