From patchwork Fri Dec 15 12:47:51 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Miguel Ojeda X-Patchwork-Id: 179257 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:3b04:b0:fb:cd0c:d3e with SMTP id c4csp9244568dys; Fri, 15 Dec 2023 04:48:29 -0800 (PST) X-Google-Smtp-Source: AGHT+IHJqXPov9xIWytXgGZOcGhj2pq7TaQBtK6AMsP92sgUEf/axRm6OcdcYzEHsBldWfMyIMFJ X-Received: by 2002:a05:6a21:3297:b0:18f:97c:8245 with SMTP id yt23-20020a056a21329700b0018f097c8245mr7392879pzb.79.1702644509201; Fri, 15 Dec 2023 04:48:29 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1702644509; cv=none; d=google.com; s=arc-20160816; b=pnxFXHRMbHtdGFqv7s9WwDGoLglr0PT2Cg7+Jrcnk1SAaxLzTV7qUX7X75GxKVedr4 B9VFzVihy6aqWgEv7Mq2aVC0ymsycSO1pKGm8A/EXKD/pQKLzX09CjkR2Mt4cTqkAsLM +bywT8bFlnKrx28aujY3k+Zr0hlOiX0+3IL+gCQvJb0A0q2iEZ0ULfXjRS5q+c60JiNV B0cx2vKklpcZpe4QPfd+HnQTp4iVtQ0mDy+FmTzQ5mSKDPQTD0K+dYJ+jBmJ0rjG8z5B tFYYM779krhhbwbcuplxg5WN4SZhW8yHXnjYL/69QLxQOp5b4IuBMO2hBN+q4+uk4Hx3 H27g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=V+1Trut5EWaxbGagcIZMRYlhwgmz025Cg3UUxIRvk70=; fh=lm2Y0jl8JDMXJpTg1eR6opTEXRjChk7t5O5ro4IkqRg=; b=e7+ING9yH+SYUVbTpF9UOtYYqpMDgUotr9JqqjFD2cLgff8YGOnl/RIEBXlKyLQNiT 6Ho/ABykdWU24Nhk8HdfzZ/Kcwyx2rpb8A03kvogCw8ryaQc9hU8N0l8OGfTYYNBY0pS VURuNvzIjIypvYN+F2fUyWzDVY12ajOPIhQMYLdlHqTQ7yyilQqGP/bJdbyX5fbVwF20 6pzXr2uqLQwBmHfWYdC+Msl0U/sBT41AwfBhUf3oyhmkJI+bjdG0AnCOduXBQ3TxOZkO txLXWsrxVOJRRJZL6b32WX48vYGjMmyl1fweBfeLO4pMx3YaIm6xUDUJ8DIZYwX7VGyr 5cow== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=GGAGxiS3; spf=pass (google.com: domain of linux-kernel+bounces-949-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-949-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from sy.mirrors.kernel.org (sy.mirrors.kernel.org. [2604:1380:40f1:3f00::1]) by mx.google.com with ESMTPS id j3-20020a170902c08300b001cfd24c7b73si12777260pld.2.2023.12.15.04.48.28 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 15 Dec 2023 04:48:29 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-949-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@kernel.org header.s=k20201202 header.b=GGAGxiS3; spf=pass (google.com: domain of linux-kernel+bounces-949-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-949-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=kernel.org Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by sy.mirrors.kernel.org (Postfix) with ESMTPS id 871E2B21E2E for ; Fri, 15 Dec 2023 12:48:18 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 522032D052; Fri, 15 Dec 2023 12:48:04 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=kernel.org header.i=@kernel.org header.b="GGAGxiS3" X-Original-To: linux-kernel@vger.kernel.org Received: from smtp.kernel.org (aws-us-west-2-korg-mail-1.web.codeaurora.org [10.30.226.201]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 8BB8D2C6A3; Fri, 15 Dec 2023 12:48:01 +0000 (UTC) Received: by smtp.kernel.org (Postfix) with ESMTPSA id 00FCDC433C7; Fri, 15 Dec 2023 12:47:56 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=kernel.org; s=k20201202; t=1702644481; bh=KmFWeYKbRRsOcz7786bdIgRCmbbEy4sqix2mUbhzS80=; h=From:To:Cc:Subject:Date:From; b=GGAGxiS3ZCe4EXhYSpVHvqYTkOw3Z386azCItWPdkTjxFrzm8ZqPY9UjfzvCeinuz 6jmYiIIQqHLE40yIO4N1DYTARwzirmk10jykV2FqlnzKNu+t9iqdE+Bvu83vyKQew3 L+8aJElN9JCebXatAwB6QXwulLd2YRSkhDsIy3C8H7S5aZ4caFU/94H/arFWIlNkNG InG2ZBszprtTaM/bwJKSEtVyZpOTivoZdu7zmfoLoUBrlmXOjB0hwEgGCh7JOvAVQi OEL67H3rMdcIkxOmUyQL7MOp/PBz5dAcRtKqnVpfsNFuo4IvfwuZwaN5OlBUotz0Z0 QkdqOpp0AaYyw== From: Miguel Ojeda To: Miguel Ojeda , Wedson Almeida Filho , Alex Gaynor Cc: Boqun Feng , Gary Guo , =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= , Benno Lossin , Andreas Hindborg , Alice Ryhl , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Jonathan Corbet , Nathan Chancellor , Nick Desaulniers , Bill Wendling , Justin Stitt , linux-doc@vger.kernel.org, llvm@lists.linux.dev Subject: [PATCH] docs: rust: remove `CC=clang` mentions Date: Fri, 15 Dec 2023 13:47:51 +0100 Message-ID: <20231215124751.175191-1-ojeda@kernel.org> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1785352169263278682 X-GMAIL-MSGID: 1785352169263278682 Nowadays all architectures except s390 recommend using `LLVM=1` instead of `CC=clang`, and since commit a3c6bfba4429 ("Documentation/llvm: refresh docs") the Kbuild LLVM documentation makes `LLVM=1` the way to go: We want to encourage the use of ``LLVM=1`` rather than just ``CC=clang``. Make that suggestion "above the fold" and "front and center" in our docs. In particular, that commit removes the examples with `CC=clang`. Thus do the same in the Rust Quick Start guide, i.e. remove the `CC=clang` mentions, especially since the architectures that have had their Rust support upstreamed (or soon to be upstreamed) are all `LLVM=1` ones anyway. And perhaps by the time Rust is supported for s390 (or new architectures), it may have moved to `LLVM=1` anyway. Otherwise, this can be added back if needed (or perhaps an extra link to Documentation/kbuild/llvm.rst). This should also help avoiding potential confusion around `CC=clang` [1]. Link: https://lore.kernel.org/rust-for-linux/6df6e8e5-8d5b-4d3d-91b5-bc0e90c424ea@nvidia.com/ [1] Signed-off-by: Miguel Ojeda Reviewed-by: Alice Ryhl Reviewed-by: Ariel Miculas Reviewed-by: Martin Rodriguez Reboredo Reviewed-by: John Hubbard Reviewed-by: Justin Stitt Reviewed-by: Nathan Chancellor Reviewed-by: Benno Lossin --- Documentation/rust/quick-start.rst | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) base-commit: a39b6ac3781d46ba18193c9dbb2110f31e9bffe9 diff --git a/Documentation/rust/quick-start.rst b/Documentation/rust/quick-start.rst index f382914f4191..75faa987079a 100644 --- a/Documentation/rust/quick-start.rst +++ b/Documentation/rust/quick-start.rst @@ -76,7 +76,7 @@ libclang ``libclang`` (part of LLVM) is used by ``bindgen`` to understand the C code in the kernel, which means LLVM needs to be installed; like when the kernel -is compiled with ``CC=clang`` or ``LLVM=1``. +is compiled with ``LLVM=1``. Linux distributions are likely to have a suitable one available, so it is best to check that first. @@ -229,10 +229,6 @@ at the moment. That is:: make LLVM=1 -For architectures that do not support a full LLVM toolchain, use:: - - make CC=clang - Using GCC also works for some configurations, but it is very experimental at the moment.