bugManeage - Bugs: bug #58716, Fix for a typo in...

 
 

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

bug #58716: Fix for a typo in reproduce/software/make/python.mk

Submitter:  None
Submitted:  Mon 06 Jul 2020 10:42:29 PM UTC
   
 
Category:  Software Severity:  2 - Minor
Item Group:  Crash Status:  Fixed
Privacy:  Public Assigned to:  None
Open/Closed:  Closed

Tue 07 Jul 2020 09:57:54 PM UTC, comment #4: 

Thanks a lot Marius, it has been merged into the core Maneage branch as Commit c85272705b.

I just made some small modifications to the first part of the commit message to be more clear and follow our general standards. We should document them in the 'README-hacking.md' file, I just haven't had time (so its my fault)! But after reading this post, if you run 'git log' and look through some of the latest commits, they should become more natural for you ;-).

The basic idea is that each commit message will be read by people who want to update their projects by merging into Maneage, so the commit message should give good context. The other conventions are similar to many other projects.

  • The first line of the commit message should not end with a '.'. This is a very common convention, in many Git-based projects and is based on the idea that the first line is the commit's title and title don't have '.' in any editorial standard. Essentially doing a 'git log --oneline' is like looking at the contents of a book and having a '.' at the end of each line is annoying to the eye ;-). It also takes valuable space (next point).


  • Genenrally, no line in the commit message should be larger than 75 characters (including the title). This helps reading the message in almost any terminal or terminal emulator: by historical convention, hardly any terminal is smaller than 80 characters, and git indents the commit message by a few characters when you run 'git log'. But of course, your commit message was good in this regard, I am just mentioning it for completenes ;-).


  • To help the readers of the commit messages, the first few words of the first paragraph of the commit message are "Until now ..." or "Until this commit ...". It is followed by a description of the situation until this commit (which can go on for multiple paragraphs). Following this convention also encourages the writer to not immediately go into the solution, but describe the problem first ;-). Later, after the context of the problem is described, we start a new paragraph that starts with "With this commit ..." and explain how we solved the problem.


But generally, don't worry about these too much, I will go over all commit messages before merging and will edit them where necessary to conform with the convention. The important thing is the code :-).

By the way, in case you would like to stay up to date with the bugs found/fixed and proposed tasks and join the discussions, you can subscribe to the reproduce-devel mailing list ;-).

Mohammad Akhlaghi <makhlaghi>
Group administrator
Tue 07 Jul 2020 09:28:45 PM UTC, comment #3: 

hi all,

following your advise I created a public repository and commited the fix there. The link is https://codeberg.org/mpeper/maneage_dev/src/branch/bugfixes.

Best,
Marius

Marius Peper <mpeper>
Mon 06 Jul 2020 10:57:17 PM UTC, comment #2: 

Hi Marius, nice catch ;-)!

Thanks for reporting the bug and proposing the solution.

I just moved the original sr #110259 to the bug list (this is a bug after all!). You can post here if you register on Savannah (you don't need to be a member of this project, just registration on Savannah is enough). But if you don't want to register (its perfectly fine ;-)), just post on the original sr #110259.

Since you found the bug and already know the fix, we can take any of these paths: 1) you can commit the fix on a feature-branch in any public repository, and I will merge it into the core Maneage branch. In this way, your contribution will always be recorded/recognized in Maneage's history. 2) Alternatively I can apply this change and either commit in your name and email address, or 3) just acknowledge your help in the commit message.

Which ever you prefer ;-)...

I personally prefer the first. Because as you use Maneage more, I am sure you will hopefully find more bugs. And even better, you will make improvement which you would like to share with everyone, so this can be a good starter ;-).

Mohammad Akhlaghi <makhlaghi>
Group administrator
Mon 06 Jul 2020 10:42:29 PM UTC, comment #1: 

This item has been reassigned from the project Reproducible paper template support tracker to your tracker.

The original report is still available at support #110259

Following are the information included in the original report:

[field #0]                  Item ID: 110259

[field #1]                 Group ID: 11920

[field #2]              Open/Closed: Open

[field #3]                 Severity: 2 - Minor

[field #4]                  Privacy: Public

[field #7]                         : Unknown support Field Display Type

[field #8]                         : Unknown support Field Display Type

[field #9]                 Category: None

[field #10]             Submitted by: None

[field #11]              Assigned to: None

[field #12]             Submitted on: Mon 06 Jul 2020 11:26:26 PM BST

[field #13]                  Summary: Fix for a typo in reproduce/software/make/python.mk

[field #14]      Original Submission: Hi all,

I think there is a minor typo in reproduce/software/make/python.mk line 334 in commit 0e4d4b3. The line is
$(ipydir)/healpy-$(healpy-version): $(ibidir)/healpix-$(healpy-version)
but should be
$(ipydir)/healpy-$(healpy-version): $(ibidir)/healpix-$(healpix-version).
With the typo I got an error:
make: * No rule to make target '/scratch/mpeper/thesis-peper/lensing-dir/build-dir/software/installed/version-info/proglib/healpix-', needed by '/scratch/mpeper/thesis-peper/lensing-dir/build-dir/software/installed/version-info/python/healpy-'.
make: Target 'all' not remade because of errors.

Best,
Marius

[field #16]               Item Group: None

[field #17]                   Status: None

[field #18]        Component Version: None

[field #19]         Operating System: GNU/Linux

[field #20]          Reproducibility: None

[field #21]               Size (loc): None

[field #22]            Fixed Release: None

[field #23]          Planned Release: None

[field #24]                   Effort: 0.00

[field #28]                 Priority: 5 - Normal

[field #31]         Percent Complete: 0%

[field #33]                  Release: None

[field #36]         Originator Email: marius.peper@astro.uni.torun.pl

[field #58]     Custom Select Box #1: None

[field #59]     Custom Select Box #2: None

[field #60]     Custom Select Box #3: None

[field #61]     Custom Select Box #4: None

[field #62]     Custom Select Box #5: None

[field #63]     Custom Select Box #6: None

[field #64]     Custom Select Box #7: None

[field #65]     Custom Select Box #8: None

[field #66]     Custom Select Box #9: None

[field #67]    Custom Select Box #10: None


Mohammad Akhlaghi <makhlaghi>
Group administrator
Mon 06 Jul 2020 10:42:29 PM UTC, original submission:  

Hi all,

I think there is a minor typo in reproduce/software/make/python.mk line 334 in commit 0e4d4b3. The line is
$(ipydir)/healpy-$(healpy-version): $(ibidir)/healpix-$(healpy-version)
but should be
$(ipydir)/healpy-$(healpy-version): $(ibidir)/healpix-$(healpix-version).
With the typo I got an error:
make: * No rule to make target '/scratch/mpeper/thesis-peper/lensing-dir/build-dir/software/installed/version-info/proglib/healpix-', needed by '/scratch/mpeper/thesis-peper/lensing-dir/build-dir/software/installed/version-info/python/healpy-'.
make: Target 'all' not remade because of errors.

Best,
Marius

Anonymous

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

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 mpeper (Posted a comment)
  • -email is unavailable- added by makhlaghi (Posted a comment)
  • -email is unavailable- added by None (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

    Follow 6 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2020-07-07 makhlaghi StatusIn Progress Fixed
        Open/ClosedOpen Closed
    2020-07-06 makhlaghi CategoryNone Software
        Item GroupNone Crash
        StatusNone In Progress
    2020-07-06 makhlaghi Reassign itemReproducible paper template, sr #110259 Reproducible paper template, bug #58716

    Back to the top

    Powered by Savane 3.13-caa5.
    Corresponding source code