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

Document the correct path to the split keyboard EEPROM files #4585

Merged
merged 2 commits into from
Dec 14, 2018

Conversation

zvecr
Copy link
Member

@zvecr zvecr commented Dec 9, 2018

Description

This fixes incorrect paths to the split keyboard EEPROM files within the repo.

Other items for potential review:

  • Should all references to eeprom files be updated to the full path ./quantum/split_common/eeprom-lefthand.eep and ./quantum/split_common/eeprom-righthand.eep?
  • Should this PR update the location within ./keyboards/lets_split/keymaps/bbaserdem/README.md? Not required
  • Should this PR remove the other eeprom files within minidox and deltasplit75 so that the only eeprom files are within the common folder? Not required

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.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document. (https://docs.qmk.fm/#/contributing)
  • 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).

@noroadsleft
Copy link
Member

Travis CI error is unrelated.

@drashna
Copy link
Member

drashna commented Dec 10, 2018

Travis CI error is explicitly due to an issue with the avr-gcc compiler that it uses. I'm using the same version on both MSYS and ubuntu and it compiles under size....

Should all references to eeprom files be updated to the full path ./quantum/split_common/eeprom-lefthand.eep and ./quantum/split_common/eeprom-righthand.eep?

Yes, I think it should, honestly.

Should this PR update the location within ./keyboards/lets_split/keymaps/bbaserdem/README.md?

For keymap readme's, no. Just the main readme for the keyboard (and maybe the default keymap's readme".

Should this PR remove the other eeprom files within minidox and deltasplit75 so that the only eeprom files are within the common folder?

I'd say only if these keyboards have been converted and tested with the split common code. For now, it should be fine.

@zvecr
Copy link
Member Author

zvecr commented Dec 10, 2018

@drashna Thanks, i will make those updates shortly.

@bbaserdem Now that the Lets Split uses the split keyboard common code, there are stale reference to the eeprom files within ./keyboards/lets_split/keymaps/bbaserdem/README.md

@zvecr zvecr changed the title [WIP] Document the correct path to the split keyboard EEPROM files Document the correct path to the split keyboard EEPROM files Dec 10, 2018
@drashna
Copy link
Member

drashna commented Dec 14, 2018

Awesome, thanks!

@drashna drashna merged commit 306f23d into qmk:master Dec 14, 2018
@zvecr zvecr deleted the feature/split-EEPROM-location branch December 14, 2018 22:35
ishtob pushed a commit to ishtob/qmk_firmware that referenced this pull request Jan 1, 2019
* Document the correct path to the split keyboard EEPROM files

* Document the correct path to the split keyboard EEPROM files
yeliu84 pushed a commit to yeliu84/qmk_firmware that referenced this pull request Jan 7, 2019
* Document the correct path to the split keyboard EEPROM files

* Document the correct path to the split keyboard EEPROM files
rseymour pushed a commit to rseymour/qmk_firmware that referenced this pull request Mar 13, 2019
* Document the correct path to the split keyboard EEPROM files

* Document the correct path to the split keyboard EEPROM files
djthread pushed a commit to djthread/qmk_firmware that referenced this pull request Mar 17, 2019
* Document the correct path to the split keyboard EEPROM files

* Document the correct path to the split keyboard EEPROM files
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.

3 participants