From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:470:142:3::10]:57457) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1j3xgn-0002x3-5s for guix-patches@gnu.org; Tue, 18 Feb 2020 02:53:06 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1j3xgl-0005k0-1x for guix-patches@gnu.org; Tue, 18 Feb 2020 02:53:05 -0500 Received: from debbugs.gnu.org ([209.51.188.43]:33519) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1j3xgk-0005jY-JO for guix-patches@gnu.org; Tue, 18 Feb 2020 02:53:02 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1j3xgk-0005py-Hc for guix-patches@gnu.org; Tue, 18 Feb 2020 02:53:02 -0500 Subject: bug#39640: [PATCH] doc: Document packaging guidelines for Rust crates. Resent-To: guix-patches@gnu.org Resent-Message-ID: Date: Tue, 18 Feb 2020 09:51:30 +0200 From: Efraim Flashner Message-ID: <20200218075130.GO1968@E5400> References: <20200217092159.776-1-efraim@flashner.co.il> <87k14lphn9.fsf@nicolasgoaziou.fr> MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha512; protocol="application/pgp-signature"; boundary="s3R87C3fwYeCSZ0b" Content-Disposition: inline In-Reply-To: <87k14lphn9.fsf@nicolasgoaziou.fr> List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+kyle=kyleam.com@gnu.org Sender: "Guix-patches" To: Nicolas Goaziou Cc: 39640-done@debbugs.gnu.org --s3R87C3fwYeCSZ0b Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Mon, Feb 17, 2020 at 12:39:22PM +0100, Nicolas Goaziou wrote: > Hello, >=20 > Efraim Flashner writes: >=20 > > * doc/contributing.texi (Rust Crates): New section. >=20 > Great! Thank you for this clarification. >=20 I realized I had most of it in my head and that wasn't helping anyone > > +To prevent namespace collisions we prefix all other rust packages with= the >=20 > rust -> Rust >=20 > > +In the rust ecosystem it is common for multiple incompatable versions = of a >=20 > Ditto. >=20 > Also incompatable -> incompatible ? >=20 spelling is hard :) > > +package to be used at any given time, so all packages should have a ve= rsioned > > +suffix. If a package has passed version 1.0.0 then just the major ver= sion > > +number is sufficient (e.g.@: rust-clap-2), otherwise the version suffi= x should > > +contain the major and minor version (e.g.@: rust-rand-0.6). >=20 > Nitpick: should contain both the major... >=20 > But that's just me. >=20 > I would also use @code{rust-clap-2} and @code{rust-rand-0.6} Both sound good. >=20 > > +Because of the difficulty in reusing rust packages as pre-compiled inp= uts for >=20 > rust -> Rust >=20 > > +other packages the @xref{cargo-build-system} presents the @code{#:carg= o-inputs} >=20 > @xref is misused here. It targets references at the beginning of > a sentence. I.e., it will generate >=20 > ... other packages the See cargo-build-system presents... >=20 > I suggest the more verbose >=20 > ... other packages the Cargo build system (@pxref{cargo-build-system}) = presents... pxref turned out to be a bit more complicated than I thought. I got it referring to Build Systems but not to cargo-build-system inside it. Since the references to gnu-build-system are similar I figured it was about the same. >=20 > > +and @code{cargo-development-inputs} keywords as build-system arguments= =2E It >=20 > build-system or build system? >=20 I've always thought of it as build-system due to the keyword, but 'build system' would be the correct one. > > Rust @code{dependencies} and @code{build-dependencies} > > +should go in @code{#:cargo-inputs}, and @code{dev-dependencies} should= go in > > +@code{#:cargo-development-inputs}. If a rust package links to other l= ibraries >=20 > rust -> Rust >=20 > Regards, >=20 > --=20 > Nicolas Goaziou Thanks for the review! --=20 Efraim Flashner =D7=90=D7=A4=D7=A8=D7=99=D7=9D = =D7=A4=D7=9C=D7=A9=D7=A0=D7=A8 GPG key =3D A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351 Confidentiality cannot be guaranteed on emails sent or received unencrypted --s3R87C3fwYeCSZ0b Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQIzBAABCgAdFiEEoov0DD5VE3JmLRT3Qarn3Mo9g1EFAl5Ll4EACgkQQarn3Mo9 g1F+JBAArGZxPsJnWU6OuoE06w1XpTVcIa3MoiM+R+s5JHWrQCVisAye+q1zAVzi k5NpFUE2Al7viufKJLINmhAKJB81IRXS3qqbZDUvzFS8W8l+w+MTsVMryURtbRLo xDnVBg2q26RLKM5Zus9fgVLm2dvDY4GeeKiRizsqSo51nua0LTOSxM04P+zRZKDY +VoAzp89Do7DZmUusjDyIC7CpxtHDSEOoJNbH8l3xugE6C5fj+Fjm5AD1nPWi6Li wHgDDueadAbUMbdR70zr8RXts2mNHI8S0SJx9MdPi4bBoiU5z5k8Fliy6cT7+Jn4 SsEIlnRg6dr3XsvTzFdETx56XoECJVkvHZugrkNYcU23aVgeyJ4rdZ3XiASgcrya d2DuKNwRkb5vf+6pEjIS2VS/UUyo/5UW8qKfbjzIeL96ztsuBxbfgE654orob4OS Xa7dRizyMCsq3WSTeAa1kiCirkrTSLwHHwyxRapjTUVti3EvMJhG/iSkdE95pDXN JTc7sLX6x13xSHuRuTNZwnZw4lL+sQtEoIaCKqAVdw7xYOAaU8s1T3sUc8FPKSCf 6665vmeutvjEbPz2EuHUcEW5ajuEpk4lZE/262tjFj5+HDZ0c6tEJ25fErKRIf0S 2u6jAVtu4N7dS4WXayZZHdRIsguZbzdVCKZzOO6uwn0T851zdR4= =x4CS -----END PGP SIGNATURE----- --s3R87C3fwYeCSZ0b--