Construct ipkg packages (for developers) - Revision history

Jonli447 at 02:02, 11 September 2007

Jonli447 — Tue, 11 Sep 2007 02:02:56 GMT

← Older revision		Revision as of 02:02, 11 September 2007
Line 21:		Line 21:
	=== ipkg-utils ===		=== ipkg-utils ===

-	''.ipk'' packages can be built using the tools contained in <tt>ipkg-utils</tt>. You may download <tt>ipkg-utils</tt> from the [http://downloads.~~linkstationwiki~~.~~net~~ downloads area] or from the [ftp://ftp.handhelds.org/packages/ipkg-utils/ <tt>ipkg-utils</tt> home page]. To ensure compatibility, packages which are to be submitted to the official LinkStationWiki ipkg feed should be built using the version of <tt>ipkg-utils</tt> available from the [http://downloads.~~linkstationwiki~~.~~net~~ downloads area].	+	''.ipk'' packages can be built using the tools contained in <tt>ipkg-utils</tt>. You may download <tt>ipkg-utils</tt> from the [http://downloads.nas-central.org downloads area] or from the [ftp://ftp.handhelds.org/packages/ipkg-utils/ <tt>ipkg-utils</tt> home page]. To ensure compatibility, packages which are to be submitted to the official LinkStationWiki ipkg feed should be built using the version of <tt>ipkg-utils</tt> available from the [http://downloads.nas-central.org downloads area].

	Most of the tools contained in <tt>ipkg-utils</tt>, such as <tt>ipkg-build</tt>, are shell scripts. Please note, however, that some of the tools require Python. Non of them comes with any documentation. From studying the source code it has been concluded that <tt>ipkg-utils</tt> contains the following tools:		Most of the tools contained in <tt>ipkg-utils</tt>, such as <tt>ipkg-build</tt>, are shell scripts. Please note, however, that some of the tools require Python. Non of them comes with any documentation. From studying the source code it has been concluded that <tt>ipkg-utils</tt> contains the following tools:

77.128.162.13: /* Using ipkg-build from ipkg-utils */

77.128.162.13 — Thu, 08 Mar 2007 21:44:43 GMT

Using ipkg-build from ipkg-utils

← Older revision		Revision as of 21:44, 8 March 2007
Line 67:		Line 67:
	# The owner, group, and access permissions of the input files must be configured as they should appear when installed		# The owner, group, and access permissions of the input files must be configured as they should appear when installed

-	Build System \| ~~In other context a~~ ''build system'' ~~is the~~ software system, e.g. a Makefile system, for building some software. ~~Here we use the term to identify the~~ computer and environment where ~~the~~ software and packages are constructed.	+	{{Postit\|Build System\|The term ''build system'' has two meanings
		+	#A software system, e.g. a Makefile system, for building some software from source code.
		+	#The computer and environment where a software and packages are constructed.
		+	The actual meaning should be clear from the context.}}

	We will call this directory structure the ''prototype'' structure for the purpose of this document. The system (LinkStation) on which you want to install packages will be called the ''target system''. The system on which you build the software and the package will be called the ''build system''.		We will call this directory structure the ''prototype'' structure for the purpose of this document. The system (LinkStation) on which you want to install packages will be called the ''target system''. The system on which you build the software and the package will be called the ''build system''.
Line 78:		Line 81:

	[[#Building an .ipk - using ipkg-mk on top of ipkg-build\|ipkg-mk]] (described below) is a tool to gain more control over the building of a package, than with ipkg-build. However, ipkg-mk can't fix the problem of having to have ''root'' access to build non-trivial packages. It also does not fix the problem of missing user or group definitions on the build system.		[[#Building an .ipk - using ipkg-mk on top of ipkg-build\|ipkg-mk]] (described below) is a tool to gain more control over the building of a package, than with ipkg-build. However, ipkg-mk can't fix the problem of having to have ''root'' access to build non-trivial packages. It also does not fix the problem of missing user or group definitions on the build system.
		+
		+	{{Postit\|Root\|One almost for sure needs root rights on the build system to correctly build a non-trivial package.}}

	=== Fixing ipkg-build v1.7 ===		=== Fixing ipkg-build v1.7 ===

77.128.162.13: /* Build with tool-generated `prototype` File */

77.128.162.13 — Thu, 08 Mar 2007 21:37:57 GMT

Build with tool-generated <code>prototype</code> File

← Older revision		Revision as of 21:37, 8 March 2007
Line 198:		Line 198:
	See the '''ipkt-prototype'''(4) man page for more details of the format.		See the '''ipkt-prototype'''(4) man page for more details of the format.

-	==== Build with ~~tool~~-generated <code>prototype</code> File ====	+	==== Build with '''ipkg-proto''' generated <code>prototype</code> File ====
	In order to create a raw prototype file (which needs further manual editing) from an existing directory structure, a tool called '''ipkg-proto''' is available.		In order to create a raw prototype file (which needs further manual editing) from an existing directory structure, a tool called '''ipkg-proto''' is available.

77.128.162.13: /* Build a package */

77.128.162.13 — Thu, 08 Mar 2007 21:35:14 GMT

Build a package

← Older revision		Revision as of 21:35, 8 March 2007
Line 166:		Line 166:

	=== Build a package ===		=== Build a package ===
-		+	==== Build with manually created <code>prototype</code> File ====
	Once the environment is set up, the following steps can be performed to build a package with '''ipkg-mk''':		Once the environment is set up, the following steps can be performed to build a package with '''ipkg-mk''':

Line 198:		Line 198:
	See the '''ipkt-prototype'''(4) man page for more details of the format.		See the '''ipkt-prototype'''(4) man page for more details of the format.

		+	==== Build with tool-generated <code>prototype</code> File ====
	In order to create a raw prototype file (which needs further manual editing) from an existing directory structure, a tool called '''ipkg-proto''' is available.		In order to create a raw prototype file (which needs further manual editing) from an existing directory structure, a tool called '''ipkg-proto''' is available.
		+
		+	The following image depicts the workflow:
	+------------+		+------------+
	existing +------------+ raw \| manual \|		existing +------------+ raw \| manual \|
	directory ---> \| ipkg-proto \| ---> prototype ---> \| editing/ \| --+		directory ---> \| ipkg-proto \| ---> prototype ---> \| editing/ \| --+
	structure +------------+ file \| refinement \| \|		structure +------------+ file \| refinement \| \|
-	\| +------------+ \|	+	^ +------------+ \|
-	v \|	+	\| \|
-	application +------------- prototype <---------------------+	+	application's +------------- prototype <---------------------+
	files \|		files \|
	\| v		\| v
Line 215:		Line 218:
	CONTROL files		CONTROL files
	add. application files		add. application files
		+
		+	#The application's files are build (e.g. created from source code), or they are obtained in some other way.
		+	#The application's files are then placed into a directory structure which mimics the file's organization on the target system. Build systems, like the typical ''GNU build system used for many free software'', can be convinced to do this via their ''install'' target.
		+	#'''ipkg-proto''' is run to create an initial, raw ''prototype'' file.
		+	#The ''prototype'' file is manually edited to refine and complete it.
		+	#'''ipkg-mk''' is used to evaluate the ''prototype'' file and copy (''spool'') the application files and any referenced CONTROL files to a clean prototype directory structure.
		+	#Finally '''ipkg-build''' is used to transfer the prototype directory structure into the desired package.

	'''ipkg-proto''' can be installed via '''ipkg''':		'''ipkg-proto''' can be installed via '''ipkg''':
Line 238:		Line 248:
	s none /lib/libcom_err.so.2=libcom_err.so.2.0		s none /lib/libcom_err.so.2=libcom_err.so.2.0
	...		...
-

	== Package structure / prototype directory structure ==		== Package structure / prototype directory structure ==

77.128.162.13 at 20:05, 8 March 2007

77.128.162.13 — Thu, 08 Mar 2007 20:05:17 GMT

← Older revision		Revision as of 20:05, 8 March 2007
Line 156:		Line 156:
	man ipkg-prototype		man ipkg-prototype

-	And to view the documentation for the ~~formater~~ and the man page viewer you can type:	+	And to view the documentation for the formatter and the man page viewer you can type:

	man awf		man awf

59.92.116.31: /* A sample architecture-independen ipkg `CONTROL/control file` */

59.92.116.31 — Thu, 08 Mar 2007 10:58:25 GMT

A sample architecture-independen ipkg <tt>CONTROL/control file</tt>

← Older revision		Revision as of 10:58, 8 March 2007
Line 511:		Line 511:

	== Sample <tt>CONTROL/control</tt> files ==		== Sample <tt>CONTROL/control</tt> files ==
-	=== A sample architecture-~~independen~~ ipkg <tt>CONTROL/control file</tt> ===	+	=== A sample architecture-independent ipkg <tt>CONTROL/control file</tt> ===
	Architecture independent packages are packages which e.g. control scripts which run on "any" architecture or documentation which is not architecture specific.		Architecture independent packages are packages which e.g. control scripts which run on "any" architecture or documentation which is not architecture specific.

Line 523:		Line 523:
	Depends: list,of,other,packages		Depends: list,of,other,packages
	Description: Description of the software		Description: Description of the software
-

	=== A sample PPC ipkg <tt>CONTROL/control</tt> file ===		=== A sample PPC ipkg <tt>CONTROL/control</tt> file ===

89.52.195.57 at 20:16, 8 January 2007

89.52.195.57 — Mon, 08 Jan 2007 20:16:45 GMT

Show changes

89.52.195.57: Minor spelling corrections

89.52.195.57 — Mon, 08 Jan 2007 19:36:19 GMT

Minor spelling corrections

Show changes

89.52.195.233: /* Obtaining and installing ipkg-mk */

89.52.195.233 — Sun, 30 Jul 2006 18:07:20 GMT

Obtaining and installing ipkg-mk

← Older revision		Revision as of 18:07, 30 July 2006
Line 129:		Line 129:
	So, currently the installation of '''ipkg-mk''' on the LS with OpenLink requires some manual work:		So, currently the installation of '''ipkg-mk''' on the LS with OpenLink requires some manual work:

-	*~~'''~~ (''Only on pre OpenLink 0.60'') Follow the [[Articles/GeneralIpkgOnLinkstation#ManInst\|manual ipkg installation]] instructions to obtain, install and update the '''ipkg''' client itself.~~'''~~	+	*(''Only on pre OpenLink 0.60'') Follow the [[Articles/GeneralIpkgOnLinkstation#ManInst\|manual ipkg installation]] instructions to obtain, install and update the '''ipkg''' client itself.

-	*~~'''~~ Download the [[ftp://ftp.handhelds.org/packages/ipkg-utils/ipkg-utils-1.7.tar.gz \| ipkg-utils]], extract the '''ipkg-build''' script out of the archive and place it in ~~'''~~/usr/bin'''.'''	+	*Download the [[ftp://ftp.handhelds.org/packages/ipkg-utils/ipkg-utils-1.7.tar.gz \| ipkg-utils]], extract the '''ipkg-build''' script out of the archive and place it in <tt>/usr/bin</tt>.
		+
		+	*Install the '''awf''' formater (needed for viewing the documentation). This can already be done via '''ipkg''':

-	*''' Install the '''awf''' formater (needed for viewing the documentation). This can already be done via '''ipkg''':
-	~~'''~~
	ipkg install http://people.freenet.de/lsnix/LinkStation/awf_0.1-1_all.ipk		ipkg install http://people.freenet.de/lsnix/LinkStation/awf_0.1-1_all.ipk

-	*''' Install the [aw]man package (for formating and viewing manual pages):~~'''~~	+	:However, if you don't have a working ipkg installations, see [[Install an .ipk package without having the ipkg package management system (for end-users)]] for manually installing '''awf''' and all the other mentioned packages below.
		+
		+	*Install the [aw]man package (for formating and viewing manual pages):

	ipkg install http://people.freenet.de/lsnix/LinkStation/awman_0.1-1_all.ipk		ipkg install http://people.freenet.de/lsnix/LinkStation/awman_0.1-1_all.ipk

-	*~~'''~~ And finally (''phew ...'') install @@ipkg-mk~~@@:~~'''	+	*And finally (''phew ...'') install '''ipkg-mk''':

	ipkg install http://people.freenet.de/lsnix/LinkStation/ipkg-mk_0.2-1_all.ipk		ipkg install http://people.freenet.de/lsnix/LinkStation/ipkg-mk_0.2-1_all.ipk

-	To read the ipkg-mk documentation you can now type:	+	To read the '''ipkg-mk''' documentation you can now type:

	man ipkg-mk		man ipkg-mk

89.52.195.233: /* Introduction */

89.52.195.233 — Sun, 30 Jul 2006 18:01:09 GMT

Introduction

← Older revision		Revision as of 18:01, 30 July 2006
Line 104:		Line 104:
	=== Introduction ===		=== Introduction ===

-	'''ipkg-mk''' is a script which takes a prototype package description as input, spools (creates) the necessary prototype directory structure, and ~~use~~ '''ipkg-build''' to construct a package from the spooled prototype directory structure.	+	'''ipkg-mk''' is a script which
		+	*takes a <tt>prototype</tt> package description as input,
		+	*spools (creates) the necessary prototype directory structure, and
		+	*uses '''ipkg-build''' to construct a package from the spooled prototype directory structure.

-	~~The tool's prototype description format is a variant of the Unix System V Release 4~~ (~~SVR4~~) ~~package management~~'~~s prototype description format~~. ~~By relying on an explicite prototype description file~~ it ~~is possible~~ to	+	These are steps (except the last one) which are either not handled by '''ipkg-build''' at all, or are very tedious. '''ipkg-mk''' provides a paradigm change. From having to somehow physically construct the package directory structure, one can now declare that structure in a simple definition language, and leave it to the tool to do the rest.

-	*''' gain more control over the package ~~structure (explicite descriptions instead~~ of ~~implicite file attributes in some directory structure~~)'~~'',~~	+	The package layout declaration is in what is called a <tt>prototype</tt> file, since it specifies the prototypical format of the package. The format is a variant of the Unix System V Release 4 (SVR4) package management's prototype description format. By relying on an explicite prototype description file it is possible to

-	*~~''' to have~~ the package structure ~~in one place~~ (instead of ~~having to analyse a~~ directory structure), ~~and to'''~~	+	*gain more control over the package structure (explicite descriptions instead of implicite file attributes in some directory structure),

-	*~~'''~~ be able to version-control the package structure (since the prototype description file can and should be placed under version control).~~'''~~	+	*to have the package structure in one place (instead of having to analyse a directory structure), and to
		+
		+	*be able to version-control the package structure (since the prototype description file can and should be placed under version control), e.g. using rcs, cvs, sccs or subversion for version control.

	'''ipkg-mk''' does not fix some of the principle problems of the ipkg package format. For example, it does not fix the problem of having to have ''root'' rights. In fact, '''ipkg-mk''' requires to be executed by ''root''.		'''ipkg-mk''' does not fix some of the principle problems of the ipkg package format. For example, it does not fix the problem of having to have ''root'' rights. In fact, '''ipkg-mk''' requires to be executed by ''root''.