Commit Graph

122 Commits

Author SHA1 Message Date
Ivan Grokhotkov
087d055090
fix(pytest): respect --build-dir argument from pytest-embedded 2024-05-02 15:18:34 +02:00
kirill.chalov
0dfd78800f docs: Update example README template and other related docs 2024-04-15 17:17:27 +08:00
Marius Vikhammer
f1e65b8373 docs(misc): fixed typos found with codespell 2024-03-28 11:50:58 +08:00
kirill.chalov
22a053f1fc docs(sphinx-lint): Fix issues reported by sphinx-lint before adding it to pre-commit 2024-01-23 15:22:29 +08:00
Fu Hanxi
25e3e3b384
docs: update pipeline_id description 2024-01-12 08:52:55 +01:00
Fu Hanxi
fa34008c61
docs(pytest): improve docs, add new features and changes 2024-01-10 15:31:22 +01:00
Marius Vikhammer
9c5438b307 docs(pytest): add note about filtering with test-case-name 2023-12-05 09:54:41 +08:00
Alex Offshore
82aa0f3bc3
Minor fix style-guide.rst 2023-11-09 11:56:25 +03:00
Song Ruo Jing
9461993ec5 refactor(gpio): make gpio driver as component, and fix astyle 2023-11-03 15:42:23 +08:00
Ivan Grokhotkov
43741ec803
ci: add astyle pre-commit check 2023-09-27 08:43:45 +02:00
caixinying-git
b07ada6e94 docs: update format issues left in EN docs 2023-09-15 10:46:25 +00:00
renpeiying
a1354c81f9 docs: Provide Chinese translation for contribute/contributor-agreement.rst 2023-09-01 14:02:59 +08:00
Ren Pei Ying
3e1a6afb00 docs: add CN translation for contribute/esp-idf-tests-with-pytest.rst 2023-08-24 05:32:11 +08:00
Cai Xin Ying
bcb87c4b8f docs: update format issues for both EN and CN under security and contribute folder 2023-08-22 23:59:44 +08:00
Ren Pei Ying
218404d94d docs: Provide CN translation for contribute/documenting-code.rst 2023-08-15 18:46:37 +08:00
radim.karnis
8acde05a5c feat: Drop Python 3.7 support 2023-08-08 08:37:29 +02:00
morris
29c100b7b8 Merge branch 'docs_add_CN_translation_for_cotribute/copyright-guide.rst_and_install-pre-commit-book.rst' into 'master'
docs: Provide CN translation for contribute/copyright-guide.rst and install-pre-commit-hook.rst

Closes DOC-5883 and DOC-5884

See merge request espressif/esp-idf!25100
2023-08-07 16:14:19 +08:00
renpeiying
e6d1e2437a docs: Provide CN translation for contribute/copyright-guide and install-pre-commit-hook 2023-08-07 11:55:30 +08:00
renpeiying
8163dbbbb4 docs:Provide CN translation for contribute/index.rst 2023-08-02 14:34:00 +08:00
Tomas Sebestik
c59d4e15ff docs(contributor_guide): Update install pre-commit instructions 2023-06-29 15:05:58 +02:00
Fu Hanxi
22a8784553 docs: fix 404 links 2023-06-06 11:11:23 +08:00
Zim Kalinowski
7558a0933d docs: updated contribution agreement 2023-04-20 11:07:25 +02:00
Jakob Hasse
3839508bf6 doc: made reasonable exception for CamelCase explicit 2023-03-24 12:01:38 +08:00
Fu Hanxi
953d1fcbca docs: provide simple approach to run pytest locally 2023-03-10 11:25:02 +08:00
Roland Dobai
1dc3d5ef22 Merge branch 'feature/introduce_spdx_licenseref' into 'master'
tools: allow to use LicenseRef-[idstring] in SPDX-License-Identifier

Closes IDF-4486

See merge request espressif/esp-idf!22132
2023-02-10 17:08:01 +08:00
laokaiyao
f27cd67c00 driver: pack peripherals 2023-02-02 18:19:58 +08:00
Frantisek Hrbata
8e893db5f3 docs: allow to use SPDX LicenseRef-[idstring] indentifier
In a very rare cases there is a need to use custom license, which is not
present on the SPDX list. Now, files under such license are added to the
check_copyright ignore list. For example zigbee examples introduced
by !16205. SPDX has a LicenseRef-[idstring] identifier[1] for such cases,
so let's try to use it in license representation[2]. The idea is that licenses
not on the SPDX list can be added into the LICENSES[3] directory and used as

	SPDX-License-Identifier: LicenseRef-Special-License

