[23824] users/jberry/mpwa/doc/portpkg-design.txt
source_changes at macosforge.org
source_changes at macosforge.org
Tue Apr 10 08:27:24 PDT 2007
Revision: 23824
http://trac.macosforge.org/projects/macports/changeset/23824
Author: jberry at macports.org
Date: 2007-04-10 08:27:23 -0700 (Tue, 10 Apr 2007)
Log Message:
-----------
Add a document describing the (potential) contents of a portpkg
Added Paths:
-----------
users/jberry/mpwa/doc/portpkg-design.txt
Added: users/jberry/mpwa/doc/portpkg-design.txt
===================================================================
--- users/jberry/mpwa/doc/portpkg-design.txt (rev 0)
+++ users/jberry/mpwa/doc/portpkg-design.txt 2007-04-10 15:27:23 UTC (rev 23824)
@@ -0,0 +1,64 @@
+This document contains some information about the internal structure of a portpkg.
+
+A portpkg is the unified container for information about a port. They are contained in an file produced by xar. xar contains two elements: files and additional meta information. So we break our discussion of portpkg format into the two areas.
+
+portpkg files
+=============
+Files in a portpkg are mostly just the contents of the port directory, rooted at portpkg:
+
+ portpkg/
+ Portfile
+ files/
+ <additional files or directories>
+
+We may also have a reason for additional files and/or manifest information: tbd.
+
+Notes:
+
+ The contents of the port directory tree are always under the portpkg root in the xar file. At some point additional information may be stored in other top-level trees inside the xar file.
+
+
+portpkg meta information
+========================
+The schema for meta information in the xar file is not yet finalized, but we anticipate the following information will be present:
+
+ * Portpkg version
+ * Creation Date
+
+ * Submitter Name
+ * Submitter Email address
+ * Submitter Notes (about the package)
+
+ * Port name
+ * Port homepage
+ * Port categories (tags to apply on submission)
+
+ * Port epoch
+ * Port version
+ * Port revision
+
+ * Description
+ * Long description
+
+ * Direct Dependencies
+ * Variants
+ * Variant
+ * Dependencies
+ * Platforms
+ * Platform spec
+ * Dependencies
+
+ Additionally, it's possible that the following additional metainformation will be appended on submission of the portpkg
+ through mpwa:
+
+ * Submitter Account UserName
+ * Submission Date
+ * PkgID
+ * PkgURL
+
+Notes:
+
+ Note that much of this information is available in the Portfile, but it is presented here in static form, and is available without parsing the portfile.
+
+
+
\ No newline at end of file
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20070410/73987cbf/attachment.html
More information about the macports-changes
mailing list