Hi!
On Mon, 2019-05-13 at 11:12 -0700, Adam Mierzwiak wrote:
> I prepared new description for board that was not included in
> sources.
> It is NUCLEO F767ZI.
Great!
> Should I commit my files to project.
It would be great if you could do that. Contributions are highly
appreciated!
> If yes how should I do this? Should I push commit on my custom branch
> or...
The typical GitHub workflow is more or less like this:
1. Fork the original repo to your own GitHub profile.
2. Clone your forked repo to your PC.
3. Create a topic branch in your repo. This is optional, you may as
well use your master branch, it doesn't matter that much.
4. Commit whatever you have into your branch.
5. Push your branch to your repository.
6. On GitHub page of your repo, when you select this new branch, there
will be a button to create a pull request to the original repository.
Click it, fill whatever is needed (a title is obligatory, but I think
GitHub fills it automatically with the first line of commit message if
there is only one) and press OK (or sth like that).
You can probably find some descriptions of the process in GitHub's help
pages. For example start here:
https://help.github.com/en/articles/creating-a-pull-request
GitHub's help is very extensive, but I'm not sure you'll find one
article which covers the whole process - they rather have many articles
about very specific topics which sometimes overlap a bit. If needed,
you'll probably be able to find some other guides on other websites.
If in doubt - ask. You can also play around with that by doing an
experiment in your own repositories - create one, fork it, add some
commits, try to make a pull request. After you're done, you can just
delete everything (;
As for my own requirements, here is one for a start. It would be very
nice if your contribution included a distortosConfiguration.cmake file,
configured for the board, which you tested with distortosTest
application. This configuration should have similar settings to other
boards:
- max clock of the chip and proper configuration of other bus clocks
- enabled signals, values for main thread as in other configurations
(enabled/8/8)
- huge stack for main() (8192 bytes?)
- enabled thread detachment
- enabled all run-time checks and assertions
- (probably something else too [; just compare with other
configurations)
distortos creates and manages a configuration like this in your build
folder - once you configure it, CMake generates
distortosConfiguration.cmake there. When you modify the configuration
with cmake-gui, this file gets updated too. So just configure what's
required, run the test to make sure it works (it takes about ~10-15
seconds, after the test is finished the LEDs start to blink with 1 Hz
frequency). If everything is OK just copy this
distortosConfiguration.cmake file to a new folder under
configurations/<board>/test/ and commit that too!
Thanks in advance!
Regards,
FCh