Cygwin

Get that Linux feeling - on Windows

Cygwin Package Contributor's Guide

This document is intended for people who upload packages to sourceware.org, to be made available through the standard Cygwin setup program.

The cygwin-apps mailing list is the correct place to discuss any package creation or maintenance issues. It is not a place for end user bug reports - direct those to the cygwin mailing list instead.

See also

Contents

Making a package with cygport

While older, hand-made packages exist, the only accepted way to make a new Cygwin package is using the cygport tool, which automatically handles most packaging requirements and issues for you. It is also strongly recommended to convert existing packages to cygport when updating them; ask on the cygwin-apps list if you need help converting an existing package to use cygport.

The cygport framework improves on previous Cygwin build scripts, and borrows concepts from the Gentoo portage system.

Suppose that the upstream's boffo-1.0.tar.xz source tar file, that you downloaded from the boffo homepage, unpacks into boffo-1.0/.

Further, suppose you've got boffo ported to Cygwin. It took some work, but you've got a patch file, which we will name boffo-1.0-fix-whatever.patch, and with that applied boffo builds and runs.

All that remains is to write a boffo.cygport file which will describe how to unpack, configure, build and package:

# package name
NAME="boffo"
VERSION=1.0
RELEASE=1

# .hint generation
CATEGORY="Games"
SUMMARY="A whackamole simulation in ASCII art"
DESCRIPTION="A whackamole simulation in ASCII art.
Intended for use on VT100 terminals at BAUD rates 1200 and
above.  Uses arrow keys for positioning over moles.  Space
bar whacks the mole.
No actual moles will be harmed during execution of this game."

# source and patch files
SRC_URI="http://boffo.org/downloads/boffo-${VERSION}.tar.xz"
PATCH_URI="boffo-1.0-fix-whatever.patch"

# use the standard src_compile, src_install and src_test

The source and binary packages can then be built and a .hint generated by running cygport boffo.cygport all.

For more information on using cygport consult the man page, README, reference manual and sample .cygport files.

Submitting a new package

So you've got a package you want to submit. Follow the following checklist before emailing the cygwin-apps mailing list, and you'll almost certainly save time.

Uploading an accepted package

  1. Once you have your GTG, follow these instructions for submitting a ssh key and uploading your package files.
  2. Announce via the cygwin-announce mailing list that the new package is available. Use the announce message example listed later in this page as a template for your announcement.
    Be sure the unsubscribe instructions are included at the end of the email, since cygwin-announce does not add any.
    Once sent, your message will be reviewed by one of the cygwin-announce moderators and, once approved, will be automatically forwarded to the cygwin mailing list with an [ANNOUNCEMENT] prepended to the subject.
  3. Feel free to delete your local copy once the files have been uploaded to sourceware.org.

Updating a package

So you've got an updated package you want to submit. You should already have upload privileges, and should be able to do the entire process yourself, by following these instructions. If you encounter any problems, email the cygwin-apps mailing list.

  1. There is no need to increase the release number if the package has not been officially released. So, if you are releasing a -1 release of a package keep using -1 for any refinements until the package has been uploaded.
  2. Thereafter, you must increase the version or release number when uploading an updated version of the package.
  3. After doing a upload, announce via the cygwin-announce mailing list that the new package is available. Use the announce message example listed later in this page as a template for your announcement..
    Once sent, your message will be reviewed by one of the cygwin-announce moderators and, once approved, will be automatically forwarded to the cygwin mailing list with an [ANNOUNCEMENT] prepended to the subject.

NOTE: On any major version upgrade, you may want to mark the release as Test.

Example announcement


Subject: New package: foo-0.30.2-1
or
Updated: foo-0.30.2-1
Version 0.30.2-1 of "foo" has been uploaded.

(a couple of lines about what "foo" is)
(short changelog of important features or fixes; big emphasis for security fixes)

              *** CYGWIN-ANNOUNCE UNSUBSCRIBE INFO ***

If you want to unsubscribe from the cygwin-announce mailing list, look at the "List-Unsubscribe: " tag in the email header of this message. Send email to the address specified there. It will be in the format:

cygwin-announce-unsubscribe-you=yourdomain.com <at> cygwin.com

If you need more information on unsubscribing, start reading here:

https://sourceware.org/lists.html#unsubscribe-simple

Please read *all* of the information on unsubscribing that is available starting at this URL.