Rename Sync instances of "master" to "leader"

[ywwg]

Also add an alias from the sync_master CO to sync_leader.

This PR depends on my stopped-explicit branch so it will appear to have those changes. This PR is a no-op change.

[JoergAtGithub]

Does this break the API for controller mappings?

[ywwg]

it shouldn't, because I have an alias from sync_master to sync_leader. Old scripts should continue to work.

[ywwg]

depends on #3706 which depends on #3899

[Holzhaus]

FYI if you pushed a broken merge, you can still amend it later with git commit --amend. Please make sure that all commit build.

[ywwg]

I'm glad we've moved to squash-commits by default! I prefer it

[daschuer]

Did we? I don't prefere it, because "blame" will become less significant.

[ywwg]

Oh, so it's more like "squash out commits that were objectively broken"

[Holzhaus]

Yes, we don't squash by default. We just want to avoid commits that don't build because it makes bisecting impossible.

[ywwg]

fixed the commit order so it's not completely messed up

[ywwg]

fixed conflicts, ready for review

[Holzhaus]

Some pre commit issues.

[Holzhaus]

Some pre commit issues.

You don't need to fix the eslint issues, but the end-of-file issues would be nice.

[ywwg]

You don't need to fix the eslint issues, but the end-of-file issues would be nice.

yeah using the autoformatter results in a gigantic number of changes

[ywwg]

fixed conflict

[ywwg]

no diff when I run that command:
Fix End of Files.........................................................Passed

[coveralls]

Pull Request Test Coverage Report for Build 1051095745

• 167 of 204 (81.86%) changed or added relevant lines in 8 files are covered.
• 4 unchanged lines in 2 files lost coverage.
• Overall coverage increased (+0.008%) to 28.636%

---

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/engine/controls/ratecontrol.cpp	0	1	0.0%
src/engine/controls/bpmcontrol.cpp	0	2	0.0%
src/engine/sync/internalclock.cpp	23	27	85.19%
src/engine/sync/synccontrol.cpp	45	58	77.59%
src/engine/sync/enginesync.cpp	82	99	82.83%

Files with Coverage Reduction	New Missed Lines	%
src/engine/sync/synccontrol.cpp	1	82.05%
src/engine/sync/internalclock.cpp	3	80.51%

Totals
Change from base Build 1050590600:	0.008%
Covered Lines:	20095
Relevant Lines:	70175

---

💛 - Coveralls

[ywwg]

friendly ping

[Holzhaus]

I was wondering if we should really change all legacy mappings, since these are not pre-commit clean and this will cause pre-commit issues when merging main into other branches locally. It's not necessary because the old name still works due to the alias.

But many people copy&paste code from old mappings and, so term would proliferate. Let's do this once now.

Important: if you're reading this because you experienced the issue I described above, please do this: if you're only contributing a controller mapping, please fetch latest main and rebase. If you're working on a branch unrelated to mappings, commit the merge commit with SKIP=eslint git commit.

[Holzhaus]

Thanks. I grepped the code and found some more sync-related uses of the master term that you missed:

../src/test/synccontroltest.cpp:4:// * Quantize mode nudges tracks in sync, whether internal or deck master.
../src/test/co_dumps/co_dump_inital.csv:100:[Channel1],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:112:[Channel2],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:173:[Channel3],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:190:[Channel4],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:346:[PreviewDeck1],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:9714:[Sampler3],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:9725:[Sampler4],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:9740:[Sampler1],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:9762:[Sampler2],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:9912:[InternalClock],sync_master,0
../src/skin/legacy/tooltips.cpp:553:            << tr("Tap to sync the tempo to other playing tracks or the master clock.")
../src/skin/legacy/tooltips.cpp:567:            << tr("When enabled, this device will serve as the master clock for all other decks.");
../src/engine/sync/syncable.h:144:    // Update the playback speed of the master, including scratch values.
../src/engine/controls/bpmcontrol.cpp:424:    // If we are not quantized, or there are no beats, or we're master,
../src/engine/controls/bpmcontrol.cpp:463:    // Either shortest distance is directly to the master or backwards.
../src/engine/controls/bpmcontrol.cpp:466:    // from master to my percentage. All of the control code below is based on
../src/engine/controls/bpmcontrol.cpp:483:        kLogger.trace() << "master beat distance:" << syncTargetBeatDistance;
../src/controllers/controlpickermenu.cpp:235:               tr("Increase internal master BPM by 1"), syncMenu);
../src/controllers/controlpickermenu.cpp:238:               tr("Decrease internal master BPM by 1"), syncMenu);
../src/controllers/controlpickermenu.cpp:241:               tr("Increase internal master BPM by 0.1"), syncMenu);
../src/controllers/controlpickermenu.cpp:243:               tr("Decrease internal master BPM by 0.1"), syncMenu);
../src/controllers/controlpickermenu.cpp:245:    addDeckAndSamplerControl("sync_leader", tr("Sync Leader"), tr("Toggle sync master"), syncMenu);

