platformio / platformio/platformio-docs

[FR] explain how to update external libraries that are not managed by Library Manager Registry

Open
#183 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
285
Forks
357
PR merge metrics
No merged PRs in 30d

Description

I created a plain C project for the Atmel AVR platform that depended on libraries which are in git repositories but not in the PlatformIO Library Manager Registry. I added these dependencies using the libdeps entry in platformio.ini .

I could not find the following information in the documentation:

- If a library is available from a version controlled repository, AND
- if the dependency is not available in the PlatformIO Library Manager Registry, AND
- if the depency was specified using the libdeps entry in platformio.ini, 

such library can be updated by deleting the subfolder [your_project_folder]/.pio/libdeps/[your_env]/[your_library_folder]  
of your project. The updated library should be added back automatically after some seconds. 

A good place for that information would be here:
https://github.com/platformio/platformio-docs/blob/develop/librarymanager/quickstart.rst#project-dependencies

and/or here:
https://github.com/platformio/platformio-docs/blob/develop/projectconf/section_env_library.rst

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review librarymanager/quickstart.rst at the Project Dependencies section and projectconf/section_env_library.rst. Document how libdeps entries pointing to version-controlled libraries outside the Library Manager Registry can be updated by removing the relevant .pio/libdeps/[your_env]/[your_library_folder] directory, and verify that the wording matches the described automatic re-add behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, git
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.