From 2178112dac4c812a92fc5e5d78c602856b2c81db Mon Sep 17 00:00:00 2001
From: Juan RP <xtraeme@gmail.com>
Date: Sat, 7 Feb 2009 17:22:09 +0100
Subject: [PATCH] Add a plist file explaining pkg's dependency chain format.

--HG--
extra : convert_revision : 65b569dbd420e0201aca3fb30f0696e72cb5708f
---
 doc/dependency_chain.plist | 84 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 doc/dependency_chain.plist

diff --git a/doc/dependency_chain.plist b/doc/dependency_chain.plist
new file mode 100644
index 00000000000..7cb8677bd63
--- /dev/null
+++ b/doc/dependency_chain.plist
@@ -0,0 +1,84 @@
+<dict>
+	 -- Dependency chain for a package --
+
+	 The order to which dependencies are installed is:
+
+		1- Indirect deps with high->low priority.
+		2- Direct deps with high->low priority.
+
+	Priority is increased by one any time a packages depends on, so a
+	package that is needed by 30 packages will be installed before
+	one that is needed by 10 packages.
+
+	<!-- Required deps that weren't found on any repository -->
+
+	<key>missing_deps</key>
+	<array>
+		<dict>
+			<key>pkgname</key>
+			<string>blurb</string>
+			<key>version</key>
+			<string>2.1</string>
+		</dict>
+	</array>
+
+	<!-- Required deps that are satisfied/installed -->
+
+	<key>installed_deps</key>
+	<array>
+		<dict>
+			<key>pkgname</key>
+			<string>blah</string>
+			<key>version</key>
+			<string>1.2</string>
+			<key>requiredby</key>
+			<string>foo-2.0</string>
+		</dict>
+		...
+	</array>
+
+	<!--
+	    An array of dicctionaries for direct required deps,
+	    sorted by descending order of priority.
+	-->
+
+	<key>direct_deps</key>
+	<array>
+		<dict>
+			<key>pkgname</key>
+			<string>blob</string>
+			<key>version</key>
+			<string>2.0</string>
+			<key>repository</key>
+			<string>/blah/foo</string>
+			<key>requiredby</key>
+			<string>foo-2.0</string>
+			<key>priority</key>
+			<integer>100</integer>
+			<key>filename</key>
+			<string>blob-2.0.i686.xbps</string>
+		</dict>
+		...
+	</array>
+
+	<!- An array of diccionaries for indirect required deps -->
+	
+	<key>indirect_deps</key>
+	<array>
+		<dict>
+			<key>pkgname</key>
+			<string>X</string>
+			<key>version</key>
+			<string>1.0</string>
+			<key>repository</key>
+			<string>/blah/foo</string>
+			<key>requiredby</key>
+			<string>blob-2.0</string>
+			<key>priority</key>
+			<integer>90</integer>
+			<key>filename</key>
+			<string>X-1.0.i686.xbps</string>
+		</dict>
+		...
+	</array>
+</dict>