[fossdd]

Would like to see that in Mixxx. also due to its negative connotation. See https://lore.kernel.org/git/CAOAHyQwyXC1Z3v7BZAC+Bq6JBaM7FvBenA-1fcqeDV==apdWDg@mail.gmail.com/

[Holzhaus]

Would like to see that in Mixxx. also due to its negative connotation. See https://lore.kernel.org/git/CAOAHyQwyXC1Z3v7BZAC+Bq6JBaM7FvBenA-1fcqeDV==apdWDg@mail.gmail.com/

Yes, we already committed to doing that here: https://mixxx.org/news/2020-06-29-black-lives-matter/

[fossdd]

Ah perfect! didn't see that

[Holzhaus]

Thanks. I grepped the code and found some more sync-related uses of the master term that you missed:

../src/test/synccontroltest.cpp:4:// * Quantize mode nudges tracks in sync, whether internal or deck master.
../src/test/co_dumps/co_dump_inital.csv:100:[Channel1],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:112:[Channel2],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:173:[Channel3],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:190:[Channel4],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:346:[PreviewDeck1],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:9714:[Sampler3],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:9725:[Sampler4],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:9740:[Sampler1],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:9762:[Sampler2],sync_master,0
../src/test/co_dumps/co_dump_inital.csv:9912:[InternalClock],sync_master,0
../src/skin/legacy/tooltips.cpp:553:            << tr("Tap to sync the tempo to other playing tracks or the master clock.")
../src/skin/legacy/tooltips.cpp:567:            << tr("When enabled, this device will serve as the master clock for all other decks.");
../src/engine/sync/syncable.h:144:    // Update the playback speed of the master, including scratch values.
../src/engine/controls/bpmcontrol.cpp:424:    // If we are not quantized, or there are no beats, or we're master,
../src/engine/controls/bpmcontrol.cpp:463:    // Either shortest distance is directly to the master or backwards.
../src/engine/controls/bpmcontrol.cpp:466:    // from master to my percentage. All of the control code below is based on
../src/engine/controls/bpmcontrol.cpp:483:        kLogger.trace() << "master beat distance:" << syncTargetBeatDistance;
../src/controllers/controlpickermenu.cpp:235:               tr("Increase internal master BPM by 1"), syncMenu);
../src/controllers/controlpickermenu.cpp:238:               tr("Decrease internal master BPM by 1"), syncMenu);
../src/controllers/controlpickermenu.cpp:241:               tr("Increase internal master BPM by 0.1"), syncMenu);
../src/controllers/controlpickermenu.cpp:243:               tr("Decrease internal master BPM by 0.1"), syncMenu);
../src/controllers/controlpickermenu.cpp:245:    addDeckAndSamplerControl("sync_leader", tr("Sync Leader"), tr("Toggle sync master"), syncMenu);

@ywwg can you fix those? then we can merge imho.

[ywwg]

ok picking this back up, thanks for finding the other remaining instances!

[ywwg]

Updated based on that list. I removed the addDeckAndSamplerControl for sync_mode, it really should not be mapped (users should map sync_enabled and/or sync_leader.

[Holzhaus]

@ywwg Thanks. Unfortunately, I think you messed up a merge or something. I see a bunch of unrelated changes in the diff. Please fix that.

Also, these is one remaining occurence of the term related to sync - inenginebuffer.cpp, line 1328. Maybe you can correct that while you're at it.

[ywwg]

I skimmed through the diff and couldn't find any unintended changes, could you give me an example?

[ywwg]

merged from main, I think that fixed the problem diffs

[Holzhaus]

Merged in 0fb764a.