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

Add more code documentation

Browse Source
This commit is contained in:
Julian Ospald 2018-09-30 13:52:01 +08:00
parent cb601e6df5
commit 49a20bc932
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28
2 changed files with 33 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -50,7 +50,7 @@ See `ghcup --help`.
- [ ] FreeBSD support ([#4](https://github.com/hasufell/ghcup/issues/4)) - [ ] FreeBSD support ([#4](https://github.com/hasufell/ghcup/issues/4))
- [ ] Make fetching tarballs more robust ([#5](https://github.com/hasufell/ghcup/issues/5)) - [ ] Make fetching tarballs more robust ([#5](https://github.com/hasufell/ghcup/issues/5))
- [ ] More code documentation - [x] More code documentation
## Feature considerations ## Feature considerations

32
ghcup
View File

@ -277,6 +277,12 @@ get_arch() {
unset myarch unset myarch
} }
# @FUNCTION: get_download_url
# @USAGE: <ghcversion>
# @DESCRIPTION:
# Gets the right (hopefully) download url for the given ghc version
# and the current distro and architecture (which it tries to discover).
# @STDOUT: ghc download url
get_download_url() { get_download_url() {
myghcver=$1 myghcver=$1
myarch=$(get_arch) myarch=$(get_arch)
@ -362,6 +368,10 @@ download() {
## subcommand install ## ## subcommand install ##
# @FUNCTION: install_ghc
# @USAGE: <ghcversion>
# @DESCRIPTION:
# Installs the given ghc version with a lot of side effects.
install_ghc() { install_ghc() {
myghcver=$1 myghcver=$1
inst_location=$(get_ghc_location "$1") inst_location=$(get_ghc_location "$1")
@ -422,6 +432,10 @@ install_ghc() {
## subcommand set-ghc ## ## subcommand set-ghc ##
# @FUNCTION: set_ghc
# @USAGE: <ghcversion>
# @DESCRIPTION:
# Sets the current ghc version by creating symlinks.
set_ghc() { set_ghc() {
myghcver=$1 myghcver=$1
inst_location=$(get_ghc_location "$1") inst_location=$(get_ghc_location "$1")
@ -450,6 +464,12 @@ set_ghc() {
## self-update subcommand ## ## self-update subcommand ##
# TODO: relative path
# @FUNCTION: self_update
# @USAGE: <install-location>
# @DESCRIPTION:
# Downloads the latest version of this script and places it into
# the given directory.
self_update() { self_update() {
target_location=$1 target_location=$1
@ -472,6 +492,10 @@ self_update() {
## show subcommand ## ## show subcommand ##
# @FUNCTION: show_ghc
# @DESCRIPTION:
# Prints the currently installed and selected GHC, in human-friendly
# format.
show_ghc() { show_ghc() {
current_ghc=$(show_ghc_installed) current_ghc=$(show_ghc_installed)
@ -490,6 +514,10 @@ show_ghc() {
unset current_ghc i unset current_ghc i
} }
# @FUNCTION: show_ghc_installed
# @DESCRIPTION:
# Prints the currently selected GHC only as version string.
# @STDOUT: current GHC version
show_ghc_installed() { show_ghc_installed() {
current_ghc="${BIN_LOCATION}/ghc" current_ghc="${BIN_LOCATION}/ghc"
real_ghc=$(realpath "${current_ghc}" 2>/dev/null) real_ghc=$(realpath "${current_ghc}" 2>/dev/null)
@ -508,6 +536,10 @@ show_ghc_installed() {
## rm subcommand ## ## rm subcommand ##
# @FUNCTION: rm_ghc
# @USAGE: <ghcversion>
# @DESCRIPTION:
# Removes the given GHC version installed by ghcup.
rm_ghc() { rm_ghc() {
myghcver=$1 myghcver=$1
inst_location=$(get_ghc_location "${myghcver}") inst_location=$(get_ghc_location "${myghcver}")