ABOUT THIS DOCUMENT
===================

This document describes version 1.0 of the format for software source packages.


LEGAL NOTICE
============

Copyright (C) 2012 Patrick (P. J.) McDermott

This document may be reproduced, distributed, modified, and otherwise dealt in
under the terms of the Expat/MIT License:
http://www.jclark.com/xml/copying.txt


SPECIFICATION STATUS
====================

This specification is in draft status.  It is a work-in-progress and is subject
to change.  Comments and revisions are welcome.


BACKGROUND
==========

A source package consists of software source code, a build system, and package
metadata.  From it is built one or more binary packages, which can be installed
into an operating system.


RATIONALE
=========

This source package format is modeled after the package format of the OpenBricks
Embedded Linux Framework.  Unlike the OpenBricks format, however, this format is
designed to support the building of multiple binary packages from one source
package.  Additionally, source packages in this format are intended to be
maintained independently rather than in one monolithic software repository (such
as that of OpenBricks).  In these and other respects, this format draws
inspiration from Debian's source package formats.


DIRECTORY STRUCTURE
===================

<pkgname>_<pkgver>-<pkgrev>/
 +- <binpkg>.pkg/
 |   +- build
 |   |    A script to build the binary package.
 |   +- control
 |   |    Metadata about the binary package.
 |   +- install
 |   |    A script to install the binary package.
 |   +- postinst
 |   +- postrm
 |   +- preinst
 |   \- prerm
 +- control
 |    Metadata about the source package.
 +- format
 |    A magic file to identify the source format version.  Should simply contain
 |    the string "1.0".
 +- patches/
 |    Patches to be applied to package sources before building.
 +- <pkgname>_<pkgver>.<ext>
 |    Upstream source archive (for non-native packages).
 \- src/
      Package sources (for native packages).

'install' might be replaced by a file or files similar to 'dirs' and 'install'
of Debian packages.

'build' and 'install' in the binary package directory might be combined into a
dpkg-style make file with targets for building and installing.


BINARY PACKAGE METADATA
=======================

Refer to documentation for APT and opkg.


SOURCE PACKAGE METADATA
=======================

The format of the source package metadata is to be determined.  It should
resemble either Debian package control file syntax or OpenBricks package
metadata file (shell script) syntax.

Metadata will include information necessary to maintain the source package and
build the binary package(s).  Fields will include the upstream source, build
dependencies, and maintainer contact information.