Skip to content
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

Add support for 'whatis' easyconfig parameter #1271

Merged
merged 10 commits into from
Nov 27, 2015

Conversation

geimer
Copy link
Contributor

@geimer geimer commented Apr 29, 2015

Currently, the module whatis output includes the full package description. This PR adds support for a new (optional) easyconfig parameter whatis. If given, the value will be used when generating the modulefile; otherwise it will fall back to using the value of description for backwards compatibility.

@hpcugentbot
Copy link
Contributor

Automatic reply from Jenkins: Can I test this?

@boegel
Copy link
Member

boegel commented Apr 29, 2015

Jenkins: ok to test

@hpcugentbot
Copy link
Contributor

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1681/
Test FAILed.

@hpcugentbot
Copy link
Contributor

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1682/
Test PASSed.

@boegel boegel added this to the v2.2 milestone Jun 24, 2015
@geimer
Copy link
Contributor Author

geimer commented Jun 24, 2015

While looking at this again, I noticed that the lua version includes the name and version twice: once as a prefix to the output and once as the output itself. Does it make sense to rectify this? Maybe we should also get @pforai on board?

@hpcugentbot
Copy link
Contributor

Refer to this link for build results (access rights to CI server needed):
https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1793/
EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/1793/console for more details).

This pull request is now ready for review/testing.

Please try and find someone who can tackle this; contact @boegel if you're not sure what to do.

@geimer
Copy link
Contributor Author

geimer commented Jul 8, 2015

Here is an example to clarify what I meant by my last comment:

$ module whatis GCC/4.9.2
GCC/4.9.2           : Name: GCC
GCC/4.9.2           : Version: 4.9.2
GCC/4.9.2           : Description: The GNU Compiler Collection includes front ends for C, C++, Objective-C, Fortran, Java, and Ada,
 as well as libraries for these languages (libstdc++, libgcj,...). - Homepage: http://gcc.gnu.org/
GCC/4.9.2           : Homepage: http://gcc.gnu.org/

$ module whatis GCC/4.8.2
GCC/4.8.2           : Description: The GNU Compiler Collection includes front ends for C, C++, Objective-C, Fortran, Java, and Ada,  as well as libraries for these languages (libstdc++, libgcj,...). - Homepage: http://gcc.gnu.org/

The GCC/4.9.2 module is in Lua format, GCC/4.8.2 is Tcl.

@boegel
Copy link
Member

boegel commented Jul 14, 2015

@geimer: let's follow this up in August, tagging this for EB v2.3

@boegel boegel modified the milestones: v2.3, v2.2 Jul 14, 2015
@geimer
Copy link
Contributor Author

geimer commented Oct 27, 2015

@boegel: Do you think we can finalize this in time for EB v2.4.0?

@boegel
Copy link
Member

boegel commented Oct 27, 2015

@geimer: doesn't look like a lot of work, but I don't want to rush it in either, especially since it's likely we'll be doing some work on the module generator part at the hackathon in Austin, cfr. #1358

Also, I would really like to try and get #1306 ready to merge (needs code cleanup & unit tests), and to get #1388 merged as well. I'm not sure how I'll ever pull that off, so I'm not keen on adding other stuff on top of it. ;-)

How about we revisit this together with what needs to be done for #1358?

@geimer
Copy link
Contributor Author

geimer commented Oct 27, 2015

@boegel: I just wanted to get it off the list ;-) But your proposal makes sense. I was planning to look into improving the documentation abilities anyway (the stuff we discussed during the f2f meeting in Ghent) and there seems to be a significant overlap with #1358.

@hpcugentbot
Copy link
Contributor

EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/2241/console for more details).

This pull request is now ready for review/testing.

Please try and find someone who can tackle this; contact @boegel if you're not sure what to do.

@boegel boegel modified the milestones: v2.5.0, v2.4.0 Oct 28, 2015
@boegel
Copy link
Member

boegel commented Oct 28, 2015

@geimer: moved to milestone 2.5.0 (which should be there by the end of 2015), let's try and work on this during the hackathon in Austin

@hpcugentbot
Copy link
Contributor

EasyBuild framework unit test suite FAILed.

See https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/2332/console for more details.

Please fix the reported issues by pushing additional commits to the branch corresponding with this pull request; contact @boegel if you're not sure what to do.

@hpcugentbot
Copy link
Contributor

EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/2334/console for more details).

This pull request is now ready for review/testing.

Please try and find someone who can tackle this; contact @boegel if you're not sure what to do.

@geimer
Copy link
Contributor Author

geimer commented Nov 13, 2015

The latest version of this PR removes the inconsistency between Lua and Tcl modules mentioned above. This also addresses the desire of TACC to be able to specify, for example, the version explicitly (see #1358) , which may conflict with the automatically generated string.

@boegel boegel mentioned this pull request Nov 21, 2015
@boegel
Copy link
Member

boegel commented Nov 26, 2015

@geimer: please take a look at geimer#4

use None as default value for whatis + minor style fixes
@hpcugentbot
Copy link
Contributor

EasyBuild framework unit test suite PASSed (see https://jenkins1.ugent.be/job/easybuild-framework-pr-builder/2382/console for more details).

This pull request is now ready for review/testing.

Please try and find someone who can tackle this; contact @boegel if you're not sure what to do.

@boegel
Copy link
Member

boegel commented Nov 27, 2015

Going in (finally), thanks for your efforts on this @geimer!

boegel added a commit that referenced this pull request Nov 27, 2015
Add support for 'whatis' easyconfig parameter
@boegel boegel merged commit 6179717 into easybuilders:develop Nov 27, 2015
@geimer geimer deleted the module_whatis branch November 27, 2015 10:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants