TABLE OF CONTENTS


Packaging

[ Top ] [ Chapter 12 ] [ Concepts ]

INTRODUCTION

In most cases, only one binary package is created from a source package, including all files installed into $D. This is the default, and if this applies to your package, the rest of this section is irrelevant.

However, there are many cases -- often with library packages -- that it is desirable to create multiple binary packages from one source. cygport makes that very easy, by defining the variables described in this section.


PKG_NAMES

[ Top ] [ Packaging ] [ Variables ]

SYNOPSIS

  PKG_NAMES="foo libfoo1 libfoo-devel libfoo-doc"

DESCRIPTION

A list of binary packages to create from the files installed into D. The exact contents of these packages are specified in PKG_CONTENTS variables or .list files.

NOTES


PKG_HINTS

[ Top ] [ Packaging ] [ Variables ]

SYNOPSIS

  PKG_NAMES="foo libfoo1 libfoo-devel libfoo-doc"
  PKG_HINTS="setup runtime devel doc"

DESCRIPTION

A list of unsuffixed .hint files which should be used for each given binary package in PKG_NAMES.

NOTES


PKG_CONTENTS

[ Top ] [ Packaging ] [ Variables ]

SYNOPSIS

  PKG_NAMES="foo libfoo1 libfoo-devel libfoo-doc"
  foo_CONTENTS="--exclude=html usr/bin/foo.exe usr/share/doc/ usr/share/locale/"
  libfoo1_CONTENTS="usr/bin/cygfoo-1.dll"
  libfoo_devel_CONTENTS="usr/include/ usr/lib/ usr/share/aclocal/"
  libfoo_doc_CONTENTS="usr/share/doc/${NAME}/html/"

DESCRIPTION

A list of files to be included in each binary package. The PKG_CONTENTS name is descriptive rather than literal, where "PKG" should be substituted with the name of the binary package whose contents it describes. When a package contains a character which cannot be used in a shell variable name (namely '+', '-', and '.'), that character must be substituted with an underscore ('_'), such as libfoo-devel above.

NOTES


PKG_IGNORE

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A list of files that should not be included in any package, in the same form as PKG_CONTENTS. This will silence warnings on these files not being included in any package, and error if they are included in a package.


DIFF_EXCLUDES

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A list of file names, directory names, or glob patterns in S which will be excluded when creating the .src.patch file. This should be used for files automatically generated in S to avoid polluting the patch.

NOTE

Files generated by various buildsystem infrastructures, such as autoconf, automake, gettext, and libtool are already excluded automatically and need not be listed here.


CATEGORY

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A string containing one or more setup package categories. This will be used as the category: field of auto-generated .hint files.

NOTE

A list of official categories is available on the Cygwin website.

SEE ALSO

PKG_CATEGORY


PKG_CATEGORY

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A string containing one or more setup package categories. This will be used as the category: field of the corresponding auto-generated .hint file.

Note that the PKG_CATEGORY name is descriptive rather than literal, where "PKG" should be substituted with the name of the binary package whose contents it describes. When a package contains a character which cannot be used in a shell variable name (namely '+', '-', and '.'), that character must be substituted with an underscore ('_'), e.g. libfoo-devel will use libfoo_devel_CATEGORY.

NOTE

A list of official categories is available on the Cygwin website.


SUMMARY

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A one-line summary of the package. This will be used as the sdesc: field of auto-generated .hint files.

SEE ALSO

PKG_SUMMARY


PKG_SUMMARY

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A one-line summary of the subpackage. This will be used as the sdesc: field of the corresponding auto-generated .hint file.

Note that the PKG_SUMMARY name is descriptive rather than literal, where "PKG" should be substituted with the name of the binary package whose contents it describes. When a package contains a character which cannot be used in a shell variable name (namely '+', '-', and '.'), that character must be substituted with an underscore ('_'), e.g. libfoo-devel will use libfoo_devel_SUMMARY.


DESCRIPTION

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A short paragraph description of the package. This will be used as the ldesc: field of auto-generated .hint files.

SEE ALSO

PKG_DESCRIPTION


PKG_DESCRIPTION

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A short paragraph description of the subpackage. This will be used as the ldesc: field of the corresponding auto-generated .hint file.

Note that the PKG_DESCRIPTION name is descriptive rather than literal, where "PKG" should be substituted with the name of the binary package whose contents it describes. When a package contains a character which cannot be used in a shell variable name (namely '+', '-', and '.'), that character must be substituted with an underscore ('_'), e.g. libfoo-devel will use libfoo_devel_DESCRIPTION.


REQUIRES

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A single-line strings containing a list of packages on which this package depends. This will be added to the requires: field of the auto-generated .hint file.

NOTES

SEE ALSO

PKG_REQUIRES


PKG_REQUIRES

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A single-line strings containing a list of packages on which this package depends. This will be added to the requires: field of the auto-generated .hint file.

Note that the PKG_REQUIRES name is descriptive rather than literal, where "PKG" should be substituted with the name of the binary package whose contents it describes. When a package contains a character which cannot be used in a shell variable name (namely '+', '-', and '.'), that character must be substituted with an underscore ('_'), e.g. libfoo-devel will use libfoo_devel_REQUIRES.

NOTES


OBSOLETES

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A single-line string containing a list of package(s) which this package replaces. An empty package will be created for each listed obsoletion which will cause this package to be installed in its place.

NOTE

If there is more than one package in PKG_NAMES, this variable will be ignored; you must use PKG_OBSOLETES instead.

SEE ALSO

PKG_OBSOLETES


PKG_OBSOLETES

[ Top ] [ Packaging ] [ Variables ]

DESCRIPTION

A single-line string containing a list of package(s) which this package replaces. An empty package will be created for each listed obsoletion which will cause PKG to be installed in its place.

Note that the PKG_REQUIRES name is descriptive rather than literal, where "PKG" should be substituted with the name of the binary package whose contents it describes. When a package contains a character which cannot be used in a shell variable name (namely '+', '-', and '.'), that character must be substituted with an underscore ('_'), e.g. libfoo-devel will use libfoo_devel_OBSOLETES.