Skip to content
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

add library.json to support compilation as platformio library #1036

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rwedler
Copy link

@rwedler rwedler commented Oct 28, 2024

This is a simple PR to add compilation support as a platformio library. The only thing I needed to add was a custom option to avoid the usage of Wshadow when compiling littlefs.

To use this in a project, it can be referenced via a URL in the project's platformio.ini with the following text

lib_deps =
    https://github.com/littlefs-project/littlefs#{githash/tag}

@geky geky added the different layer unrelated to this repo label Nov 1, 2024
@geky
Copy link
Member

geky commented Nov 1, 2024

Hi @rwedler, thanks for creating a PR, I appreciate the thought to upstream this.

First a quick note, to fix the CI failures you would need to rebase/retarget onto the devel branch. GitHub made a breaking change to their APIs somewhat recently and the fix hasn't made its way to our master branch yet.

But w.r.t. this PR, I have a general rule of not adding files that are only necessary to make downstream systems work.

This may feel unfair since it's only one file, but it opens a can of worms and makes it harder to argue against downstream-helpful changes that are unreasonable.

It also makes it so build system changes downstream can backflow into littlefs development. Breaking changes are already bad enough going in only one direction...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
different layer unrelated to this repo
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants