[csw-devel] SF.net SVN: gar:[5794] csw/mgar/pkg/template/trunk/Makefile

[wahwah at users.sourceforge.net]

Revision: 5794
          http://gar.svn.sourceforge.net/gar/?rev=5794&view=rev
Author:   wahwah
Date:     2009-08-01 08:41:19 +0000 (Sat, 01 Aug 2009)

Log Message:
-----------
template: Added comments with common settings, based on http://sourceforge.net/apps/trac/gar/wiki/Building%20for%20multiple%20ISAs

Modified Paths:
--------------
    csw/mgar/pkg/template/trunk/Makefile

Property Changed:
----------------
    csw/mgar/pkg/template/trunk/Makefile

Modified: csw/mgar/pkg/template/trunk/Makefile
===================================================================
--- csw/mgar/pkg/template/trunk/Makefile	2009-08-01 07:56:59 UTC (rev 5793)
+++ csw/mgar/pkg/template/trunk/Makefile	2009-08-01 08:41:19 UTC (rev 5794)
@@ -1,24 +1,156 @@
 # Copyright 2009 OpenCSW
 # Distributed under the terms of the GNU General Public License v2
-# $Id$
+# $Header$
 
+## This file contains comments to guide you through various GAR settings.
+## Please remove unnecessary comments before committing your code to the code
+## repository. The comments to remove are marked with double hashes.
+##
+## For more information, please see:
+## https://sourceforge.net/apps/trac/gar/wiki/GAR%20Variable%20Reference
+
 GARNAME = mypkg
 GARVERSION = 1.0
+
+## The category that your software fits in. This is not a descriptive field, but
+## influences the build process. Depending on the CATEGORIES setting, different
+## Makefiles are included from gar/categories/ in your trunk directory, which
+## adjust the build settings for the respective category.
+##
+## Possible settings are:
+## apps, cpan, devel, gnome, java, kde, lang, lib, meta, net, server, utils, x11,
+## xfce, xorg, xtra
 CATEGORIES = lib
 
-DESCRIPTION = This is a useful library
+## A one-line description of the package, which will appear in the pkginfo.
+DESCRIPTION = <please fill in>
+
+## A longer description of the package. This is only for descriptive purposes
+## inside the Makefile and is not used elsewhere. 
 define BLURB
-  It does stuff with things
+  <please fill in>
 endef
 
+## Whitespace-separated list of URLs to download the source package from.
+## There are presets: $(SF_MIRRORS), $(GNU_MIRRORS) and $(GOOGLE_MIRROR).
 MASTER_SITES = 
+
+## SF_PROJ is required if you set $(MASTER_SITES) to $(SF_MIRRORS) and the
+## Sourceforge project name differs from $(GARNAME). Specifies the Sourceforge
+## project name of the software you wish to download. 
+# SF_PROJ =
+
+# A list of space separated patch filenames from files/ that are to be applied
+# to the extracted software before the ./configure stage. Patches need to be
+# included in the DISTFILES variable as well.
+# PATCHFILES =
+
+## Whitespace-separated list of files which comprise this build. mGAR will look
+## for the files in the $(FILEDIR) (trunk/files) directory and on the
+## $(MASTER_SITES).
 DISTFILES  = $(GARNAME)-$(GARVERSION).tar.gz
 
