From mboxrd@z Thu Jan 1 00:00:00 1970 From: Tobias Geerinckx-Rice Subject: Re: Digimend kernel drivers for Guix Date: Tue, 28 May 2019 20:25:13 +0200 Message-ID: <878suqqvw6.fsf@nckx> References: <24EBF066-DEB0-4D52-85F4-7D67F3E0A046@firemail.cc> Mime-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha512; protocol="application/pgp-signature" Return-path: Received: from eggs.gnu.org ([209.51.188.92]:52634) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hVgnB-0000ab-8e for guix-devel@gnu.org; Tue, 28 May 2019 14:25:47 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hVgn8-0008QJ-HG for guix-devel@gnu.org; Tue, 28 May 2019 14:25:45 -0400 Received: from tobias.gr ([80.241.217.52]:33686) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1hVgn2-00085l-Ey for guix-devel@gnu.org; Tue, 28 May 2019 14:25:40 -0400 In-reply-to: <24EBF066-DEB0-4D52-85F4-7D67F3E0A046@firemail.cc> List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: "Guix-devel" To: guix-devel@gnu.org, Marlon --=-=-= Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: quoted-printable Marlin, Marlin wrote: > I have just managed to get the digimend kernel drivers packaged=20 > for guix: Cool! I encourage you to read the =E2=80=98Contributing=E2=80=99 section o= f the=20 manual, set up your own git repository, and submit a patch adding=20 this package to linux.scm. I don't mind merging this version eventually, but you'll have to=20 do so sooner or later if you want to keep contributing (and I hope=20 you will). Might as well jump in. > (define-public digimend-kernel-drivers I realise this is the upstream name. I'm not sure what to do=20 here. We currently have 2 separately packaged Linux kernel modules:=20 vhba-module (which was first) and acpi-call-linux-module (the=20 latter added by me). I'd really like to see some semblance of=20 consistency in naming these things and don't think =E2=80=98-module[s]=E2= =80=99=20 (for Guile?), =E2=80=98-driver[s]=E2=80=99 (not all modules are drivers, bu= t I=20 agree it's subtle), or =E2=80=98-kernel-=E2=80=99 (which kernel?) cut it. > (package > (name "digimend-kernel-drivers") > (version "9") > (source (origin > (method url-fetch) > (uri (string-append "[=E2=80=A6long URL is long=E2=80=A6]" Please keep lines shorter than 80 characters. Often indenting can=20 make the difference (SOURCE and ORIGIN here could be on two=20 separate lines, for example) but that won't help you here. You're already calling STRING-APPEND, so you can simply split up=20 the URL: (uri (string-append "https://github.com/DIGImend/digimend-kernel-drivers/" "releases/download/v9/digimend-kernel-drivers-" =E2=80=A6 =E2=80=A6or however you prefer. Also note the hard-coded =E2=80=989=E2=80= =99 that needs=20 replacing by VERSION. =20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20= =20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20= =20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20= =20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20=20 > (build-system linux-module-build-system) All lines from here on are misleadingly indented: this opening=20 bracket should be even with that of SOURCE above. If you use emacs, fixing this is as easy as running C-M-q at the=20 beginning of the package definition. If you don't (nobody's=20 perfect), we provide a stand-alone (emacs) script to do this: ./etc/indent-code.el gnu/packages/FILE.scm PACKAGE =E2=80=A6although I've never used it. See the =E2=80=98Formatting Code=E2= =80=99 section=20 of the manual. > (arguments '(#:phases (modify-phases %standard-phases=20 > (delete 'check)))) This works (and once re-indented it won't even exceed 80=20 characters), but consider the more conventional and easy-to-skim (arguments '(#:phases (modify-phases %standard-phases (delete 'foo)))) ; no foo gizmo =E2=80=A6including the helpful comment. However, in this case, please use the even simpler: =20=20=20=20=20=20=20=20=20=20=20=20=20=20 (arguments '(#:tests?)) ; no test suite > (synopsis "Kernel Drivers for non-wacom Digital=20 > Tablets") =E2=80=98Drivers=E2=80=99 & =E2=80=98Digital Tablets=E2=80=99 shouldn't be = capitalised; =E2=80=98Wacom=E2=80=99=20 should. However, I think the project already offers a good synopsis on=20 their home page: how about "Linux drivers for generic graphics=20 tablets"? > (description "Provides Drivers for Tablets from \ > companies like huion and ugee.") Same here: nouns in English don't need to be capitalised, proper=20 nouns such as =E2=80=98Huion=E2=80=99 do (even if they don't do so themselv= es!). Why single out these two manufacturers? The home page lists a lot=20 more. This is also far to short to be a description: ideally, they=20 should be around ~10 lines. Here too, the home page has some good=20 stuff ready to use. The DIGImend project aims at improving Linux support for generic graphics tablets. Essentially, this means any USB-connected=20 drawing tablet not produced by Wacom (and often more affordable). This package supports tablets designed and sold by Huion, KYE, UC-Logic and Waltop, rebranded and sold by Aiptek, Genius,=20 Monoprice, Princeton, Trust, and many others. This way, people searching for =E2=80=98Aiptek=E2=80=99 will still find thi= s=20 package, and I took the liberty of =E2=80=98keyword-stuffing=E2=80=99 the w= ord=20 =E2=80=98drawing=E2=80=99 in there for good measure ;-) This is still pretty short. If there's more to be said, please=20 add it! > (license gpl2))) This seems to be accurate. You'll need to add a =E2=80=98license:=E2=80=99= when=20 moving this to linux.scm. Thank you for packaging this, and I hope you'll submit a=20 git-formatted patch to guix-patches@ soon. If you get stuck,=20 don't hesitate to ask questions on guix-devel@ or #guix. Kind regards, T G-R (nckx) --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iHUEARYKAB0WIQT12iAyS4c9C3o4dnINsP+IT1VteQUCXO19CQAKCRANsP+IT1Vt eeaUAP4hPNOsAWSn2omDjd3rA3ETWKmp9mvVGpuVJC3hlbVG7gEAzojdNxi6wdAf m5D/3MOUsdkMceAUpcwuynHJka4hWQ8= =zK8D -----END PGP SIGNATURE----- --=-=-=--