Update iosxrd caveats

[sdargoeuves]

Linked to issue #1435

[ipspace]

Thank you!

[ipspace]

Just FYI: if you're working from an older commit in the dev branch, it might be better to rebase your branch from dev than to merge dev into it because then we get a clean commit history in the PR. Fortunately, it doesn't matter from the final results perspective, it's just a bit easier to understand.

[sdargoeuves]

As you can see, I'm clearly not used to work with fork! I thought I did the rebase, but I did see all the previous commit... you would have seen my several attempts but I was unsuccessful.
I started with a git pull --rebase --prune from my dev branch, then created my new branch. Then after doing the change, I did the git add and git commit, and finally git push origin my_branch

Should I have done this (suggestion by GPT)?
git checkout my-branch
git fetch origin
git rebase origin/dev
git push --force-with-lease origin my-branch

[ipspace]

I started with a git pull --rebase --prune from my dev branch, then created my new branch. Then after doing the change, I did the git add and git commit, and finally git push origin my_branch

That's OK, but the dev branch has changed in the meantime, so you should do git pull --rebase on the dev branch just before you're ready to submit the PR, the git rebase -i dev (I always use the interactive rebase to see what will happen) in your branch to add your new commits at the end of the dev branch, the git push to push your branch back to GitHub, usually with --force or (safer) --force-with-lease

Julia Evans has tons of very useful info on git and rebasing, including https://wizardzines.com/comics/rules-for-rebasing/ and https://jvns.ca/blog/2023/11/06/rebasing-what-can-go-wrong-/ (plus tons of other things on her blog)

[sdargoeuves]

Thanks a lot for this, next one should be better!