From 5b1226565d3e2668b52a93601cbd658cc4ff9477 Mon Sep 17 00:00:00 2001 From: per1234 Date: Sat, 4 Jul 2020 10:18:54 -0700 Subject: [PATCH] [skip ci] Correct lib name specification re: leading/trailing space Leading and trailing space is correctly trimmed on all fields of library.properties, including name. The unnecessary extra verbosity in the name specification may cause people to miss the other important restrictions. --- docs/library-specification.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/library-specification.md b/docs/library-specification.md index 31e24d72f03..88a6bb2336b 100644 --- a/docs/library-specification.md +++ b/docs/library-specification.md @@ -29,7 +29,7 @@ This file allows the *Library Manager* to search and install a library and its d The library.properties file is a key=value properties list. Every field in this file is UTF-8 encoded. Unless noted otherwise below, **all fields are required**. The available fields are: -* **name** - the name of the library. Library names must contain only basic letters (`A`-`Z` or `a`-`z`) and numbers (`0`-`9`), spaces (` `), underscores (`_`), dots (`.`) and dashes (`-`). It cannot start or end with a space, and also it cannot start with a number. Note that libraries with a `name` value starting with `Arduino` will no longer be allowed [addition to the Library Manager index](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ) as these names are now reserved for official Arduino libraries. +* **name** - the name of the library. Library names must contain only basic letters (`A`-`Z` or `a`-`z`) and numbers (`0`-`9`), spaces (` `), underscores (`_`), dots (`.`) and dashes (`-`). They cannot start with a number. Note that libraries with a `name` value starting with `Arduino` will no longer be allowed [addition to the Library Manager index](https://github.com/arduino/Arduino/wiki/Library-Manager-FAQ) as these names are now reserved for official Arduino libraries. * **version** - version of the library. Version should be [semver](http://semver.org/) compliant. 1.2.0 is correct; 1.2 is accepted; r5, 003, 1.1c are invalid * **author** - name/nickname of the authors and their email addresses (not mandatory) separated by comma "," * **maintainer** - name and email of the maintainer