View a markdown version of this page

Anweisungen zur FreeRTOS-Manifestdatei - FreeRTOS

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Anweisungen zur FreeRTOS-Manifestdatei

Eine Manifestdatei ist erforderlich, AWS IoT Device Tester um die verwendeten Versionen und Bibliotheken zu identifizieren. Sie hilft Kunden dabei, Versionen, Bibliotheksabhängigkeiten und Metadaten abzugrenzen.

Die Datei sollte die folgenden Anforderungen erfüllen:

  • Die Datei muss mit manifest.yml benannt werden.

  • Sie muss sich im Basisordner der Bibliothek oder des Pakets befinden.

  • Es muss im YAML-Format vorliegen und den YAML 1.2-Spezifikationen entsprechen.

Die Parameter können in beliebiger Reihenfolge angegeben werden, wir empfehlen jedoch, sie in der unten aufgeführten Reihenfolge anzuordnen, um eine optimale Lesbarkeit zu gewährleisten. Fügen Sie der Datei Kommentare hinzu, um Kunden bei der Verwendung Ihres Pakets zu unterstützen.

Dateipfad

Befindet sich im Stammverzeichnis eines Pakets oder einer Bibliothek. Es gibt nur eine Manifestdatei pro Paket. Abhängigkeiten, die eingeführt werden, können ihre eigenen Manifestdateien haben.

Parameters
Name

Der Name des Pakets. Alle Leerzeichen sollten durch einen Unterstrich (_) ersetzt werden. My project name - 2020Sollte beispielsweise in geändert werden. My_project_name_-_2020

  • Typ: string

  • erforderlich: wahr

  • minLength: 1

  • Max. Länge: 40

version

Die Version des Pakets. Bei der Version kann es sich um eine Release-Version oder ein Versions-Tag handeln.

  • Typ: string

  • erforderlich: wahr

  • minLength: 1

  • Max. Länge: 30

description

Die für Menschen lesbare Beschreibung des Pakets. Die Beschreibung sollte klar beschreiben, was das Paket ist und was es bietet.

  • Typ: string

  • erforderlich: wahr

  • Mindestlänge: 30

  • Max. Länge: 255

vermeiden

Eine Liste aller Abhängigkeiten der ersten Ebene, die ein Benutzer benötigt, um dieses Paket erfolgreich zu erstellen, und die von einem Git-, Subversion- oder Mercurial-Quellcode-Host abgerufen werden können. Schließen Sie keine Abhängigkeiten ein, die nicht über Git, SVG oder hg verfügbar sind. Schließ keine Abhängigkeiten ein, die für Tests, Dokumentationserstellung oder Entwicklung verwendet werden. Um eine gute Benutzererfahrung zu fördern, empfehlen wir Ihnen, keine abhängigen oder privaten Abhängigkeiten aufzulisten.

  • Typ: Reihe

  • erforderlich: falsch

  • minLength: 0

Abhängigkeiten [] .name

Der Paketname einer Abhängigkeit. Dieser muss mit dem Paketnamen im name Parameter der Abhängigkeit übereinstimmen.

  • Typ: string

  • erforderlich: wahr

  • minLength: 1

  • Max. Länge: 40

Abhängigkeiten [] .version

Die Version einer Abhängigkeit. Bei der Version kann es sich um eine Release-Version oder ein Versions-Tag handeln. Wenn das Paket selbst Abhängigkeiten enthält, muss die Version mit der Manifestdatei übereinstimmen, die sich in der Abhängigkeit befindet.

  • Typ: string

  • erforderlich: wahr

  • minLength: 1

  • Max. Länge: 30

Abhängigkeiten [] .repository

Beschreibt den Speicherort des Abhängigkeitsquellcodes.

  • Typ: Wörterbuch

  • erforderlich: wahr

dependencies [] .repository.type

Der Typ des Repositorys.

  • Typ: string

  • erforderlich: wahr

  • Aufzählung: [git, svn, hg]

Abhängigkeiten [] .repository.url

Die URL des Standorts des Repositorys. Dies muss eine vollständige URL mit einem Protokollpräfix sein (z. B. https://github.com/ACCOUNT_NAME/REPO_NAME).

  • Typ: string

  • erforderlich: wahr

Abhängigkeiten [] .repository.path

Der relative Pfad aus dem Projektarbeitsbereich für die Abhängigkeit.

  • Typ: string

  • erforderlich: wahr

Abhängigkeiten [] .repository.branch

Der Zweig der Abhängigkeit, der verwendet wird. Wenn das Paket den Release-Zweig von Bibliotheken verwendet, geben Sie diesen Parameter nicht an, um die Länge des Manifests so gering wie möglich zu halten.

  • Typ: string

  • erforderlich: falsch

Lizenz

Die SPDX-Lizenz-ID der Bibliothek. Eine vollständige Liste finden Sie unter https://spdx.org/licenses/. Sie sollte mit der LICENSE Datei im Stammverzeichnis des Repositorys übereinstimmen, falls sie existiert.

  • Typ: string

  • erforderlich: wahr