aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKylie McClain <kylie@somas.is>2020-07-07 09:22:50 -0400
committerKylie McClain <kylie@somas.is>2020-07-07 09:33:53 -0400
commit38f206beebcd68b221c848ac7873127f344bb089 (patch)
treef54c9652396a2023161208376c29f2bf42485dde
parent9f880f01c1561756aafc4589b2760e29004a6383 (diff)
downloadpraxis-38f206beebcd68b221c848ac7873127f344bb089.tar.gz
praxis-38f206beebcd68b221c848ac7873127f344bb089.tar.xz
praxis-38f206beebcd68b221c848ac7873127f344bb089.zip
theory(5): various improvmenets to "Repositories"
- describe praxis(7) behavior when relevant - don't be so wordy - add links to the matching sections for list items - remove note about PKGDIR, since it's not gonna be declared until actually needed in practice.
-rw-r--r--theory.5.adoc26
1 files changed, 12 insertions, 14 deletions
diff --git a/theory.5.adoc b/theory.5.adoc
index f899cd3..d970fc7 100644
--- a/theory.5.adoc
+++ b/theory.5.adoc
@@ -13,28 +13,26 @@ or anything that consumes the data.
== Repositories
Package managers *must* support multiple repositories. The internal prioritization of these
-repositories is dictated by the <<priority>>. User-facing sort (ex. when listing repositories
-installed on the system) is not defined.
+repositories is dictated by the <<priority,priority>>. User-facing sort (ex. when listing
+repositories installed on the system) is not defined, but praxis(7) sorts them alphabetically.
Repository names are alphanumeric plus `_` and `-`.
-The file and directory layout of a valid repository is as follows, _italicized_ items representing
+The file and directory layout of a repository is as follows, _italicized_ items representing
optional items, anything else required:
-* <repository name>/
- ** metadata/
- *** _dependencies_
- *** _summary_
- *** priority
+* `<repository>`/
+ ** _dependencies_
+ ** <<repo-metadata,metadata>>/
+ *** <<repo-priority,priority>>
+ *** _<<repo-summary,summary>>_
** _libraries_/
- *** library1
+ *** <<library-actions,action>>
** packages/
- *** openssh#1.2.3/ - This directory's path is exported as `${PKGDIR}`.
+ *** openssh#1.2.3/
+ **** <<actions,action>>
**** _dependencies_
- **** _libraries_ - Libraries to be used for constructing the package's theory.
- **** _sha256sum_
- **** _sources_
- **** theory0
+ **** _libraries_ - Libraries to be combined together to create the package.
**** _metadata/_ - All files under this directory are exported as environment variables
after importing all libraries.
***** _HOMEPAGE_