1
0
mirror of https://github.com/pyenv/pyenv.git synced 2025-11-14 14:23:53 -05:00

Improve syntax for inline documentation and allow for multi-line usage

This commit is contained in:
Sam Stephenson
2012-12-29 12:06:20 -06:00
parent ef44b4ccac
commit 4c19dc22d7
10 changed files with 170 additions and 97 deletions

View File

@@ -1,4 +1,23 @@
#!/usr/bin/env bash
#
# Summary: Set or show the local directory-specific Ruby version
#
# Usage: rbenv local <version>
# rbenv local --unset
#
# Sets the local directory-specific Ruby version by writing the version
# name to a file named `.rbenv-version'.
#
# When you run a Ruby command, rbenv will look for an `.rbenv-version'
# file in the current directory and each parent directory. If no such
# file is found in the tree, rbenv will use the global Ruby version
# specified with `rbenv global', or the version specified in the
# RBENV_VERSION environment variable.
#
# <version> should be a string matching a Ruby version known to rbenv.
# The special version string `system' will use your default system Ruby.
# Run `rbenv versions' for a list of available Ruby versions.
set -e
[ -n "$RBENV_DEBUG" ] && set -x