From 124f9a6a2b0e3da42b49cc17863120f5aab41adb Mon Sep 17 00:00:00 2001 From: Timo Ley Date: Mon, 12 Sep 2022 14:54:05 +0200 Subject: [PATCH] Some fixes --- docs/concepts/flags.md | 2 +- docs/concepts/instance.md | 2 +- docs/concepts/versioning.md | 2 +- docs/packaging/zip.md | 9 ++++----- 4 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/concepts/flags.md b/docs/concepts/flags.md index ecfa6a4..c1f639b 100644 --- a/docs/concepts/flags.md +++ b/docs/concepts/flags.md @@ -18,7 +18,7 @@ addon manifest, including for which side it is available and for which side it i If a side has this flag, this side will completly be ignored for the manifest. - `instance` This flag specifies, that this is a manifest of an [instance addon](instance.md). - `env` This flag is only valid for [instance addons](instance.md). It specifies, that the - [environment builder API](../api/features/env.md) will be used to bet the launch files for this addon. + [environment builder API](../api/features/env.md) will be used to get the launch files for this addon. An addon with this flag MUST have the [env_api](../schema/manifest.md#envapi) property. ## Relational flags diff --git a/docs/concepts/instance.md b/docs/concepts/instance.md index 4ca6da0..8a330e3 100644 --- a/docs/concepts/instance.md +++ b/docs/concepts/instance.md @@ -11,6 +11,6 @@ it on both sides, as long as the related addon is itself an instance addon for b ## Instance addons as relations If an instance addon is a relation of another instance addon, each side of that -relation MUST have at least one of the [flags](flags.md) `included`, `launch` +relation MUST have at least one of the [flags](flags.md) `included`, `launch`, `env` or `incompatible`. Non-instance addons MAY have instance addons as relations without this restrictions. \ No newline at end of file diff --git a/docs/concepts/versioning.md b/docs/concepts/versioning.md index c9157c9..07c8414 100644 --- a/docs/concepts/versioning.md +++ b/docs/concepts/versioning.md @@ -50,7 +50,7 @@ End Result Examples: Note: Contrary to what was stated in some design documents, for version order, snapshots are not treated differently than releases or any other qualifier. -### Dependancy Version Requirement Specification +### Dependency Version Requirement Specification Version requirements have the following syntax: diff --git a/docs/packaging/zip.md b/docs/packaging/zip.md index 279c291..74963c0 100644 --- a/docs/packaging/zip.md +++ b/docs/packaging/zip.md @@ -1,8 +1,7 @@ # Zip Packaging With zip packaging, the AddonScript file and the associated files are contained in -a zip file. The AddonScript file MUST be named `addon.json` and MUST either be placed -at the root of the zip file or, if there is just one directory in the root of the zip file, -in this directory. All files and directories inside the zip file can be accessed from AddonScript -using the [file links](../concepts/links.md#file). The path from the file URL is relative to the location of -the AddonScript file. +a zip file. The AddonScript file MUST be named `manifest.json` and MUST be placed +at the root of the zip file. All files and directories inside the zip file can be +accessed from AddonScript using the [file links](../concepts/links.md#file). +The path from the file URL is relative to the location of the AddonScript file.