Message ID | 20230306220959.240235-1-ojeda@kernel.org |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a5d:5915:0:0:0:0:0 with SMTP id v21csp2106075wrd; Mon, 6 Mar 2023 14:25:41 -0800 (PST) X-Google-Smtp-Source: AK7set9jc0n1ArqGP3820ateSmGfR6u4A/39UIQEqRNFzrhv7cYgTxrs8rf6r7BGwjyi4mysg+X0 X-Received: by 2002:a17:902:ec8f:b0:19a:aaac:f4d1 with SMTP id x15-20020a170902ec8f00b0019aaaacf4d1mr11242476plg.13.1678141541359; Mon, 06 Mar 2023 14:25:41 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1678141541; cv=none; d=google.com; s=arc-20160816; b=qrR8CkgICkh6o3gQvvMbEEcpmkkO4hh0FJKt3T4BeNNFsUNasD2Gpbz4XkHd1hzq5i 9jOJ23v/8hFdXG21k2xTQV8UJ9Y6dQ84a8x3EkCWM7LfQ818ng6OAsJ05RSE4LfzPKdz v+8VJ12veyQGiaHa6ZW550x90Y3xZbetyyLXlKsJKDWDSlRnoEIxS5yZlTAU7U3D+mRw hVk1n2UH7kbEHto+zjsE2saUcqitHV2S5xDsyOXpI4F7iExylDI1BTyjDBnyzFARXF5p KU1ESwIFqmTllVYwDH7E9aTkpDIokP3jHc7tkKH6gBwtog7Ti8wHHmGxVuD9kco0uSxv wy2w== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:content-transfer-encoding:mime-version :message-id:date:subject:cc:to:from:dkim-signature; bh=Ss6uPFwc/KlJjMRKk43JcIKlDwOWHaGdgkf6Z8qmr1Q=; b=QEiaRulKt6c/ai9x95Th0B9gj2rj2ZrK/akeRgjJs+7JkObwxMvhhOfeQ6jwYBtmfy EcKn7OyCBVKmScsNUClNhYNOJvc5wAJM5DCwb3RiKAfDoho6oquEXrYt2HsHm7WLM3Gd c2OC2MKYq8dUSsUfALAJSQIye7WioAfbBIWs7yZmyS2Ntzgy/NOyLLxgc83luwWw6seD mN1YKzUZ+7+W7mVbe6LceDEtrXZpRlv0aboGLQb4LsP407zTGRB/T8ErqWrVSFxbCRxV PIx79PrVSr87g/Cb0AuvNJWIcE4RUJCY0Ppc7/7HnU1JRmF52xAY7EoI3+9laL97Ahuy iLpw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=ar1g9Pvs; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from out1.vger.email (out1.vger.email. [2620:137:e000::1:20]) by mx.google.com with ESMTP id y3-20020a170902864300b0019a986428a8si10095996plt.580.2023.03.06.14.25.29; Mon, 06 Mar 2023 14:25:41 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=ar1g9Pvs; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229928AbjCFWKa (ORCPT <rfc822;toshivichauhan@gmail.com> + 99 others); Mon, 6 Mar 2023 17:10:30 -0500 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:36186 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229628AbjCFWK2 (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Mon, 6 Mar 2023 17:10:28 -0500 Received: from ams.source.kernel.org (ams.source.kernel.org [IPv6:2604:1380:4601:e00::1]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 379423A876; Mon, 6 Mar 2023 14:10:18 -0800 (PST) Received: from smtp.kernel.org (relay.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by ams.source.kernel.org (Postfix) with ESMTPS id E8B80B8111A; Mon, 6 Mar 2023 22:10:16 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id D8604C433D2; Mon, 6 Mar 2023 22:10:12 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1678140615; bh=KN5F0AoFgFiAv14Zs4VVwE5Kztdka3CdrjT1Qq8snyQ=; h=From:To:Cc:Subject:Date:From; b=ar1g9Pvs6nI2YGY1crohlcib7jgCpYuLpx4nEfJAxZaICCg/2qHbFgKQMpwWYc5T/ pReSqdlGSEgLqnK86GkxEVCGVmg6ocyZwGYIOESDg2YItz4gk2Uq3Y6At8fw2A3XYq 2mR1D9LlFGahqIsYtr/+CBUT7ZRazFDCeoMUePlUeSEuw95eUclar8nfFeN52xkpro JXr2YK5zrIZz9Jz+WV6IKAgKW1gyWPAQnmUi0cUxXcVx45kt7JRp2LoAEVLQfAXEDr ZPummfBAAz0Iz9r5LDb+JsNZozRIqIq3rgrHmCS6RKFpP/Eq12V+qJ3uOIQxFXiF4t JcnRdmf6WL4bw== From: Miguel Ojeda <ojeda@kernel.org> To: Jonathan Corbet <corbet@lwn.net>, Wedson Almeida Filho <wedsonaf@gmail.com>, Alex Gaynor <alex.gaynor@gmail.com>, Boqun Feng <boqun.feng@gmail.com>, Gary Guo <gary@garyguo.net>, =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= <bjorn3_gh@protonmail.com> Cc: linux-doc@vger.kernel.org, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Miguel Ojeda <ojeda@kernel.org> Subject: [PATCH] docs: rust: point directly to the standalone installers Date: Mon, 6 Mar 2023 23:09:59 +0100 Message-Id: <20230306220959.240235-1-ojeda@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Spam-Status: No, score=-4.4 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,RCVD_IN_DNSWL_MED, SPF_HELO_NONE,SPF_PASS autolearn=ham autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lindbergh.monkeyblade.net Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-getmail-retrieved-from-mailbox: =?utf-8?q?INBOX?= X-GMAIL-THRID: =?utf-8?q?1759658944852118073?= X-GMAIL-MSGID: =?utf-8?q?1759658944852118073?= |
Series |
docs: rust: point directly to the standalone installers
|
|
Commit Message
Miguel Ojeda
March 6, 2023, 10:09 p.m. UTC
The Quick Start guide points to the Rust programming language front
page when it mentions the possibility of using the standalone
installers instead of `rustup`.
This was done to have a hopefully stable link, but it is not too
helpful: readers need to figure out how to reach the standalone
installers from there.
Thus point directly to the page (and anchor) with the table that
contains the standalone installers (plus signing key etc.).
If the link breaks in the future, we can always update it as
needed. And anyway having the full link includes the domain and
gives more information about where the old docs were in such
a broken link case, which may help.
Link: https://lore.kernel.org/linux-doc/CANiq72=gpzQyh1ExGbBWWNdgH-mTATdG5F600jKD1=NLLCn7wg@mail.gmail.com/
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
Documentation/rust/quick-start.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
base-commit: fe15c26ee26efa11741a7b632e9f23b01aca4cc6
Comments
On Mon, Mar 6, 2023 at 11:10 PM Miguel Ojeda <ojeda@kernel.org> wrote: > > Thus point directly to the page (and anchor) with the table that > contains the standalone installers (plus signing key etc.). By the way, while it is fairly easy to figure out the links to previous stable releases, it would nevertheless be nice to have a way to show them. At least there is a `FIXME` comment in those docs about it: https://github.com/rust-lang/rust-forge/blob/793249870cf7610ffe78dcb9c7acc7efdbbcc713/src/infra/other-installation-methods.md?plain=1#L99-L101 So I opened https://github.com/rust-lang/rust-forge/issues/676. Cheers, Miguel
> The Quick Start guide points to the Rust programming language front > page when it mentions the possibility of using the standalone > installers instead of `rustup`. > > This was done to have a hopefully stable link, but it is not too > helpful: readers need to figure out how to reach the standalone > installers from there. > > Thus point directly to the page (and anchor) with the table that > contains the standalone installers (plus signing key etc.). > > If the link breaks in the future, we can always update it as > needed. And anyway having the full link includes the domain and > gives more information about where the old docs were in such > a broken link case, which may help. > > Link: https://lore.kernel.org/linux-doc/CANiq72=gpzQyh1ExGbBWWNdgH-mTATdG5F600jKD1=NLLCn7wg@mail.gmail.com/ > Signed-off-by: Miguel Ojeda <ojeda@kernel.org> > --- Reviewed-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
Miguel Ojeda <ojeda@kernel.org> writes: > The Quick Start guide points to the Rust programming language front > page when it mentions the possibility of using the standalone > installers instead of `rustup`. > > This was done to have a hopefully stable link, but it is not too > helpful: readers need to figure out how to reach the standalone > installers from there. > > Thus point directly to the page (and anchor) with the table that > contains the standalone installers (plus signing key etc.). > > If the link breaks in the future, we can always update it as > needed. And anyway having the full link includes the domain and > gives more information about where the old docs were in such > a broken link case, which may help. > > Link: https://lore.kernel.org/linux-doc/CANiq72=gpzQyh1ExGbBWWNdgH-mTATdG5F600jKD1=NLLCn7wg@mail.gmail.com/ > Signed-off-by: Miguel Ojeda <ojeda@kernel.org> > --- > Documentation/rust/quick-start.rst | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst > index 13b7744b1e27..253d47791f0f 100644 > --- a/Documentation/rust/quick-start.rst > +++ b/Documentation/rust/quick-start.rst > @@ -40,7 +40,7 @@ and run:: > > Otherwise, fetch a standalone installer or install ``rustup`` from: I guess we should remove "or install ``rustup``" from this sentence? BR Andreas
On Tue, Mar 7, 2023 at 1:31 PM Andreas Hindborg <nmi@metaspace.dk> wrote: > > I guess we should remove "or install ``rustup``" from this sentence? Good point -- the page contains installers for `rustup` itself too above the URL fragment, but we are pointing directly to the fragment, so it can be confusing. I think I will split the sentence and add an extra link to the other fragment, since there is one for that too (`#rustup`). Cheers, Miguel
On Tue, Mar 7, 2023 at 1:45 PM Miguel Ojeda <miguel.ojeda.sandonis@gmail.com> wrote: > > I think I will split the sentence and add an extra link to the other > fragment, since there is one for that too (`#rustup`). In the end, I did what you suggested Andreas; in part because their front page has slightly different instructions (opened https://github.com/rust-lang/rust-forge/issues/684), and in part because adding extra links to `rustup` is better done in a different patch (perhaps explaining what `rustup` is, too). Cheers, Miguel
On Mon, Mar 6, 2023 at 11:10 PM Miguel Ojeda <ojeda@kernel.org> wrote: > > The Quick Start guide points to the Rust programming language front > page when it mentions the possibility of using the standalone > installers instead of `rustup`. > > This was done to have a hopefully stable link, but it is not too > helpful: readers need to figure out how to reach the standalone > installers from there. > > Thus point directly to the page (and anchor) with the table that > contains the standalone installers (plus signing key etc.). > > If the link breaks in the future, we can always update it as > needed. And anyway having the full link includes the domain and > gives more information about where the old docs were in such > a broken link case, which may help. > > Link: https://lore.kernel.org/linux-doc/CANiq72=gpzQyh1ExGbBWWNdgH-mTATdG5F600jKD1=NLLCn7wg@mail.gmail.com/ > Signed-off-by: Miguel Ojeda <ojeda@kernel.org> Applied to `rust-next` (with Andreas' suggestion applied) -- thanks everyone! Cheers, Miguel
diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst index 13b7744b1e27..253d47791f0f 100644 --- a/Documentation/rust/quick-start.rst +++ b/Documentation/rust/quick-start.rst @@ -40,7 +40,7 @@ and run:: Otherwise, fetch a standalone installer or install ``rustup`` from: - https://www.rust-lang.org + https://forge.rust-lang.org/infra/other-installation-methods.html#standalone Rust standard library source