Skip to content

Clarify install/ sub-directory role, or integrate it into HLS project #2309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sir4ur0n opened this issue Oct 29, 2021 · 1 comment · Fixed by #2324
Closed

Clarify install/ sub-directory role, or integrate it into HLS project #2309

sir4ur0n opened this issue Oct 29, 2021 · 1 comment · Fixed by #2324
Labels
type: enhancement New feature or request

Comments

@sir4ur0n
Copy link
Collaborator

Contributing guidelines explain:

Note: the ./install/ folder is not directly tied to the project so it has dedicated ./install/hie.yaml.[cbl|stack] templates.

But this leads to several questions:

  • Why isn't the install/ folder treated as another package of the root directory HLS project? It would make everything (build, HIE/HLS integration, etc.) simpler, wouldn't it?
  • What is the purpose of this sub-directory? There is no README.md in that directory, and I couldn't find any documentation about it. Based on the description in install/hls-install.cabal I guess it's about installing HLS (for users? for something else?) but this limited information 😅
@jneira jneira added the type: enhancement New feature or request label Oct 29, 2021
@jneira
Copy link
Member

jneira commented Oct 29, 2021

Why isn't the install/ folder treated as another package of the root directory HLS project? It would make everything (build, HIE/HLS integration, etc.) simpler, wouldn't it?

The reason is we want isolate install builds from hls ones. If it would be integrated the normal build could be broken or altered by install specific dependencies (or viceversa), cabal install all would install the package, etc

What is the purpose of this sub-directory? There is no README.md in that directory, and I couldn't find any documentation about it. Based on the description in install/hls-install.cabal I guess it's about installing HLS (for users? for something else?) but this limited information sweat_smile

This directory/subproject is needed for make work the install script in the root directory: https://github.com/haskell/haskell-language-server/blob/master/install.hs
It purpose is install hls for advanced users/maintainers.
But nowadays ghcup has support for build hls from source so i am not sure if it makes sense anymore tbh.

It is somewhat documented in the official docs: https://haskell-language-server.readthedocs.io/en/latest/installation.html#building
But a readme in the subfolder with a short summary and a link to docs would be great for sure, prs welcome!

sir4ur0n pushed a commit to sir4ur0n/haskell-language-server that referenced this issue Nov 2, 2021
sir4ur0n pushed a commit to sir4ur0n/haskell-language-server that referenced this issue Nov 2, 2021
@mergify mergify bot closed this as completed in #2324 Nov 2, 2021
mergify bot pushed a commit that referenced this issue Nov 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants