Document incomplete make install target #59
Conversation
The installation of LINKS is still incomplete. Document the issues so that upstream fixes that eventually.
| @@ -57,10 +59,12 @@ To install LINKS in a specified directory: | |||
| ``` | |||
| * *These steps worked on a CentOS 7 system with 128 CPU Intel(R) Xeon(R) CPU E7-8867 v3 @ 2.50GHz | |||
|
|
|||
| The `make install` does NOT install `./bin/LINKS-make` and `./bin/LINKS.pl` files nor `./tools/*.pl` files. It is just incomplete. Run LINKS from the compiled source tree directory until that is fixed. | |||
There was a problem hiding this comment.
The files in bin folder are implemented in shell or Perl language that's why they doesn't need to be compiled by autotools. Can you describe what error did this caused to you?
There was a problem hiding this comment.
Hi, well simply the make install procedure should install all necessary files, not just some. Then, I should be able to just include the $prefix/bin folder into my PATH and eventually $prefix/lib into LD_LIBRARY_PATH and be done with that. Just include the perl files in the install target and get them installed into prefix/bin as well.
I have no idea if from the btlib only the header files are need or also some library, I did not bother to study that.
There was a problem hiding this comment.
Hi Martin, thanks for pointing this out. Support for install will be developed soon. Currently, we suggest users add bin folder to their PATH.
| @@ -32,9 +32,11 @@ It is also used to scaffold contig pairs linked by ARCS/ARKS. | |||
|
|
|||
| ### Compilation: | |||
| ------------------------------- | |||
| If cloning directly from the repository run: | |||
| If compiling directly from within the repository you need also bundled copy of ./btllib so that `"btllib/bloom_filter.hpp"` can be found during compilation: | |||
There was a problem hiding this comment.
Yes you are right LINKS depends on btllib repository, but not only for "btllib/bloom_filter.hpp" but for few more scripts. I believe they shouldn't be indicated in README for the sake of readability.
There was a problem hiding this comment.
Please instruct user to fetch btlib from some URL, unpack it, install it, and just depend on it and test for it in the configure script. Every sysadmin is used to that, it is clean and the only way to go. It is much more work to unbundle the bundled copies of some libs, sometimes they are even modified variants of their original, which is a nightmare.
No, definitely it should be documented in the README. Why should I even study what the thing requires for its runtime? The make install left me with a broken, partial installation and there is not a single explanation what's up. after poking around one only realizes one is supposed to run the code from the unpacked tree and the unfinished make install target is just confusing. Thank you.
There was a problem hiding this comment.
Nobody acted upon the issue #31 hence my pull request.
This package is supposed to be executed from within compiled source tree. See comments in the ebuild what needs to be fixed. bcgsc/LINKS#59 bcgsc/LINKS#31 Package-Manager: Portage-3.0.28, Repoman-3.0.3 Signed-off-by: Martin Mokrejs <mmokrejs@gmail.com>
The installation of LINKS is still incomplete. Document the issues so that upstream fixes that eventually.