From 9bc446351f9aa01e76cd0cbfe1fe69d3a9b9a5d4 Mon Sep 17 00:00:00 2001 From: Mark Huang Date: Fri, 9 Apr 2004 20:12:22 +0000 Subject: [PATCH] first cut at docs for this package --- README | 51 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 README diff --git a/README b/README new file mode 100644 index 00000000..8f1ce973 --- /dev/null +++ b/README @@ -0,0 +1,51 @@ +Copyright (c) 2003 The Trustees of Princeton University (Trustees). + +$Id$ + +Here are some general guidelines for writing spec files. + +* RPM does not allow you to use dashes in version or release + numbers. Use dots, or nothing. + +* Most versions of RPM poorly handle version and release numbers that + do not begin with a number. Start your version and release number with + at least one number. Append as many minor numbers as you want, but + leave alphabetic characters at the end of the string. + +* Always define BuildRoot based in %{_tmppath}. + +* In the %install step, always install files based in $RPM_BUILD_DIR. + +* Don't be overly restrictive with Requires or BuildRequires tags. RPM + is already pretty smart about analyzing your package for necessary + dependencies. Usually, you only need to specify Requires tags to make + sure a set of packages get installed in the right order (if there is + one). Otherwise, it's likely your users will end up in awful + situations requiring manual bootstrap. + +Here are some specific guidelines for writing spec files for this setup. + +* Explicitly %define %{name}, %{version}, %{release}. You should do this + anyway to support older versions of RPM. This Makefile does not + implicitly define these variables (based on the Name:, Version:, and + Release: tags) as RPM does. + +* Run cvsps(1) manually on your repository, and synchronize the PatchSet + numbers with any Patch: tags in your spec file that you would like + explicitly named. + +* This Makefile assumes that the build directory (as specified by the -n + option to %setup, or the RPM default %{name}-%{version}) is the + basename of the Source file (i.e. without .tar[.gz|.bz2]). + +* Add %{?date:.%{date}} to your %{release} tag. When executed, this + Makefile will define the variable to be the current date in YY.MM.DD + form. This will help automated nightly upgrades. Tagged releases + will not define this variable. + +* Unless you have a very good reason not to, use the following tags: + +Vendor: PlanetLab +Packager: PlanetLab Central +Distribution: PlanetLab 2.0 +URL: http://www.planet-lab.org -- 2.47.0