Difference between revisions of "Ruby Gem package guidelines"

From ArchWiki
Jump to: navigation, search
m (Examples)
(21 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{stub}}
+
[[Category:Package development]]
[[Category:Package management (English)]]
+
[[it:Ruby Gem Package Guidelines]]
[[Category:Package development (English)]]
+
{{Package Guidelines}}
[[Category:Guidelines (English)]]
+
[[Category:Development (English)]]
+
  
==Package Naming==
+
Writing [[PKGBUILD]]s for software written in [[Ruby]].
For libraries, use "ruby-gemname". For applications, use the program name
+
  
==Examples==
+
== Package Naming ==
For examples, please see [http://aur.archlinux.org/packages.php?ID=24484 github-gem] [http://aur.archlinux.org/packages.php?ID=24483 ruby-json_pure] [http://aur.archlinux.org/packages.php?ID=17121 ruby-hpricot]
+
For libraries, use {{Ic|ruby-gemname}}. For applications, use the program name. In either case, the name should be entirely lowercase
 +
 
 +
== Examples ==
 +
For examples, please see {{AUR|github-gem}} {{AUR|ruby-json_pure}} {{AUR|ruby-hpricot}}.
 +
 
 +
== Notes ==
 +
Add {{Ic|--verbose}} to '''gem''' arguments to recive additional information in case of troubles.
 +
 
 +
{{Warning|Usage of {{Ic|--no-user-install}} '''gem''' argument is mandatory since latest Ruby versions (See {{Bug|28681}} for details).}}
 +
 
 +
== Example PKGBUILD ==
 +
An example PKGBUILD can be found at {{Ic|/usr/share/pacman/PKGBUILD-rubygem.proto}}, which is in the {{Pkg|abs}} package.
 +
 
 +
== Automation ==
 +
Abhishek Dasgupta wrote [http://github.com/abhidg/gem2arch/ gem2arch] to aid in automating the process of creating a ruby gem PKGBUILD. Make sure to manually check the PKGBUILD after generation. There are multiple versions of this tool in AUR ([https://aur.archlinux.org/packages.php?K=gem2arch Search for gem2arch]).
 +
 
 +
The gem installation can also be automated completely with the tool {{AUR|pacgem}} which creates a temporary PKGBUILD, calls [[makepkg]] and [[namcap]]. The resulting package is then installed with {{Ic|sudo pacman}}.

Revision as of 13:16, 13 June 2012

Template:Package Guidelines

Writing PKGBUILDs for software written in Ruby.

Package Naming

For libraries, use ruby-gemname. For applications, use the program name. In either case, the name should be entirely lowercase

Examples

For examples, please see github-gemAUR ruby-json_pureAUR ruby-hpricotAUR.

Notes

Add --verbose to gem arguments to recive additional information in case of troubles.

Warning: Usage of --no-user-install gem argument is mandatory since latest Ruby versions (See FS#28681 for details).

Example PKGBUILD

An example PKGBUILD can be found at /usr/share/pacman/PKGBUILD-rubygem.proto, which is in the abs package.

Automation

Abhishek Dasgupta wrote gem2arch to aid in automating the process of creating a ruby gem PKGBUILD. Make sure to manually check the PKGBUILD after generation. There are multiple versions of this tool in AUR (Search for gem2arch).

The gem installation can also be automated completely with the tool pacgemAUR which creates a temporary PKGBUILD, calls makepkg and namcap. The resulting package is then installed with sudo pacman.