Merge branch 'docs/add_windows_command_to_updating_esp-idf' into 'master'

docs: add commands to updating esp-idf versions in windows system

Closes DOC-382

See merge request espressif/esp-idf!20324
pull/9839/head
Zhang Xiao Yan 2022-10-20 17:12:07 +08:00
commit 56a8b1716a
2 zmienionych plików z 24 dodań i 6 usunięć

Wyświetl plik

@ -185,7 +185,8 @@ Updating to Stable Release
To update to a new ESP-IDF release (recommended for production use), this is the process to follow:
- Check the `Releases page`_ regularly for new releases.
- When a bugfix release for the version you are using is released (for example, if using ``v3.0.1`` and ``v3.0.2`` is released), check out the new bugfix version into the existing ESP-IDF directory:
- When a bugfix release for the version you are using is released (for example, if using ``v3.0.1`` and ``v3.0.2`` is released), check out the new bugfix version into the existing ESP-IDF directory.
- In Linux or macOS system, please run the following commands to update the local branch to vX.Y.Z:
.. code-block:: bash
@ -194,6 +195,7 @@ To update to a new ESP-IDF release (recommended for production use), this is the
git checkout vX.Y.Z
git submodule update --init --recursive
- In the Windows system, please replace ``cd $IDF_PATH`` with ``cd %IDF_PATH%``.
- When major or minor updates are released, check the Release Notes on the releases page and decide if you want to update or to stay with your current release. Updating is via the same Git commands shown above.
.. note:: If you installed the stable release via zip file instead of using git, it might not be possible to update versions using the commands. In this case, update by downloading a new zip file and replacing the entire ``IDF_PATH`` directory with its contents.
@ -217,13 +219,16 @@ Updating to Master Branch
To use the latest version on the ESP-IDF master branch, this is the process to follow:
- Check out the master branch locally::
- In Linux or macOS system, please run the following commands to check out to the master branch locally:
.. code-block:: bash
cd $IDF_PATH
git checkout master
git pull
git submodule update --init --recursive
- In the Windows system, please replace ``cd $IDF_PATH`` with ``cd %IDF_PATH%``.
- Periodically, re-run ``git pull`` to pull the latest version of master. Note that you may need to change your project or report bugs after updating your master branch.
- To switch from master to a release branch or stable version, run ``git checkout`` as shown in the other sections.
@ -240,7 +245,9 @@ In terms of stability, using a release branch is part-way between using the mast
You can find a `list of branches`_ on GitHub.
For example, to follow the branch for ESP-IDF v3.1, including any bugfixes for future releases like ``v3.1.1``, etc::
For example, in Linux or macOS system, you can execute the following commands to follow the branch for ESP-IDF v3.1, including any bugfixes for future releases like ``v3.1.1``, etc:
.. code-block:: bash
cd $IDF_PATH
git fetch
@ -248,6 +255,8 @@ For example, to follow the branch for ESP-IDF v3.1, including any bugfixes for f
git pull
git submodule update --init --recursive
In the Windows system, please replace ``cd $IDF_PATH`` with ``cd %IDF_PATH%``.
Each time you ``git pull`` this branch, ESP-IDF will be updated with fixes for this release.
.. note::

Wyświetl plik

@ -185,7 +185,8 @@ Git 工作流
对于量产用户,推荐更新至一个新的 ESP-IDF 发布版本,请参考以下步骤:
- 请定期查看 `发布说明页面`_ ,了解最新发布情况。
- 如有新发布的 Bugfix 版本(例 ``v3.0.1````v3.0.2``)时,请将新的 Bugfix 版本更新至您的 ESP-IDF 目录:
- 如有新发布的 Bugfix 版本(例 ``v3.0.1````v3.0.2``)时,请将新的 Bugfix 版本更新至您的 ESP-IDF 目录。
- 在 Linux 或 macOS 系统中,请运行如下命令将分支更新至 vX.Y.Z
.. code-block:: bash
@ -194,6 +195,7 @@ Git 工作流
git checkout vX.Y.Z
git submodule update --init --recursive
- 在 Windows 系统中,需要将 ``cd $IDF_PATH`` 替换为 ``cd %IDF_PATH%``
- 在主要版本或次要版本新发布时,请查看发布说明中的具体描述,并决定是否升级您的版本。具体命令与上方描述一致。
.. note:: 如果您之前在安装 ESP-IDF 时使用了 zip 文件包,而非通过 Git 命令,则您将无法使用 Git 命令进行版本升级,此属正常情况。这种情况下,请重新下载最新 zip 文件包,并替换掉之前 ``IDF_PATH`` 下的全部内容。
@ -217,13 +219,16 @@ Git 工作流
如需使用 ESP-IDF 的 master 分支,请参考以下步骤:
- 本地切换至 master 分支::
- 在 Linux 或 macOS 系统中,使用如下命令在本地切换至 master 分支:
.. code-block:: bash
cd $IDF_PATH
git checkout master
git pull
git submodule update --init --recursive
- 在 Windows 系统中,需要将 ``cd $IDF_PATH`` 替换为 ``cd %IDF_PATH%``
- 此外,您还应在后续工作中不时使用 ``git pull`` 命令,将远端 master 上的更新同步到本地。注意,在更新 master 分支后,您可能需要更改工程代码,也可能遇到新的 bug。
- 如需从 master 分支切换至一个发布分支或稳定版本,请使用 ``git checkout`` 命令。
@ -240,7 +245,9 @@ Git 工作流
更多详情,请前往 GitHub 查看完整 `标签列表`_
举例,您可以关注 ESP-IDF v3.1 分支,随时关注该分支上的 Bugfix 版本发布( 例 ``v3.1.1`` 等)::
例如,在 Linux 或 macOS 系统中您可以运行以下命令更新至ESP-IDF v3.1,随时关注该分支上的 Bugfix 版本发布(如 ``v3.1.1`` 等):
.. code-block:: bash
cd $IDF_PATH
git fetch
@ -248,6 +255,8 @@ Git 工作流
git pull
git submodule update --init --recursive
在 Windows 系统中,需要将 ``cd $IDF_PATH`` 替换为 ``cd %IDF_PATH%``
您每次在该分支上使用 ``git pull`` 时都相当于把最新的 Bugfix 版本发布更新至您的本地副本中。
.. note::