Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Allow use of a dependency helper source file during library detection#2758

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Draft
cmaglie wants to merge1 commit intoarduino:master
base:master
Choose a base branch
Loading
fromcmaglie:another_lib_detection_optimization

Conversation

cmaglie
Copy link
Member

@cmagliecmaglie commentedNov 18, 2024
edited
Loading

Please check if the PR fulfills these requirements

Seehow to contribute

  • The PR has no duplicates (please search among thePull Requests
    before creating one)
  • The PR follows
    our contributing guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)
  • UPGRADING.md has been updated with a migration guide (for breaking changes)
  • configuration.schema.json updated if new parameters are added.

What kind of change does this PR introduce?

This is a tentative implementation for a strategy to increase the speed of the library discovery phase.
The idea behind this PR is to add a helper file in a library, calledarduino_deps.cpp (orarduino_deps.c), whose only purpose is to#include the required dependencies. If the Arduino CLI finds the helper the library detection process is performed only on that file, skipping all the other source files (that may be a lot...).

Advantages:

  • It will correctly handle conditional includes (inside ifdefs).
  • It must be maintained with the source code, otherwise, the library will fail to compile (differently from thedependencies field in thelibrary.properties that may become outdated if the author is not precise).
  • If a library has a lot of source files, the speed-up may be dramatic.

Disadvantages:

  • It requires action from lib authors to write anarduino_deps.cpp.
  • Writing a correctarduino_deps.cpp may be tricky.
  • An incorrectarduino_deps.cpp may result in difficult-to-diagnose "missing include X.h" errors (that could be a workaround by including X.h in the user sketch)

What is the current behavior?

What is the new behavior?

Does this PR introduce a breaking change, and istitled accordingly?

Other information

This may be combined with#2625 for even better performance gain

@cmagliecmaglie self-assigned thisNov 18, 2024
@cmagliecmaglie added the type: enhancementProposed improvement labelNov 18, 2024
@codecovCodecov
Copy link

codecovbot commentedNov 18, 2024
edited
Loading

Codecov Report

Attention: Patch coverage is43.47826% with13 lines in your changes missing coverage. Please review.

Project coverage is 67.49%. Comparing base(67eb95a) to head(f593a73).

Files with missing linesPatch %Lines
...rnal/arduino/builder/internal/detector/detector.go53.33%3 Missing and 4 partials⚠️
internal/arduino/libraries/libraries.go25.00%4 Missing and 2 partials⚠️
Additional details and impacted files
@@            Coverage Diff             @@##           master    #2758      +/-   ##==========================================- Coverage   67.55%   67.49%   -0.07%==========================================  Files         237      237                Lines       22358    22375      +17     ==========================================- Hits        15105    15101       -4- Misses       6063     6076      +13- Partials     1190     1198       +8
FlagCoverage Δ
unit67.49% <43.47%> (-0.07%)⬇️

Flags with carried forward coverage won't be shown.Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report?Share it here.


🚨 Try these New Features:

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees

@cmagliecmaglie

Labels
type: enhancementProposed improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

1 participant
@cmaglie

[8]ページ先頭

©2009-2025 Movatter.jp