From: Nicolas Goaziou <mail@nicolasgoaziou.fr>
To: Efraim Flashner <efraim@flashner.co.il>
Cc: 39640@debbugs.gnu.org
Subject: [bug#39640] [PATCH] doc: Document packaging guidelines for Rust crates.
Date: Mon, 17 Feb 2020 12:39:22 +0100 [thread overview]
Message-ID: <87k14lphn9.fsf@nicolasgoaziou.fr> (raw)
In-Reply-To: <20200217092159.776-1-efraim@flashner.co.il> (Efraim Flashner's message of "Mon, 17 Feb 2020 11:21:59 +0200")
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
next prev parent reply other threads:[~2020-02-17 11:40 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-02-17 9:21 [bug#39640] [PATCH] doc: Document packaging guidelines for Rust crates Efraim Flashner
2020-02-17 11:39 ` Nicolas Goaziou [this message]
2020-02-18 7:51 ` bug#39640: " Efraim Flashner
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87k14lphn9.fsf@nicolasgoaziou.fr \
--to=mail@nicolasgoaziou.fr \
--cc=39640@debbugs.gnu.org \
--cc=efraim@flashner.co.il \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.