Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Normalise include statements in core code #11153

Merged
merged 2 commits into from
Dec 11, 2020
Merged

Normalise include statements in core code #11153

merged 2 commits into from
Dec 11, 2020

Conversation

fauxpark
Copy link
Member

@fauxpark fauxpark commented Dec 8, 2020

Description

Per the GCC docs on include syntax, this PR normalises #include statements so that anything in the standard libraries uses <>, as well as anything in our submodules such as hal.h from ChibiOS, and anything in qmk_firmware itself uses "".

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Keyboard (addition or update)
  • Keymap/layout/userspace (addition or update)
  • Documentation

Issues Fixed or Closed by This PR

Checklist

  • My code follows the code style of this project: C, Python
  • I have read the PR Checklist document and have made the appropriate changes.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • I have tested the changes and verified that they work and don't break anything (as well as I can manage).

@fauxpark fauxpark requested a review from a team December 8, 2020 04:46
zvecr
zvecr reviewed Dec 8, 2020
View reviewed changes
Copy link
Member

@zvecr zvecr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tzarc do we want the changes here to the board files? Will they get in the way up upgrade logic or the process round it?

@zvecr zvecr requested review from tzarc and a team December 8, 2020 18:42
tzarc
tzarc approved these changes Dec 10, 2020
View reviewed changes
Copy link
Member

@tzarc tzarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't really be any issues with board files, rest looks fine.

Confirmed almost everything matches with sha1sum -- a few build failures but that's the harness I'm using and I see no indication that they'd be problematic.

@tzarc tzarc requested review from tzarc and a team December 10, 2020 06:03
@zvecr zvecr requested a review from a team December 10, 2020 21:28
tzarc
tzarc approved these changes Dec 11, 2020
View reviewed changes
Copy link
Member

@tzarc tzarc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unsure what nuked my approval. Here it is again.

@tzarc tzarc merged commit 501f2fd into qmk:master Dec 11, 2020
@fauxpark fauxpark deleted the normalise-includes branch December 11, 2020 03:24
@fauxpark fauxpark mentioned this pull request Dec 11, 2020
Merged
14 tasks
ahaurw01 added a commit to ahaurw01/qmk_firmware that referenced this pull request Dec 11, 2020
@ahaurw01
Merge remote-tracking branch 'upstream/master'
1e98fe3 
* upstream/master: (44 commits)
  Fixed french quotes on canadian multilingual (qmk#11183)
  Nightingale Studios Hailey production fixes (qmk#11180)
  CI automated format fixes (qmk#11179)
  Add XD75am as supported in XD75 readme (qmk#11170)
  Normalise include statements in core code (qmk#11153)
  Fix warning logic when running 'qmk format -a' (qmk#11177)
  CI: Add workflow for codebase formatting (qmk#7382)
  add Via keymap for beatervan (qmk#11159)
  add VIA keymap for edc40 (qmk#11160)
  Use progmem.h for claw44 glcdfont (qmk#11164)
  [Keyboard] Valor FRL TKL update - EEPROM change (qmk#11163)
  Fixup config template to match <> instead of "" for includes. (qmk#11166)
  Fix titan60 and h660 error_log complaints (qmk#11124)
  [Keymap] Fix rules.mk for nullbits nibble oled keymap (qmk#11142)
  [Keyboard] Geekboards Macropad V2 keyboard (qmk#11045)
  Fixed taleguers75 info.json (qmk#11121)
  Add missing hardware availability for Plank EZ (qmk#11069)
  [Keyboard] Big Dill Extended by MechWild (qmk#11047)
  add via layout for aek2 usb pcb (qmk#11125)
  [Keyboard] Add nt980 (qmk#11092)
  ...
@fauxpark fauxpark mentioned this pull request Dec 12, 2020
Merged
14 tasks
nicsuzor added a commit to nicsuzor/qmk_firmware that referenced this pull request Dec 16, 2020
@nicsuzor
Merge remote-tracking branch 'upstream/master'
38d6b39 
* upstream/master: (183 commits)
  Normalise include statements in keyboard code (qmk#11185)
  CLI-ify rgblight_breathing_table_calc.c (qmk#11174)
  gh60/satan: fix indicator LED define (qmk#11216)
  [Keymap] Helix default keymap oled update (qmk#11152)
  [Keyboard] rart/rart45 (qmk#11096)
  Selectively enable command and console for yanfali userspace (qmk#11212)
  Another attempt to fix formatting workflow (qmk#11187)
  Add i2c 24LC64 eeprom (qmk#11200)
  Fix incorrect search order for `rgblight_breathe_table.h` that `rgblight.c` includes. (qmk#11192)
  Fixed french quotes on canadian multilingual (qmk#11183)
  Nightingale Studios Hailey production fixes (qmk#11180)
  CI automated format fixes (qmk#11179)
  Add XD75am as supported in XD75 readme (qmk#11170)
  Normalise include statements in core code (qmk#11153)
  Fix warning logic when running 'qmk format -a' (qmk#11177)
  CI: Add workflow for codebase formatting (qmk#7382)
  add Via keymap for beatervan (qmk#11159)
  add VIA keymap for edc40 (qmk#11160)
  Use progmem.h for claw44 glcdfont (qmk#11164)
  [Keyboard] Valor FRL TKL update - EEPROM change (qmk#11163)
  ...
xgnxs pushed a commit to xgnxs/qmk_firmware that referenced this pull request Jan 9, 2021
@fauxpark @xgnxs
Normalise include statements in core code (qmk#11153)
af80a61 
* Normalise include statements in core code

* Missed one
drashna pushed a commit to zsa/qmk_firmware that referenced this pull request Jan 13, 2021
@fauxpark @drashna
Normalise include statements in core code (qmk#11153)
8d5fa95 
* Normalise include statements in core code

* Missed one
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
@fauxpark
Normalise include statements in core code (qmk#11153)
22cfffb 
* Normalise include statements in core code

* Missed one
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tzarc tzarc tzarc approved these changes

@zvecr zvecr zvecr approved these changes

Assignees
No one assigned
Labels
core documentation enhancement translation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@fauxpark @tzarc @zvecr