Inge, As far as I know, 'module spider foo' will print all 'whatis' strings for the latest version it finds, whereas 'spider foo/42' will print this stuff for version 42. I personally totally agree with you that this is usually too much information, but...
I changed the 'whatis' output of EasyBuild once -- and got beaten by other users who relied on certain stuff being there to generate their web pages. Also, 'module keyword' only searches the 'whatis' stuff, thus, if 'whatis' is too brief the 'keyword' command becomes close to useless. I guess what is printed by 'module spider' can be site-customized using Lmod hooks, though I haven't looked into this yet. Adding 'examples' is actually a reasonable suggestion, though it could also be added as a subsection of 'usage'. We need to be careful to not get too fine-grained (some may think that we already are). But if the community thinks we should add a separate easyconfig parameter for it, I'm happy to include it in the PR. Markus On 02/14/17 10:00, Inge Gutheil wrote: > Hi, > perhaps one more suggestion: > Examples: > > Is there a way to make the module command show different parts of this > depending on whether you say > module spider > or module help? > And for > module spider > Is there a chance that > module spider blabla foe examples only shows which versions of blabla > are available whereas > module spider blabla1.2 shows additional information for version 1.2? > Usually it is a too much information if > module spider blabla > not only shows what blabla is and which versions are avaialble but > also the complete description of one of the versions. I even do not > know how the version is chosen. > Inge Gutheil > > On 02/10/17 16:40, Markus Geimer wrote: >> Hi all, > >> Following up on my proposal for extended package documentation >> options sent to the list recently [1], I have a question to the >> community. During the hackathon part of the User Group Meeting, I >> implemented the proposal (cfr. [2]) for `module help`. Now, the >> question came up which of the information should also be included >> in the `whatis` output and how. Would something in key/value >> style, like > >> Description: Bla bla Usage: More bla Homepage: http://foo.org >> Documentation: $EBROOTFOO/some/path Documentation: http://some.url >> Support: [email protected] Contact: Jim Admin Contact: Jane Admin >> Extensions: ext1-0.1, ext2-42.7 > >> work for the community? > >> Looking forward to your feedback. > >> Markus > > >> [1] >> https://www.mail-archive.com/[email protected]/msg03050.html > > > [2] https://github.com/hpcugent/easybuild-framework/pull/2113 > -- Dr. Markus Geimer Juelich Supercomputing Centre Institute for Advanced Simulation Forschungszentrum Juelich GmbH 52425 Juelich, Germany Phone: +49-2461-61-1773 Fax: +49-2461-61-6656 E-mail: [email protected] WWW: http://www.fz-juelich.de/jsc/ ------------------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------------------ Forschungszentrum Juelich GmbH 52425 Juelich Sitz der Gesellschaft: Juelich Eingetragen im Handelsregister des Amtsgerichts Dueren Nr. HR B 3498 Vorsitzender des Aufsichtsrats: MinDir Dr. Karl Eugen Huthmacher Geschaeftsfuehrung: Prof. Dr.-Ing. Wolfgang Marquardt (Vorsitzender), Karsten Beneke (stellv. Vorsitzender), Prof. Dr.-Ing. Harald Bolt, Prof. Dr. Sebastian M. Schmidt ------------------------------------------------------------------------------------------------ ------------------------------------------------------------------------------------------------
