Added DKMS support and documentation #195
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm using DKMS to manage this module, in part because it makes it easy to manage signing the kernel module to appease Secure Boot. It makes my life a lot simpler, so I thought I'd contribute it back. Hope it can be useful!
This PR adds:
INSTALLING.md
, both with and without DKMS.dkms.tmpl.conf
file, which requires the user to replaceCOMMIT_ID_VERSION
(with ased
script provided inINSTALLING.md
) and write the result todkms.conf
.When the source repo is copied to
/usr/src
, the user-createddkms.conf
is automatically picked up on by DKMS when performingdkms install
. From there, everything works smoothly.Why no dkms.conf?
DKMS versioning is important - otherwise DKMS will never think there's been an update, even if there has been.
The only way I could think of to version
xmm7360-pci
was by commit-id, as there are no releases. Unfortunately,dkms.conf
can't automatically grab the commit-id ofHEAD
.We can't update
dkms.conf
every time there's a commit. So, we have to insist that the user runs a one-linersed
script (documented inINSTALLING.md
), one avoids introducing the chore of manually updating a version string every time there's a change.There's probably a better way, but this is simple and it works. Also, if someone happens to copy
dkms.tmpl.conf
directly intodkms.conf
, it'll still work - the version will just beCOMMIT_ID_VERSION
.How-To (also in INSTALLING.md)
The following instructions are copy/pasted from
INSTALLING.md
. I've tested them on my own machine.After this, the user simply runs
sudo ./scripts/lte.sh up
as usual.