arduino/library-registry
1
0
Fork 0
mirror of https://github.com/arduino/library-registry.git synced 2025-07-04 10:22:30 +03:00
Code Activity

Explain impacts of changing library name in FAQ

Browse Source
This commit is contained in:
per1234
2021-04-09 06:34:25 -07:00
parent ddd8c7d477
commit ca3a07811e
1 changed files with 3 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
FAQ.md
View File

@ -74,7 +74,9 @@ The Library Manager indexer job will reject any releases which aren't compliant
### How can I change my library's name?
For the sake of continuity, libraries in the Library Manager list are locked in to the name they had at the time they were added to the list. If you wish to change the name it will need to be done manually by request:
For the sake of continuity, libraries in the Library Manager list are locked to the name they had at the time they were added to the list. Changing the library name can be disruptive to its users because this is the unique identifier for the library used by the Arduino development software [command line interfaces](https://arduino.github.io/arduino-cli/latest/commands/arduino-cli_lib/), sketch [metadata](https://arduino.github.io/arduino-cli/latest/sketch-specification/#metadata), library [dependencies](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format), and installation location.
If you wish to change the name it will need to be done manually by request:
1. Change the `name` value in your [library.properties file](https://arduino.github.io/arduino-cli/latest/library-specification/#libraryproperties-file-format) and update the `version`.
1. Create a release or tag that matches the updated `version` value in library.properties.