Skip to content

Sorted boards.txt + added board-sorting script for future use #7557

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from

Conversation

PilnyTomas
Copy link
Contributor

The new script .sort_boards.sh sorts contents in file boards.txt alphabetically based on .name parameter to be sorted for users in Arduino IDE.
Official Espressif boards are listed on top, sorted separately.
The file boards.txt in this PR contains result of this script.

This is a replacement for the previously proposed (impossible solution) splitting of the boards menu #7172

Known issues:

  • Removes empty lines
  • Removes commented lines

@VojtechBartoska
Copy link
Contributor

VojtechBartoska commented Dec 6, 2022

Thanks @PilnyTomas for the PR. Final result is good.

We just need to make sure, it's working correctly for new added boards and is also okay for LibBuilder.

@me-no-dev & @SuGlider please help with reviewing this script and the approach. Thanks.

@pedrominatel
Copy link
Member

Hi guys,

I would suggest creating some basic rules for adding new boards to prevent a huge number of boards on the list.
Most of the boards doesn't have any special peripheral, pins, or configuration and could be used just as a generic ESP32-x.

Copy link
Collaborator

@SuGlider SuGlider left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is a nice tool, not not sure it would fit along with Arduino Core.
Nice work @PilnyTomas!

It could stay within Lib Builder? @me-no-dev
Or as @pedrominatel suggested, we shall think a better way to solve the growing list of ESP32 3rd party boards.

@VojtechBartoska VojtechBartoska added this to the 2.0.6 milestone Dec 14, 2022
@VojtechBartoska
Copy link
Contributor

@PilnyTomas up to the discussion today, the approach and script looks okay.

Only thing, please remove the changes in boards.txt file in this PR. (as it was there just to show the result of the script)

@VojtechBartoska VojtechBartoska added the Status: In Progress ⚠️ Issue is in progress label Dec 14, 2022
@VojtechBartoska VojtechBartoska modified the milestones: 2.0.6, 3.0.0 Dec 19, 2022
@PilnyTomas
Copy link
Contributor Author

please remove the changes in boards.txt file

The main addition is the sorted list, not the script - the script is something extra that can be used in the future if needed.

@Velocet
Copy link

Velocet commented Jan 7, 2023

It could stay within Lib Builder? @me-no-dev Or as @pedrominatel suggested, we shall think a better way to solve the growing list of ESP32 3rd party boards.

Maybe use aliases and compile the boards file from it? This way boards with just another name could be used in Arduino IDE without too much hussle. Most beginners will likely look for their specific board instead of the ESP32 counterpart.

@PilnyTomas PilnyTomas changed the title Added board-sorting script + its result Sorted boards.txt + added board-sorting script for future use Jan 9, 2023
@CLAassistant
Copy link

CLAassistant commented May 6, 2023

CLA assistant check
All committers have signed the CLA.

@VojtechBartoska VojtechBartoska self-assigned this Aug 15, 2023
@VojtechBartoska VojtechBartoska modified the milestones: 3.0.0, 3.1.0 Nov 28, 2023
@VojtechBartoska
Copy link
Contributor

This PR and approach needs to be validated again, adding to 3.1.0 milestone as it is nice to have "feature" and it can be done a bit later.

@VojtechBartoska VojtechBartoska added the Status: Test needed Issue needs testing label Jan 30, 2024
@me-no-dev
Copy link
Member

closing this for now. will revisit later

@me-no-dev me-no-dev closed this Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: In Progress ⚠️ Issue is in progress Status: Test needed Issue needs testing
Projects
Development

Successfully merging this pull request may close these issues.

7 participants