Difference between revisions of "TODO:apk"

From Alpine Linux
Jump to: navigation, search
(.apk Generator: Update usage and TODO items)
(Manifests: Add description, formats, and TODO header.)
Line 11: Line 11:
  
 
==Manifests==
 
==Manifests==
apk manifest [-v] (<pkg>|<.apk>)...
+
<code>apk manifest [-v] (<pkg>|<.apk>)...</code>
 +
 
 +
Generate a manifest of files contained within the specified package(s)/apk(s).
 +
 
 +
Current default format is:
 +
<code><i>sumfunc</i>:<i>checksum</i>  <i>path</i></code>
 +
 
 +
With verbose flag:
 +
<code><i>pkgname</i>: <i>sumfunc</i>:<i>checksum</i>  <i>path</i></code>
 +
 
 +
Proposed canonical format:
 +
<code>pkg:<i>arch</i>/<i>pkgname</i>-<i>pkgver</i>\t<i>mode</i>\t<i>user</i>:<i>group</i>\t<i>size</i>\t<i>timestamp</i>\t<i>sumfunc</i>:<i>checksum</i>\t<i>path</i></code>
 +
 
 +
===TODO Items===
 
* Define a canonical default manifest format which contains all available metadata in a reliably parsable format.
 
* Define a canonical default manifest format which contains all available metadata in a reliably parsable format.
 
* Add ability to specify manifest format and fields in a manner similar to 'stat'.
 
* Add ability to specify manifest format and fields in a manner similar to 'stat'.

Revision as of 00:37, 4 June 2017

TODO: apk

Documentation

  • Document current apk internals.
  • Define 'virtual', 'alternative', and their proper use.


Alternatives

Plugable Layouts

Manifests

apk manifest [-v] (<pkg>|<.apk>)...

Generate a manifest of files contained within the specified package(s)/apk(s).

Current default format is: sumfunc:checksum path

With verbose flag: pkgname: sumfunc:checksum path

Proposed canonical format: pkg:arch/pkgname-pkgver\tmode\tuser:group\tsize\ttimestamp\tsumfunc:checksum\tpath

TODO Items

  • Define a canonical default manifest format which contains all available metadata in a reliably parsable format.
  • Add ability to specify manifest format and fields in a manner similar to 'stat'.
  • Add ability to select a subset of files to display in a manner similar to tar. (i.e. 'etc/' or 'lib/*.so')
  • Add ability to generate manifest from a filesystem directory structure or path list.
  • (DONE - kaniini) Add ability to generate manifest for .apk file in addition to installed packages.

.apk Generator

apk gen --key-file=... --control-dir=... --data-dir=...

Generates a well-formed .apk from a key file and two filesystem directories -- one for the control portion and one for the data portion.

TODO Items:

  • Document current WIP (kaniini).
  • Add ability to use an archive as the source for control or data directories.
  • Add ability to use a pre-generated manifest as the source file list and provider of package's file meta-data.

pax Archive Tool