|author||Kylie McClain <email@example.com>||2020-07-07 09:25:02 -0400|
|committer||Kylie McClain <firstname.lastname@example.org>||2020-07-07 09:33:53 -0400|
theory(5): rearrange parts of "Metadata"; description --> summary
1 files changed, 30 insertions, 21 deletions
diff --git a/theory.5.adoc b/theory.5.adoc
index d970fc7..ab9acea 100644
@@ -42,35 +42,19 @@ optional items, anything else required:
-=== Repository metadata
Repositories *must* have a directory in their root named `metadata`.
-==== Dependencies (optional)
-Repositories *may* contain a file in `metadata`, named `dependencies`. The `dependencies` file *must*
-contain a single repository on each line. Repositories listed in this file are repositories which the
-package manager *must* have installed prior to the installation of the repository depending on them.
-The order in which they are listed is unspecified.
-Any repository listed will have its `libraries` directory searched when parsing package files; the order
-in which they are searched is determined by the `priority` value of the repository.
-Do not add repositories to `dependencies` simply because a package in your repository depends on something
-in another repository. The package manager *shall* deal with determining what repository needs to be
-installed to satisfy a dependency through usage of the link:#universe[`universe` meta-repository].
-Repositories *should* have a summary. The summary should be a short, one-line blurb describing the
-repository's contents or objective.
Repositories *must* have a file within `metadata` named `priority`.
The `priority` file *must* contain a non-negative integer.
-The intended scheme goes like so:
+There _are_ meanings that go with each number, and they go like so:
. First-party primary repository, over which nothing has a greater priority
There should only be one repository with this level. (ex. Base packages for a system.)
@@ -79,6 +63,31 @@ The intended scheme goes like so:
. First-party tertiary repository. (ex. A distribution developer's repository.)
. Third-party repository. (ex. A distribution user's repository.)
+Repositories *should* have a summary. The contents should be a short, one-line blurb, describing
+the repository's contents, objective, or theme.
+For example, in listings, a package manager could show the summary next to the repository's name.
+==== Dependencies (optional)
+Repositories can optionally have a file in `metadata`, named `dependencies`.
+The file should be a list of the names of repositories on each line. Repositories listed in this
+file are dependent repositories, with which the package manager *must* have installed prior to the
+installation of the repository declaring these dependencies. The order in which they are listed in
+the file is unimportant.
+Any repository listed will have its `libraries` directory searched when parsing package files; the order
+in which they are searched is determined by the `priority` value of the repository.
+Do not add repositories to `dependencies` simply because a package in your repository depends on something
+in another repository. The package manager should deal with determining what repository needs to be
+installed to satisfy a dependency through usage of the <<repo-meta,`universe` meta-repository>>.
Repositories *should* contain a directory named `packages`; if they do not, package managers *may*