Commit 87ed96dc authored by Mislav Marohnić's avatar Mislav Marohnić
Browse files

Merge pull request #879 from jasonkarns/usage 

Clean up usage documentation
parents 0cd6f9fb 29a987c9

bin/rbenv-install

+7 −4
Original line number Diff line number Diff line
@@ -2,9 +2,10 @@ 
#

# Summary: Install a Ruby version using ruby-build

#

# Usage: rbenv install [-f] [-kvp] <version>

#        rbenv install [-f] [-kvp] <definition-file>

# Usage: rbenv install [-f|-s] [-kpv] <version>

#        rbenv install [-f|-s] [-kpv] <definition-file>

#        rbenv install -l|--list

#        rbenv install --version

#

#   -l/--list          List all available versions

#   -f/--force         Install even if the version appears to be installed already
@@ -14,8 +15,9 @@ 
#

#   -k/--keep          Keep source tree in $RBENV_BUILD_ROOT after installation

#                      (defaults to $RBENV_ROOT/sources)

#   -v/--verbose       Verbose mode: print compilation status to stdout

#   -p/--patch         Apply a patch from stdin before building

#   -v/--verbose       Verbose mode: print compilation status to stdout

#   --version          Show version of ruby-build

#

# For detailed information on installing Ruby versions with

# ruby-build, including a list of environment variables for adjusting
@@ -43,8 +45,9 @@ if [ "$1" = "--complete" ]; then 
  echo --force

  echo --skip-existing

  echo --keep

  echo --verbose

  echo --patch

  echo --verbose

  echo --version

  exec ruby-build --definitions

fi

bin/ruby-build

+4 −2
Original line number Diff line number Diff line 
#!/usr/bin/env bash

#

# Usage: ruby-build [-kvp] <definition> <prefix>

# Usage: ruby-build [-kpv] <definition> <prefix>

#        ruby-build --definitions

#        ruby-build --version

#

#   -k/--keep        Do not remove source tree after installation

#   -v/--verbose     Verbose mode: print compilation status to stdout

#   -p/--patch       Apply a patch from stdin before building

#   -v/--verbose     Verbose mode: print compilation status to stdout

#   -4/--ipv4        Resolve names to IPv4 addresses only

#   -6/--ipv6        Resolve names to IPv6 addresses only

#   --definitions    List all built-in definitions

#   --version        Show version of ruby-build

#



RUBY_BUILD_VERSION="20160111"

test/rbenv.bats

+2 −1
Original line number Diff line number Diff line
@@ -145,8 +145,9 @@ OUT 
--force

--skip-existing

--keep

--verbose

--patch

--verbose

--version



${RBENV_ROOT}/plugins/bar/share/ruby-build

${RBENV_ROOT}/plugins/foo/share/ruby-build