bugReproducible paper template - Bugs: bug #58545, modularise software acknowledgments

 
 

You are not allowed to post comments on this tracker with your current authentication level.

bug #58545: modularise software acknowledgments

Submitted by:  Boud Roukema <boud>
Submitted on:  Thu 11 Jun 2020 02:00:23 PM UTC  
 
Category:  Software Severity:  3 - Normal
Item Group:  Enhancement Status:  Fixed
Privacy:  Public Assigned to:  Boud Roukema <boud>
Open/Closed:  Closed

Wed 17 Jun 2020 03:36:32 AM UTC, comment #2: 

Thanks a lot Boud, This was a great suggestion, giving users a very good level of control without having to go into low-level details.

I done some small modifications and merged it into the Maneage branch in Commit 95058143c.

In particular, you will notice that the default values for the variables are now much more simple and readable: instead of defining different variables for various components of a sentence, I just put them in a temporary "str" variable and simply append the rest of the sentence to that variable. This also removes the need for curly-braces which may cause conflicts in different shells (due to the "fuzzy"-ness of POSIX!).

Mohammad Akhlaghi <makhlaghi>
Project Administrator
Thu 11 Jun 2020 02:02:44 PM UTC, comment #1: 

Sorry, I meant this as a task. But it does qualify as a usability
bug: having hardwired "authored" text is a bug.

Boud Roukema <boud>
Project MemberIn charge of this item.
Thu 11 Jun 2020 02:00:23 PM UTC, original submission:  

Here's commit d5d11865dd  to modularise the software acknowledgments section:

https://codeberg.org/boud/maneage_dev/src/branch/modularise_acknowledgments

While the list of software packages can be considered to
be `data`, the text to describe the lists is something the
authors should decide on. Authors of a scientific research
paper take responsibility for the full paper, including for
the style of the acknowledgments, even if these may well
evolve into some standard text.

With this commit, authors who do `not` modify
`reproduce/software/config/acknowledge_software.sh` will have the
default option, with only a minor English correction from earlier
versions of 'maneage; they will all produce papers with identical
copies of the text introducing and summarising the software
acknowledgments.

Authors choosing to use their own wording should be able to
modify the text parameters in
`reproduce/software/config/acknowledge_software.sh` in the
obvious way.

Systematic issues: the file
`reproduce/software/config/acknowledge_software.sh`
is an executable shell script, because it has to be called by
`reproduce/software/shell/configure.sh`, which, in principle,
does not yet have access to `GNU make` (if I understand the
bootstrap sequence correctly). It is placed in `config/` rather
than `shell/`, because the user will expect to find configuration
files in `config/`, not in `shell/`.

A possible alternative to avoid having a shell script as a
configure file would be to let
`reproduce/software/config/acknowledge_software.sh`
appear to be a `make` file, but analyse it in `configure.sh`
using `sed` to remove whitespace around `=`, and adding other
hacks to switch from `make` syntax to `shell` syntax. However,
this risks misleading the user, who will not know whether s/he
should follow `make` conventions or `shell` conventions.

For reasons why writing ${foo}_${bar} in shell is systematically
safer than writing $foo""_$bar, see:
https://stackoverflow.com/questions/8748831/when-do-we-need-curly-braces-around-shell-variables

Boud Roukema <boud>
Project MemberIn charge of this item.

 

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by makhlaghi (Posted a comment)
  • -email is unavailable- added by boud (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

     

     

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-06-17 makhlaghi StatusWorks For Me => Fixed
        Assigned toNone => boud
        Open/ClosedOpen => Closed

    Back to the top


    Powered by Savane 3.6