board cpu and core: header file include guards repaired

[rajma996]

pull request created as per the issue #2623
changes made in board directory and some files in cpu directory

[jnohlgard]

something went wrong here.
s/CHRONOS_BOARD__/CHRONOS_BOARD_H/

[rajma996]

Thanks for pointing, it's resolved now.

[jnohlgard]

I am not sure of the implications of the changes to the CMSIS headers (cpu/cortexm_common/include/core_*.h), and __CMSIS_GENERIC is not a traditional include guard and should be left as-is.
Changing the CMSIS headers increases maintenance when upgrading CMSIS releases as well so I propose to just leave them as they are right now.

The SAMxxx headers are missing a trailing _H to match the pattern of all other include guards in the tree.

[Kijewski]

rm core/include/cscope.out

[BytesGalore]

I'm with @gebart, since the CMSIS headers define an open standard they are subject of changes and probably will change in the future.
So we should keep them untouched for seamless upgrade and maintenance.

[BytesGalore]

could you change also the #endif in L122 to #endif /* PIPE__H */?

[BytesGalore]

@rajma996 beside the discussion on the CMSIS headers and my request for adding a comment your changes looks good 👍
Since you started to adjust the headers in sys/ I propose to make a separate PR for them and go for merging this PR soon.
So I would say please address our requests and squash your commits.

[rajma996]

@BytesGalore Thanks for the feedback. CMSIS headers are restored. As I will be making a separate PR for /sys headers, changes in the sys/include/pipe.h will be done there :)

[BytesGalore]

@rajma996 I would say, please squash the 15 commits of this RP into a single one :)
And then lets see what travis says.

[BytesGalore]

@rajma996 please rebase and squash the commits :)

[rajma996]

@BytesGalore sorry for being late, I tried some wierd method to sync with the main repo... I've reverted back to the last header updating commit. should I squash from the commit I first started editing headers.

[BytesGalore]

@rajma996 don't know if you strictly separated your changes in the individual commits, but it would be nice if you could squash to 3 commits like:

• boards: repaired header guards
• cpu: repaired header guards
• core: repaired header guards

If this is not possible, no problem :) then just squash all your changes to one commit and rename it accordingly, e.g. boards/cpu/core: repaired header guards.
You also need to rebase this PR to the current master, if you have troubles with it just ask :)

[rajma996]

@BytesGalore thanks for the reply. I reverted all the commits I used for syncing with the main repo previously and squashed everything from the beginning of this forked repo. Let me try rebasing with the current master. I will keep you updated. Again thanks :D

[rajma996]

@BytesGalore though changes in the commit looks fine, but Travis checks have failed....:(

[BytesGalore]

I guess this one slipped through :)
(That's what travis complains)

[BytesGalore]

oh and please reword the commit message to something like:
board cpu core: header file include guards repaired

[BytesGalore]

cool 👍 then lets kick travis

[BytesGalore]

I guess this guy needs to remain with underscores

[rajma996]

@BytesGalore build wasn't successful this time, but i am not able to understand the error.... looks like it couldn't connect for updates.

[BytesGalore]

@rajma996 seems unrelated I kicked travis to repeat the failed build

[rajma996]

@BytesGalore build is successful. :D

[BytesGalore]

nice one, ACK from my side 👍
Since this PR touches so much files, also in core, I would like to have another ACK before we merge it.
@gebart, @PeterKietzmann would you take a look?

[rajma996]

@BytesGalore Based on previous requests on PR 4616 I should've made separate commit for each directory instead of squashing all into one. Let me work on that now...

[miri64]

Please rebase.

[miri64]

Still needs rebase.

[rajma996]

@BytesGalore I am a bit stuck here, I tried rebasing but wasn't successful :( Can you help...

[BytesGalore]

@rajma996 ok I see your changes are now made on your master branch, which is not what you want.
It seems you additionally merged commits/changes from RIOT master to your commits.
But don't worry we can manage it :)

The goal is to keep the changes on the 109 headers but throw all other changes to get in sync with the original RIOT master again.
So we first clone your RIOT, checkout the master branch and switch to the RIOT directory to start.
(Just to prevent uncontrolled heat/sweating, backup the folder before starting.)

1. We remember the filenames of the 109 headers you edited:
   git diff --name-only b986ac33e81f89acf07a6ca814b7cd7cdffb109a >> ../keep_em_all.txt
   This will create a file keep_em_all.txt in the above directory containing the relative paths + filenames of the 109 headers.
2. we go back 2 commits, since your commit seems to be merged on top of the former one:
   git reset HEAD~2
   If you type git show it should list the changes for your 109 edited header files plus a large bunch of other changed files + untracked ones.
   If you type git log you should see commit b986ac33e81f89acf07a6ca814b7cd7cdffb109a on top, which is the first one in sync with RIOT.
3. we open a new branch to move our changes and clean-up main:
   git checkout -b repaired_header_guards
4. now we add only the 109 headers we kept in keep_em_all.txt to commit them:
   for word in $(cat ../keep_em_all.txt); do git add $word; done
   If you type git status you should see (when you scroll some pages up) the 109 header files added for being committed.
5. Then lets commit them:
   git commit -m "core/board/cpu: repaired header guards"
   If you type git status again, only the other changed/untracked files will be listed.
6. Now we want to get rid of them, so we checkout their original versions:
   for word in $(git diff --name-only b986ac33e81f89acf07a6ca814b7cd7cdffb109a); do git checkout $word; done
   This time we didn't needed to remember their filenames, so we processed them directly.
   If you type git status you should see only as untracked marked files.
7. Now we switch to master to clean it up completely:
   git checkout master
   and then stash the untracked marked files:
   git stash
   stashes the files and finally allows us to sync your master with the original RIOT master
   (basically you can delete the stash afterwards since the changes are introduced back after rebase)
8. Now we rebase your master:
   git pull --rebase https://github.com/RIOT-OS/RIOT.git
9. After that you can rebase your branch repaired_header_guards:
   git checkout repaired_header_guards
git rebase master
   fixing appearing conflicts... ... ...
10. and finally pushing it to your repo:
    git push -u origin repaired_header_guards
    and
    git push -f for your master branch.
    Note: the -f forces to overwrite your remote repo stuff with the local changes, so be sure everything works as expected since there's no way back, once overwritten things are gone.

Since you have then a new branch we need to find out how to "connect" it to this PR, or we just open a new PR and close this one.

Sorry for the wall of text, I hope this helps a bit :)

[kYc0o]

Can you rebase please? This will be reviewed for the next release.

[rajma996]

@kYc0o sorry for the delay.

[miri64]

This file was removed in master, so please don't re-include it.

[miri64]

Postponed due to feature freeze

[A-Paul]

@rajma996, ping :-)

[OlegHahm]

superseded by #6407.