arduino / arduino-cli

Arduino command line tool
https://arduino.github.io/arduino-cli/latest/
GNU General Public License v3.0
4.24k stars 371 forks source link

feat(doc): document empty vendor and arch in FQBN #2550

Closed dankeboy36 closed 4 months ago

dankeboy36 commented 4 months ago

Please check if the PR fulfills these requirements

See how to contribute

What kind of change does this PR introduce?

The spec should be aligned with the implementation; empty vendor and architecture parts are allowed in the FQBN.

This PR updates the documentation to mention the empty vendor and architecture parts in the FQBN.

What is the current behavior?

The docs do not mention the empty vendor/architecture cases but the CLI supports them:

https://github.com/arduino/arduino-cli/blob/870a48fce24256aa81f4b609a61f48b8d412ad41/internal/arduino/cores/fqbn_test.go#L33-L56

What is the new behavior?

The new doc includes the special empty parts case: https://github.com/dankeboy36/arduino-cli/blob/feat-doc-fqbn/docs/FAQ.md#whats-the-fqbn-string

Does this PR introduce a breaking change, and is titled accordingly?

No.

Other information

CLAassistant commented 4 months ago

CLA assistant check
All committers have signed the CLA.

CLAassistant commented 4 months ago

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 69.38%. Comparing base (870a48f) to head (0a164a8).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #2550 +/- ## ======================================= Coverage 69.38% 69.38% ======================================= Files 205 205 Lines 20162 20162 ======================================= Hits 13989 13989 Misses 5050 5050 Partials 1123 1123 ``` | [Flag](https://app.codecov.io/gh/arduino/arduino-cli/pull/2550/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino) | Coverage Δ | | |---|---|---| | [unit](https://app.codecov.io/gh/arduino/arduino-cli/pull/2550/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino) | `69.38% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=arduino#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.