From 8c72bf697ea27c5a265877652aceb386e7747533 Mon Sep 17 00:00:00 2001 From: Julian Ospald Date: Sat, 4 Sep 2021 15:07:22 +0200 Subject: [PATCH] Move files into nicer subdirectories --- README.md | 4 ++-- data/build_mk/cross | 9 +++++++++ data/build_mk/default | 8 ++++++++ config.yaml => data/config.yaml | 0 .../metadata/ghcup-0.0.1.json | 0 .../metadata/ghcup-0.0.2.json | 0 .../metadata/ghcup-0.0.2.yaml | 0 .../metadata/ghcup-0.0.3.yaml | 0 .../metadata/ghcup-0.0.4.yaml | 0 .../metadata/ghcup-0.0.5.yaml | 0 .../metadata/ghcup-0.0.6.yaml | 0 .../metadata/ghcup-0.0.7.yaml | 0 CHANGELOG.md => docs/CHANGELOG.md | 0 HACKING.md => docs/HACKING.md | 0 RELEASING.md => docs/RELEASING.md | 2 +- TODO.md => docs/TODO.md | 0 ghcup.cabal | 16 ++++++++-------- .../bootstrap/bootstrap-haskell | 0 .../bootstrap/bootstrap-haskell.ps1 | 0 refreeze.sh => scripts/dev/refreeze.sh | 0 .../shell-completions}/bash | 0 .../shell-completions}/fish | 0 .../shell-completions}/zsh | 0 23 files changed, 28 insertions(+), 11 deletions(-) create mode 100644 data/build_mk/cross create mode 100644 data/build_mk/default rename config.yaml => data/config.yaml (100%) rename ghcup-0.0.1.json => data/metadata/ghcup-0.0.1.json (100%) rename ghcup-0.0.2.json => data/metadata/ghcup-0.0.2.json (100%) rename ghcup-0.0.2.yaml => data/metadata/ghcup-0.0.2.yaml (100%) rename ghcup-0.0.3.yaml => data/metadata/ghcup-0.0.3.yaml (100%) rename ghcup-0.0.4.yaml => data/metadata/ghcup-0.0.4.yaml (100%) rename ghcup-0.0.5.yaml => data/metadata/ghcup-0.0.5.yaml (100%) rename ghcup-0.0.6.yaml => data/metadata/ghcup-0.0.6.yaml (100%) rename ghcup-0.0.7.yaml => data/metadata/ghcup-0.0.7.yaml (100%) rename CHANGELOG.md => docs/CHANGELOG.md (100%) rename HACKING.md => docs/HACKING.md (100%) rename RELEASING.md => docs/RELEASING.md (68%) rename TODO.md => docs/TODO.md (100%) rename bootstrap-haskell => scripts/bootstrap/bootstrap-haskell (100%) rename bootstrap-haskell.ps1 => scripts/bootstrap/bootstrap-haskell.ps1 (100%) rename refreeze.sh => scripts/dev/refreeze.sh (100%) rename {shell-completions => scripts/shell-completions}/bash (100%) rename {shell-completions => scripts/shell-completions}/fish (100%) rename {shell-completions => scripts/shell-completions}/zsh (100%) diff --git a/README.md b/README.md index 97acece..514912e 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ handles your haskell packages and can demand that [a specific version](https://c ### Configuration A configuration file can be put in `~/.ghcup/config.yaml`. The default config file -explaining all possible configurations can be found in this repo: [config.yaml](./config.yaml). +explaining all possible configurations can be found in this repo: [config.yaml](./data/config.yaml). Partial configuration is fine. Command line options always override the config file settings. @@ -102,7 +102,7 @@ For man pages to work you need [man-db](http://man-db.nongnu.org/) as your `man` ### Shell-completion -Shell completions are in `shell-completions`. +Shell completions are in [scripts/shell-completions](./scripts/shell-completions) directory of this repository. For bash: install `shell-completions/bash` as e.g. `/etc/bash_completion.d/ghcup` (depending on distro) diff --git a/data/build_mk/cross b/data/build_mk/cross new file mode 100644 index 0000000..eabf8c3 --- /dev/null +++ b/data/build_mk/cross @@ -0,0 +1,9 @@ +V=0 +BUILD_MAN = NO +BUILD_SPHINX_HTML = NO +BUILD_SPHINX_PDF = NO +HADDOCK_DOCS = NO +ifneq "$(BuildFlavour)" "" +include mk/flavours/$(BuildFlavour).mk +endif +Stage1Only = YES diff --git a/data/build_mk/default b/data/build_mk/default new file mode 100644 index 0000000..b075d05 --- /dev/null +++ b/data/build_mk/default @@ -0,0 +1,8 @@ +V=0 +BUILD_MAN = NO +BUILD_SPHINX_HTML = NO +BUILD_SPHINX_PDF = NO +HADDOCK_DOCS = YES +ifneq "$(BuildFlavour)" "" +include mk/flavours/$(BuildFlavour).mk +endif diff --git a/config.yaml b/data/config.yaml similarity index 100% rename from config.yaml rename to data/config.yaml diff --git a/ghcup-0.0.1.json b/data/metadata/ghcup-0.0.1.json similarity index 100% rename from ghcup-0.0.1.json rename to data/metadata/ghcup-0.0.1.json diff --git a/ghcup-0.0.2.json b/data/metadata/ghcup-0.0.2.json similarity index 100% rename from ghcup-0.0.2.json rename to data/metadata/ghcup-0.0.2.json diff --git a/ghcup-0.0.2.yaml b/data/metadata/ghcup-0.0.2.yaml similarity index 100% rename from ghcup-0.0.2.yaml rename to data/metadata/ghcup-0.0.2.yaml diff --git a/ghcup-0.0.3.yaml b/data/metadata/ghcup-0.0.3.yaml similarity index 100% rename from ghcup-0.0.3.yaml rename to data/metadata/ghcup-0.0.3.yaml diff --git a/ghcup-0.0.4.yaml b/data/metadata/ghcup-0.0.4.yaml similarity index 100% rename from ghcup-0.0.4.yaml rename to data/metadata/ghcup-0.0.4.yaml diff --git a/ghcup-0.0.5.yaml b/data/metadata/ghcup-0.0.5.yaml similarity index 100% rename from ghcup-0.0.5.yaml rename to data/metadata/ghcup-0.0.5.yaml diff --git a/ghcup-0.0.6.yaml b/data/metadata/ghcup-0.0.6.yaml similarity index 100% rename from ghcup-0.0.6.yaml rename to data/metadata/ghcup-0.0.6.yaml diff --git a/ghcup-0.0.7.yaml b/data/metadata/ghcup-0.0.7.yaml similarity index 100% rename from ghcup-0.0.7.yaml rename to data/metadata/ghcup-0.0.7.yaml diff --git a/CHANGELOG.md b/docs/CHANGELOG.md similarity index 100% rename from CHANGELOG.md rename to docs/CHANGELOG.md diff --git a/HACKING.md b/docs/HACKING.md similarity index 100% rename from HACKING.md rename to docs/HACKING.md diff --git a/RELEASING.md b/docs/RELEASING.md similarity index 68% rename from RELEASING.md rename to docs/RELEASING.md index f970f7a..8c50483 100644 --- a/RELEASING.md +++ b/docs/RELEASING.md @@ -6,7 +6,7 @@ 3. Add ChangeLog entry -4. Add/fix downloads in `ghcup-.yaml`, then verify with `ghcup-gen check -f ghcup-.yaml` and possibly (example only) `ghcup-gen check-tarballs -f ghcup-.yaml -u 'ghc-8.10.7'`. Generally, new GHC/cabal/stack/hls versions are only added to the latest yaml file. New GHCup versions are added to all (great care must be taken here to not break the parser... e.g. ARM platforms don't parse in all older formats). +4. Add/fix downloads in `ghcup-.yaml` (under `data/metadata`), then verify with `ghcup-gen check -f ghcup-.yaml` and possibly (example only) `ghcup-gen check-tarballs -f ghcup-.yaml -u 'ghc-8.10.7'`. Generally, new GHC/cabal/stack/hls versions are only added to the latest yaml file. New GHCup versions are added to all (great care must be taken here to not break the parser... e.g. ARM platforms don't parse in all older formats). 5. Commit and git push with tag. Wait for tests to succeed and release artifacts to build. diff --git a/TODO.md b/docs/TODO.md similarity index 100% rename from TODO.md rename to docs/TODO.md diff --git a/ghcup.cabal b/ghcup.cabal index 0933614..96d186a 100644 --- a/ghcup.cabal +++ b/ghcup.cabal @@ -16,15 +16,15 @@ description: category: System build-type: Simple extra-doc-files: - CHANGELOG.md - config.yaml - ghcup-0.0.4.yaml - ghcup-0.0.5.yaml - ghcup-0.0.6.yaml - ghcup-0.0.7.yaml - HACKING.md README.md - RELEASING.md + docs/CHANGELOG.md + docs/HACKING.md + docs/RELEASING.md + data/config.yaml + data/metadata/ghcup-0.0.4.yaml + data/metadata/ghcup-0.0.5.yaml + data/metadata/ghcup-0.0.6.yaml + data/metadata/ghcup-0.0.7.yaml source-repository head type: git diff --git a/bootstrap-haskell b/scripts/bootstrap/bootstrap-haskell similarity index 100% rename from bootstrap-haskell rename to scripts/bootstrap/bootstrap-haskell diff --git a/bootstrap-haskell.ps1 b/scripts/bootstrap/bootstrap-haskell.ps1 similarity index 100% rename from bootstrap-haskell.ps1 rename to scripts/bootstrap/bootstrap-haskell.ps1 diff --git a/refreeze.sh b/scripts/dev/refreeze.sh similarity index 100% rename from refreeze.sh rename to scripts/dev/refreeze.sh diff --git a/shell-completions/bash b/scripts/shell-completions/bash similarity index 100% rename from shell-completions/bash rename to scripts/shell-completions/bash diff --git a/shell-completions/fish b/scripts/shell-completions/fish similarity index 100% rename from shell-completions/fish rename to scripts/shell-completions/fish diff --git a/shell-completions/zsh b/scripts/shell-completions/zsh similarity index 100% rename from shell-completions/zsh rename to scripts/shell-completions/zsh