Skip to content

Repo cleanup #10166

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

Merged
merged 4 commits into from
May 11, 2020
Merged

Repo cleanup #10166

merged 4 commits into from
May 11, 2020

Conversation

matthijskooijman
Copy link
Collaborator

@matthijskooijman matthijskooijman commented May 7, 2020

While looking for a place to document how to run tests, I noticed there were some files and directories in the repository root that do not really need to be there. This PR (re)moves them, resulting in a cleaner repository.

Also, I decided to document the test process on the wiki, so I added a note to the README that points there (which is a bit off-topic for this PR, but since I also wanted to add some other links to the README, I included that commit in here as well).

Also, maybe we should remove the hardware folder too, but I did not do that yet. It currently contains:

  • A README documenting where the AVR and SAM repos went and how to port over pullrequests. The former is now also documented in the main README (with this PR), the latter is probably no longer relevant by now?
  • A package_index_bundled.json file, which describes the bundled AVR core. I wonder if that should not really be tracked as part of the ArduinoCore-avr repo (but that might be a fundamental discussion about the relation between these json files and platform.txt). Alternatively, this file could maybe be moved into build/ somewhere, though I did really try to come up with a good place.

This keeps the repository root a bit cleaner. Since these files are used
automatically and are not intended to be directly read by users, there
is no point in keeping them in the root (github will pick up these
templates from the root, .github directory or docs directory equally).
It seems this script was used to extract libraries, along with their
history, from the libraries directory of this repository. Since then,
all libraries have been extracted and then deleted in commit 067d7e9
(Delete builtin libraries sources), so no need to keep this script
around.
In commit 067d7e9 (Delete builtin libraries sources) all the libraries
in there were removed, since they are all now automatically downloaded
during the build. To keep the repository clean, remove the empty
directory as well as the build rule that was used to copy libraries from
this (now empty) directory into the build result.
@matthijskooijman matthijskooijman force-pushed the repo-cleanup branch 2 times, most recently from 9eb1647 to a801cdb Compare May 7, 2020 18:35
@arduino arduino deleted a comment from ArduinoBot May 7, 2020
@arduino arduino deleted a comment from ArduinoBot May 7, 2020
@arduino arduino deleted a comment from ArduinoBot May 7, 2020
@matthijskooijman
Copy link
Collaborator Author

Force pushed some more fixes to the README formatting, pointed out by the codacy check.

@cmaglie cmaglie merged commit 0641cd7 into arduino:master May 11, 2020
@matthijskooijman matthijskooijman deleted the repo-cleanup branch May 26, 2020 08:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants