proposing P.R. from personal repo

Technical questions regarding the XTC tools and programming with XMOS.
User avatar
fabriceo
Respected Member
Posts: 278
Joined: Mon Jan 08, 2018 4:14 pm

proposing P.R. from personal repo

Post by fabriceo »

Hi!

for some reason I wanted to run the standard sw_usb_audio for EVK_316 in CODEC_MASTER=1 instead of 0.
this requires a small change in the i2c init section that can be selected automatically by an #if/#else/#endif and also the BCLK_N (divider) register need to be modified when sample rate is changed.

I was about to raise a GitHub issue to log this request and realised I could propose a PR but not clue (officially) on how to proceed. can you tell us more on this ?

I d imagine:
fork the xmos repo
clone it locally
checkout a certain tag (latest release or develop branch ?)
create a feature branch as of this point
devlop, verify, test (no possibility to run the proposed python test)
update document files
propose PR
that's it ?

thanks
fabriceo
User avatar
Ross
Verified
XCore Legend
Posts: 1307
Joined: Thu Dec 10, 2009 9:20 pm
Location: Bristol, UK

Post by Ross »

Sounds about right Fabrice, also this is the same process we use internally. The main difference is that PRs from externals wont run tests automatically - they need to be approved by an XMOS employee - just to make sure nothing potentially malicious is being run. A lot of repos you can run tests locally, however, the USB Audio regression is rather large and complex.

Generally PR to develop, we're not maintaining any maintenance branches in that repo at the moment.

Writing a document on all this stuff has been on the TODO list for a while!
Technical Director @ XMOS. Opinions expressed are my own