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 support for out-of-tree userspace #11269

Closed
wants to merge 10 commits into from

Conversation

Erovia
Copy link
Member

@Erovia Erovia commented Dec 21, 2020

Description

Allow users to use out-of-tree keymaps/layouts.

Set the absolute path with qmk config user.userspace=/path/to/external/userspace and use qmk compile as usual.

TODO: Documentation

Opened as draft to get feedback and maybe help with writing the documentation.

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

@Erovia Erovia requested a review from a team December 21, 2020 17:55
@Erovia Erovia marked this pull request as ready for review December 22, 2020 15:01
@stale
Copy link

stale bot commented Feb 6, 2021

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

@coliss86
Copy link
Contributor

@Erovia I'm highly interested in your PR, would you mind rebasing it against master please ?

@drashna
Copy link
Member

drashna commented Mar 14, 2021

Has some merge conflicts here.

@@ -0,0 +1,69 @@
# External Userspace: Store your code outside the QMK repo
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it make sense to also document how to use this with plain make invocations?

Copy link
Member

Choose a reason for hiding this comment

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

I don't think so.

While it can be used with make, absolutely... the overall goal is to remove the dependency on make as much as possible, and push everyone to qmk.

Because of that, I don't think that adding documentation for make, well, makes any sense.

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok!

@drashna
Copy link
Member

drashna commented Jul 3, 2021

Also, merge conflicts

@kbrock
Copy link
Contributor

kbrock commented Jul 8, 2021

I really like the doctor refactor bit.
It is small, targeted, and makes the code easier to read.

Does it make sense to extract that into its own PR?
(not sure if the powers that be would agree)

@skullydazed
Copy link
Member

I really like the doctor refactor bit.
It is small, targeted, and makes the code easier to read.

Does it make sense to extract that into its own PR?
(not sure if the powers that be would agree)

We actually refactored doctor.py pretty recently in #13298, it will land in master with the next develop merge.

@tzarc
Copy link
Member

tzarc commented Nov 1, 2021

Has conflicts, removing the labels preventing stalebot from closing this automatically.
Suggest fixing things up to get it over the line.

@tzarc tzarc marked this pull request as draft November 4, 2021 21:05
@tzarc
Copy link
Member

tzarc commented Nov 4, 2021

Converted to draft to prevent accidental merge.

@stale
Copy link

stale bot commented Jan 3, 2022

Thank you for your contribution!
This pull request has been automatically marked as stale because it has not had activity in the last 45 days. It will be closed in 30 days if no further activity occurs. Please feel free to give a status update now, or re-open when it's ready.
For maintainers: Please label with awaiting review, breaking_change, in progress, or on hold to prevent the issue from being re-flagged.

@stale
Copy link

stale bot commented Apr 17, 2022

Thank you for your contribution!
This pull request has been automatically closed because it has not had activity in the last 30 days. Please feel free to give a status update now, ping for review, or re-open when it's ready.

@stale stale bot closed this Apr 17, 2022
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.

7 participants