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.

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

Fix incorrect search order for rgblight_breathe_table.h that rgblight.c includes. #11192

Merged
merged 1 commit into from
Dec 12, 2020

Conversation

mtei
Copy link
Contributor

@mtei mtei commented Dec 12, 2020

Description

When rgblight.c includes rgblight_breathe_table.h, the search order should be as follows.

  • keyboards/KEYBOARD/keymaps/USER/rgblight_breathe_table.h
  • users/USER/rgblight_breathe_table.h
  • quantum/rgblight_breathe_table.h

However, the current implementation was wrong, so I fixed it.

Scope of impact of this PR change

Currently, there are only two custom rgblight_breathe_table.h

  • users/drashna/rgblight_breathe_table.h
  • users/curry/rgblight_breathe_table.h

At first glance, curry does not seem to be alive at present. The following command will result in an error regardless of this PR.

make all:curry

Therefore, only users/drashna is affected by this PR. (Tag @drashna)

This PR will be merged into master, since the affected area is clear.

Types of Changes

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

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).

…ght.c` includes.

When `rgblight.c` includes `rgblight_breathe_table.h`, the search order should be as follows.

* `keyboards/KEYBOARD/keymaps/USER/rgblight_breathe_table.h`
* `users/USER/rgblight_breathe_table.h`
* `quantum/rgblight_breathe_table.h`

However, the current implementation was wrong, so I fixed it.
@mtei mtei requested review from drashna and a team December 12, 2020 15:06
@github-actions github-actions bot added the core label Dec 12, 2020
@mtei mtei added the bug label Dec 12, 2020
@fauxpark
Copy link
Member

I changed this in #11153. It seems wrong.

Copy link
Member

@fauxpark fauxpark left a comment

Choose a reason for hiding this comment

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

Reading the GCC docs a little closer it looks like this is the same situation as the ChibiOS *conf.h files. Sorry about that.

@mtei mtei merged commit 10e4487 into qmk:master Dec 12, 2020
@mtei mtei deleted the fix_rgblight.c_include_path branch December 12, 2020 18:34
nicsuzor added a commit to nicsuzor/qmk_firmware that referenced this pull request Dec 16, 2020
* 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
…ght.c` includes. (qmk#11192)

When `rgblight.c` includes `rgblight_breathe_table.h`, the search order should be as follows.

* `keyboards/KEYBOARD/keymaps/USER/rgblight_breathe_table.h`
* `users/USER/rgblight_breathe_table.h`
* `quantum/rgblight_breathe_table.h`

However, the current implementation was wrong, so I fixed it.
drashna pushed a commit to zsa/qmk_firmware that referenced this pull request Jan 13, 2021
…ght.c` includes. (qmk#11192)

When `rgblight.c` includes `rgblight_breathe_table.h`, the search order should be as follows.

* `keyboards/KEYBOARD/keymaps/USER/rgblight_breathe_table.h`
* `users/USER/rgblight_breathe_table.h`
* `quantum/rgblight_breathe_table.h`

However, the current implementation was wrong, so I fixed it.
BorisTestov pushed a commit to BorisTestov/qmk_firmware that referenced this pull request May 23, 2024
…ght.c` includes. (qmk#11192)

When `rgblight.c` includes `rgblight_breathe_table.h`, the search order should be as follows.

* `keyboards/KEYBOARD/keymaps/USER/rgblight_breathe_table.h`
* `users/USER/rgblight_breathe_table.h`
* `quantum/rgblight_breathe_table.h`

However, the current implementation was wrong, so I fixed it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants