hasufell/ghcup
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Pretty doc sections

Browse Source
This commit is contained in:
Julian Ospald 2018-09-30 14:26:59 +08:00
parent 1f02c66e05
commit 6e1b6e431e
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28
1 changed files with 53 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
ghcup
View File

@ -29,7 +29,11 @@
## global variables ##
##########################
#--[ Global Variables ]--#
##########################
# @VARIABLE: VERSION # @VARIABLE: VERSION
# @DESCRIPTION: # @DESCRIPTION:
@ -87,7 +91,11 @@ SCRIPT_UPDATE_URL="https://raw.githubusercontent.com/hasufell/ghcup/master/ghcup
GHC_DOWNLOAD_BASEURL="https://downloads.haskell.org/~ghc" GHC_DOWNLOAD_BASEURL="https://downloads.haskell.org/~ghc"
## print help ##
####################
#--[ Print Help ]--#
####################
# @FUNCTION: usage # @FUNCTION: usage
# @DESCRIPTION: # @DESCRIPTION:
@ -230,7 +238,11 @@ ARGS:
} }
## utilities ##
###########################
#--[ Utility functions ]--#
###########################
# @FUNCTION: die # @FUNCTION: die
# @USAGE: [msg] # @USAGE: [msg]
@ -481,7 +493,11 @@ download() {
} }
## subcommand install ##
############################
#--[ Subcommand install ]--#
############################
# @FUNCTION: install_ghc # @FUNCTION: install_ghc
# @USAGE: <ghcversion> # @USAGE: <ghcversion>
@ -547,7 +563,11 @@ install_ghc() {
} }
## subcommand set-ghc ##
############################
#--[ Subcommand set-ghc ]--#
############################
# @FUNCTION: set_ghc # @FUNCTION: set_ghc
# @USAGE: <ghcversion> # @USAGE: <ghcversion>
@ -581,7 +601,11 @@ set_ghc() {
} }
## self-update subcommand ##
################################
#--[ Subcommand self-update ]--#
################################
# @FUNCTION: self_update # @FUNCTION: self_update
# @USAGE: <install-location> # @USAGE: <install-location>
@ -607,7 +631,12 @@ self_update() {
unset target_location unset target_location
} }
## show subcommand ##
#########################
#--[ Subcommand show ]--#
#########################
# @FUNCTION: show_ghc # @FUNCTION: show_ghc
# @DESCRIPTION: # @DESCRIPTION:
@ -651,7 +680,12 @@ show_ghc_installed() {
unset real_ghc current_ghc unset real_ghc current_ghc
} }
## rm subcommand ##
#######################
#--[ Subcommand rm ]--#
#######################
# @FUNCTION: rm_ghc # @FUNCTION: rm_ghc
# @USAGE: <ghcversion> # @USAGE: <ghcversion>
@ -685,13 +719,22 @@ rm_ghc() {
## command line parsing and entry point ## #######################
#--[ Sanity checks ]--#
#######################
# sanity checks
if [ -z "$HOME" ] ; then if [ -z "$HOME" ] ; then
die "HOME env not set, cannot operate" die "HOME env not set, cannot operate"
fi fi
##############################################
#--[ Command line parsing and entry point ]--#
##############################################
[ $# -lt 1 ] && usage [ $# -lt 1 ] && usage
while [ $# -gt 0 ] ; do while [ $# -gt 0 ] ; do