Browse files

Update docs for new variables

  • Loading branch information...
1 parent bc5984a commit bff2bfc04222bef8deae4e1937338eb775d91277 @jaredmorrow jaredmorrow committed Dec 16, 2011
Showing with 6 additions and 1 deletion.
  1. +6 −1 README.org
View
7 README.org
@@ -5,7 +5,8 @@ node_package is a set of RPM/Debian/Solaris templates and scripts, suitable for
The following variables describe a package
*** Required Variables
* `package_name` - The name of the package
- * `package_install_name` - The name of the binary installed
+ * `package_shortdesc` - A short (< one line) description of the package
+ * `package_install_name` - The name of the binary installed (can be different than the `package_name`)
* `package_install_user` - The user to create and run the daemon from
* `package_install_group` - The group to create and add the above user to
* `copyright` - The copyright holder (ex: 2011 Basho Technologies, Inc)
@@ -14,6 +15,10 @@ The following variables describe a package
* `vendor_url` - The website of the person or company who is releasing this package
* `vendor_contact_name` - The name of the maintainer (ex: Basho Packaging)
* `vendor_contact_email` - The email address of the maintainer (ex: riak@basho.com)
+ * `solaris_pkgname` - Package names for Solaris follow a naming convention of MAINTapp (ex: BASHOriak)
*** Optional Variables
* `license_full_text` - If the full text of a license needs to be included, use this variable
* `deb_depends` - Dependencies you require on deb sytems. This should be a comma separated list.
+ * `package_desc` - A long description of the package
+ * `solaris_depends` - (not supported yet) Dependencies specific to the solaris package
+

0 comments on commit bff2bfc

Please sign in to comment.