-# We define upstream file regex so we can be notifed of new upstream software release
+## Set to 1 to mark the package as architecture-independent.
+# ARCHALL = 0
+
+## A list of files / patterns that should be excluded from the package. Amends
+## the default list of excluded filenames $(MERGE_EXCLUDE_DEFAULT), which
+## contains things like libtool .la files and files with a leading ~. 
+# EXTRA_MERGE_EXCLUDE_FILES =
+
+## A list of space separated package names that should be marked as
+## incompatible with the current package. This will go into the depend file.
+## When a user has one of the incompatible packages installed and installs
+## your package, he will be prompted that the incompatible package must be
+## removed. He will however not be prevented to install your package without
+## removing the conflicting package first. 
+# INCOMPATIBLE_PKGS =
+
+# The name of the license file that should be included in your package. Defaults
+# to COPYING. See http://sourceforge.net/apps/trac/gar/wiki/CopyRightfor details
+# on including and displaying licenses. 
+# LICENSE =
+
+## A list of space separated package names that should be produced from your
+## Makefile. This is used when a software has different components that can be
+## packaged and used individually (think runtime libraries, client tools, server
+## files, development headers). You don't need to set this when you just want to
+## produce one package. 
+##
+## When you set this variable to include more than one package, you also need to
+## set PKGFILES_CSWpkgname for each package (except for the first one in your
+## $(PACKAGES) list) to define which files go into each package. The first
+## package from $(PACKAGES) one will hold all files that are not matched by
+## PKGFILES_ for other packages.
+# PACKAGES =
+
+## If specified, GAR feeds the almost-final package prototype file to
+## $(PROTOTYPE_FILTER) and reads the final package prototype file from it.
+## $(PROTOTYPE_FILTER) is usually a sed/awk/perl one-liner, which was mostly used
+## to prepare the prototype file for use with cswclassutils (see
+## $(SPKG_CLASSES)). Now that there are convenience variables for cswclassutils,
+## you will rarely have to use this. A still valid use case would be to change
+## the file permissions of a file to be set-UID. 
+## See http://wiki.opencsw.org/cswclassutils-package for common usage information
+# PROTOTYPE_FILTER =
+
+## A list of runtime package dependencies in the form of CSWfoo.
+# REQUIRED_PKGS =
+
+## When using non-empty $(PACKAGES):
+# REQUIRED_PKGS_CSWpkgname =
+# SPKG_DESC_CSWpkgname =
+# PKGFILES_CSWpkgname =
+
+## Upstream URL that should show up in the VENDOR field as well as on
+## http://opencsw.org/packages/<packagename>.
+# SPKG_SOURCEURL =
+
+## A list of space separated directories where objects should be stripped in
+## addition to the bin/ and sbin/ directories.
+# STRIP_DIRS =
+
+## We define upstream file regex so we can be notifed of new upstream software release
 UFILES_REGEX = $(GARNAME)-(\d+(?:\.\d+)*).tar.gz
 
+## Define a custom target for the configure phase. When you set this, the target
+## that will be used instead of configure: target, is named
+## configure-$(CONFIGURE_SCRIPTS) and you will need to define it in your Makefile
+## after including gar/gar.include.mk. If you want to skip the configure phase
+## completely (for example when your software doesn't need to be compiled) assign
+## this variable an empty value. The procedure works for configure, build,
+## install and test steps.
+# CONFIGURE_SCRIPTS =
+# BUILD_SCRIPTS =
+# INSTALL_SCRIPTS =
+# TEST_SCRIPTS =
+
+## Compilation settings
+
+## The build directory.
+# WORKSRC = $(WORKDIR)/$(GARNAME)-$(GARVERSION)
+
+## BUILD_ARGS is passed as an argument to gmake during the build phase. Use this
+## for example, if you need to override Makefile variables. 
+# BUILD_ARGS =
+
+## Arguments passed to the ./configure script.
 CONFIGURE_ARGS = $(DIRPATHS)
 
+# BUILD64 =
+# CONFIGURE_ENV =
+# EXTRA_CFLAGS =
+# EXTRA_LDFLAGS =
+# EXTRA_INC =
+# EXTRA_LIB =
+# GARFLAVOR =
+# INSTALL_ARGS =
+# OPT_FLAGS_SOS = -xO3
+# OPT_FLAGS_GCC = -O2 -pipe
+
+## The compiler to use. Defaults to SOS11, can be also: SOS12, GCC3, GCC4.
+# GARCOMPILER = SOS11
+
 # Remove the following rules and uncomment the
 # include before building.
 all: .DEFAULT


Property changes on: csw/mgar/pkg/template/trunk/Makefile
___________________________________________________________________
Modified: svn:keywords
   - Id
   + Header


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.