Or if the custom license is present directly in a source file we can use
a special LicenseRef-Included identifier to state that the license
is included.

	SPDX-License-Identifier: LicenseRef-Included

Please note that LicenseRef-Included is just a made up identifier to
state the fact that the license is included directly in the source file.
There is nothing in the SPDX spec about this usage.

This relatively small adjustment allows to refer to custom licenses
without a need to skip check_copyright for them.

[1] https://spdx.github.io/spdx-spec/v2.3/other-licensing-information-detected/#101-license-identifier-field
[2] https://spdx.github.io/spdx-spec/v2.3/using-SPDX-short-identifiers-in-source-files/#e4-representing-multiple-licenses
[3] https://reuse.software/spec/

Signed-off-by: Frantisek Hrbata <frantisek.hrbata@espressif.com>
2023-02-02 08:21:47 +01:00
Fu Hanxi
407cdd2a14 docs: add performance related functions 2022-12-21 10:26:19 +08:00
Fu Hanxi
c3c48b95da docs: fix the current doc section level and outdated content 2022-12-21 10:25:33 +08:00
Fu Hanxi
df63cd0765 docs: update pytest related docs 2022-12-08 09:49:12 +08:00
Marius Vikhammer
0244c81fd2 docs: update getting started and frontpage docs for C6 2022-11-17 11:30:30 +08:00
Darian Leung
4b2c8c591b freertos: Add uncrustiy config files for IDF FreeRTOS v10.4.3
This commit adds a copy of upstream vanilla FreeRTOS uncrustify.cfg files from
the following upstream commit:

89e4823a49

Note: "pp_indent_brace" is commented out as that was enabled after v10.4.3

Also also added a note in the ESP-IDF style guide aobut formatting FreeRTOS
source code using Uncrustify.
2022-11-02 19:42:19 +08:00
Tomas Rezucha
c6fbefcd84 usb_host: Remove custom test_app 2022-09-05 20:14:56 +02:00
Fu Hanxi
8e9cdb0770 docs: improve ci related docs 2022-07-22 08:18:19 +08:00
Fu Hanxi
05d2357062 feat: use standalone project idf-build-apps for find/build apps utils 2022-07-14 08:26:31 +08:00
Fu Hanxi
566af729c5 docs: update pytest installation 2022-06-08 08:19:35 +08:00
Marius Vikhammer
030e52f5d4 Merge branch 'feature/improve_doc_link_check' into 'master'
docs: fix broken links and re-enable linkchecker

Closes IDF-2640

See merge request espressif/esp-idf!17919
2022-05-19 15:52:17 +08:00
Fu Hanxi
3697cd0440 docs: add multi dut chapter 2022-05-13 11:56:59 +08:00
Marius Vikhammer
030cb77597 docs: update redirected links 2022-05-07 13:09:41 +08:00
Ivan Grokhotkov
0f515ce3fb
docs: make CONTRIBUTING.md readable on Github
Move the contents of CONTRIBUTING.rst into contributing/index.rst,
create CONTRIBUTING.md with a link to the programming guide.

Closes https://github.com/espressif/esp-idf/issues/6807
2022-05-04 01:16:34 +02:00
Fu Hanxi
79bde140c3 ci: improve pytest doc 2022-03-10 14:37:13 +08:00
Fu Hanxi
5ccb5eeebd docs: add README about pytest in IDF 2022-03-03 14:36:50 +08:00
Tomas Sebestik
fb12d03dc3 Drop Python 3.6 2022-02-10 07:20:52 +01:00
Marius Vikhammer
93430c9eab docs: update copyright date for docs automatically 2022-01-10 15:05:33 +08:00
Marius Vikhammer
5f7733f692 docs: update frontpage/general pages for ESP8684 2021-12-21 11:14:35 +08:00
Roland Dobai
513a9b18a3 Docs: Update the copyright contribution guide with new options of the checker
Document additional options introduced by 228113a399.
2021-12-08 12:17:24 +01:00
Roland Dobai
a1d0d1ffbe Tools: Remove MSYS/Mingw support
MSYS/Mingw was deprecated since v4.0 and it is removed in v5.0. Please
follow the getting started guide of the documentation to set up a
Windows Command Line or Power Shell based environment.
2021-11-10 17:25:07 +01:00
Roland Dobai
9c1d4f5b54 Build & config: Remove the "make" build system
The "make" build system was deprecated in v4.0 in favor of idf.py
(cmake). The remaining support is removed in v5.0.
2021-11-10 09:53:53 +01:00
Roland Dobai
4d149f070c Docs: Add copyright header guide for contributions 2021-11-04 11:55:26 +01:00
Jan Brudný
798a174686 Add copyright check to pre-commit-config 2021-09-20 17:50:55 +08:00