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

Add a mechanism for force building a particular community layout #5027

Merged
merged 3 commits into from
Feb 15, 2019

Conversation

zvecr
Copy link
Member

@zvecr zvecr commented Feb 1, 2019

Description

I use a nori as a 4x12 keyboard and 4x4 macro pad, and have community layouts for both. Branch here

vagrant@vagrant:/vagrant$ ls layouts/community/*/zvecr
layouts/community/ortho_4x12/zvecr:
config.h  keymap.c  readme.md  rules.mk

layouts/community/ortho_4x4/zvecr:
config.h  keymap.c  readme.md  rules.mk

Currently there is no way to build both keymaps and make 40percentclub/nori:zvecr builds whatever it finds first, in this case ortho_4x12.

So far, i have added an additional flag that allows a particular keymap to be targeted

make 40percentclub/nori:zvecr FORCE_LAYOUT=ortho_4x4
make 40percentclub/nori:zvecr FORCE_LAYOUT=ortho_4x12

TBD

  • What docs would need updating? done
  • Should the filename contain the layout used? done
  • Should this be extended to allow it to be specified in the keymap argument, eg
    make 40percentclub/nori:ortho_4x4/zvecr
    will not do for now, but could add in a future PR

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

@drashna
Copy link
Member

drashna commented Feb 1, 2019

Documentation about this should go here:
https://github.com/qmk/qmk_firmware/blob/master/docs/feature_layouts.md

And yeas, please do add documentation about this.

Copy link
Contributor

@mechmerlin mechmerlin left a comment

Choose a reason for hiding this comment

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

Thanks!

@mechmerlin mechmerlin merged commit 40e67a3 into qmk:master Feb 15, 2019
@zvecr zvecr deleted the feature/community_param branch February 25, 2019 23:42
dlhextall pushed a commit to dlhextall/qmk_firmware that referenced this pull request May 24, 2019
…#5027)

* Add a mechanism for force building a particular community layout

* Add docs for FORCE_LAYOUT argument

* Update output name when FORCE_LAYOUT is enabled
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.

None yet

3 participants