From mboxrd@z Thu Jan  1 00:00:00 1970
Received: from eggs.gnu.org ([2001:470:142:3::10]:39990)
 by lists.gnu.org with esmtp (Exim 4.90_1)
 (envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1j3ekt-0003IZ-S4
 for guix-patches@gnu.org; Mon, 17 Feb 2020 06:40:04 -0500
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1j3eks-0005M1-Oa
 for guix-patches@gnu.org; Mon, 17 Feb 2020 06:40:03 -0500
Received: from debbugs.gnu.org ([209.51.188.43]:60325)
 by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16)
 (Exim 4.71) (envelope-from <Debian-debbugs@debbugs.gnu.org>)
 id 1j3eks-0005Lf-Kz
 for guix-patches@gnu.org; Mon, 17 Feb 2020 06:40:02 -0500
Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2)
 (envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1j3eks-0005rw-AX
 for guix-patches@gnu.org; Mon, 17 Feb 2020 06:40:02 -0500
Subject: [bug#39640] [PATCH] doc: Document packaging guidelines for Rust
 crates.
Resent-Message-ID: <handler.39640.B39640.158193956822513@debbugs.gnu.org>
From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
References: <20200217092159.776-1-efraim@flashner.co.il>
Date: Mon, 17 Feb 2020 12:39:22 +0100
In-Reply-To: <20200217092159.776-1-efraim@flashner.co.il> (Efraim Flashner's
 message of "Mon, 17 Feb 2020 11:21:59 +0200")
Message-ID: <87k14lphn9.fsf@nicolasgoaziou.fr>
MIME-Version: 1.0
Content-Type: text/plain
List-Id: <guix-patches.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/guix-patches>,
 <mailto:guix-patches-request@gnu.org?subject=unsubscribe>
List-Archive: <https://lists.gnu.org/archive/html/guix-patches>
List-Post: <mailto:guix-patches@gnu.org>
List-Help: <mailto:guix-patches-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/guix-patches>,
 <mailto:guix-patches-request@gnu.org?subject=subscribe>
Errors-To: guix-patches-bounces+kyle=kyleam.com@gnu.org
Sender: "Guix-patches" <guix-patches-bounces+kyle=kyleam.com@gnu.org>
To: Efraim Flashner <efraim@flashner.co.il>
Cc: 39640@debbugs.gnu.org

Hello,

Efraim Flashner <efraim@flashner.co.il> writes:

> * doc/contributing.texi (Rust Crates): New section.

Great! Thank you for this clarification.

> +To prevent namespace collisions we prefix all other rust packages with the

rust -> Rust

> +In the rust ecosystem it is common for multiple incompatable versions of a

Ditto.

Also incompatable -> incompatible ?

> +package to be used at any given time, so all packages should have a versioned
> +suffix.  If a package has passed version 1.0.0 then just the major version
> +number is sufficient (e.g.@: rust-clap-2), otherwise the version suffix should
> +contain the major and minor version (e.g.@: rust-rand-0.6).

Nitpick: should contain both the major...

But that's just me.

I would also use @code{rust-clap-2} and @code{rust-rand-0.6}

> +Because of the difficulty in reusing rust packages as pre-compiled inputs for

rust -> Rust

> +other packages the @xref{cargo-build-system} presents the @code{#:cargo-inputs}

@xref is misused here. It targets references at the beginning of
a sentence. I.e., it will generate

  ... other packages the See cargo-build-system presents...

I suggest the more verbose

  ... other packages the Cargo build system (@pxref{cargo-build-system}) presents...

> +and @code{cargo-development-inputs} keywords as build-system arguments.  It

build-system or build system?

> 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 libraries

rust -> Rust

Regards,

-- 
Nicolas Goaziou