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

Song::processNextBuffer() - add more comments and rename variables #1884

Merged
merged 2 commits into from
Apr 17, 2015

Conversation

M374LX
Copy link
Contributor

@M374LX M374LX commented Mar 19, 2015

Improve the documentation of Song::processNextBuffer() by adding more comments and renaming variables with confusing names

@@ -353,23 +359,26 @@ void Song::processNextBuffer()
m_playPos[m_playMode].setCurrentFrame( currentFrame );
}

f_cnt_t lastFrames = ( f_cnt_t )framesPerTick -
( f_cnt_t )currentFrame;
f_cnt_t framesToPlay =
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

framesToPlay is the old playedFrames, now closer to where it is first used

@tresf
Copy link
Member

tresf commented Mar 19, 2015

This looks great, thank you.

If I can get a second set of eyes (@badosu, @curlymorphic) I'll merge.

@curlymorphic
Copy link
Contributor

The new names and comments do make the code easier to understand. Looks good to me.

@diizy
Copy link
Contributor

diizy commented Mar 19, 2015

The problem I have with all of these refactorings in the core is that they're going to conflict with the work that has already been done towards 2.0 which means lots of extra work resolving all the conflicts...

@tresf
Copy link
Member

tresf commented Mar 19, 2015

The problem I have with all of these refactorings in the core is that they're going to conflict with the work that has already been done towards 2.0 which means lots of extra work resolving all the conflicts...

@diizy duly noted. How do you want to proceed with these? In the case of Song.cpp (commits) we've had a few changes merged just in the past few months. How do you suggest we encourage the cleanup/refactoring in these cases? This seems very similar to your feelings/comments on #1426 #1353.

@diizy
Copy link
Contributor

diizy commented Mar 19, 2015

Good question. I don't really want to stand in the way of necessary and useful fixes, but then this could mean that the work already done on the 2.0 branch might need to be redone almost from scratch... but then again maybe we can just cross that bridge when we come to it.

By the way, feature freeze for 1.2 is long overdue... we really maybe shouldn't be accepting any more non-bugfix commits at this point.

@tresf
Copy link
Member

tresf commented Mar 19, 2015

By the way, feature freeze for 1.2 is long overdue... we really maybe shouldn't be accepting any more non-bugfix commits at this point.

True, but then that would affect master just the same (unless 2.0 becomes master of course).

I think a feature freeze is about due as well, which would mean we branch off our current master into a stable-1.2 branch (right?)

-Tres

@tresf
Copy link
Member

tresf commented Mar 19, 2015

On that topic... I think we need help mergining in (or rejecting, deferring) the PRs that we have out there before we split off to a new branch, no? This way we have a line in the sand and don't cause a bunch of unnecessary rebasing for PRs that are only being held up by peer review.

@M374LX
Copy link
Contributor Author

M374LX commented Mar 27, 2015

The problem I have with all of these refactorings in the core is that they're going to conflict with the work that has already been done towards 2.0 which means lots of extra work resolving all the conflicts...

Why is 2.0 not listed as a milestone, like 1.2 and 1.3?

@tresf
Copy link
Member

tresf commented Mar 27, 2015

Why is 2.0 not listed as a milestone, like 1.2 and 1.3?

I just hasn't been created. We've putting all of the objectives in 1.3 for now. It is an organization task and one that should probably be driven by the team writing 2.0.

But this really depends on when we expect 2.0 to be ready. If Vesa gets enough buy-in, it may replace 1.3 entirely. Vesa would probably be the best to speak about it.

-Tres

@diizy
Copy link
Contributor

diizy commented Mar 28, 2015

Well, I think we'll concentrate on 1.2 for now, and see what our situation is like when 1.2 is released. We can then see if we have enough developers, enough coding resources to start working on 2.0, or should we do 1.3 first.

@tresf
Copy link
Member

tresf commented Mar 28, 2015

I agree, but that leaves PRs like this still undecided.. Help! :)

@tresf
Copy link
Member

tresf commented Apr 17, 2015

The readability in this (namely the comments) make it worth merging in. @diizy I'm sorry for the grief this causes the 2.0 branch.

Meanwhile, perhaps we should consider developing 2.0 along side 1.3 on the same branch and use refactoring or a certain naming convention for distinguishing old versus new objects? That way we're more cognizant of eachothers work and how it impacts eachother... Just a thought.

@tresf
Copy link
Member

tresf commented Apr 17, 2015

@M374LX good work here and thank you.

tresf added a commit that referenced this pull request Apr 17, 2015
Song::processNextBuffer() - add more comments and rename variables
@tresf tresf merged commit a8da58e into LMMS:master Apr 17, 2015
@M374LX M374LX deleted the songcomments branch April 21, 2015 17:01
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.

4 participants