Received: by 2002:a6b:500f:0:0:0:0:0 with SMTP id e15csp4813752iob; Mon, 9 May 2022 02:10:22 -0700 (PDT) X-Google-Smtp-Source: ABdhPJz4+ezj01ayqeHo1M7F8cUUtcyapWSzbjQb2n1r4ZNiOimwvrgOKQ8Fz+2sEp0guRYXu8CH X-Received: by 2002:a17:90a:cd06:b0:1cb:8c74:2baf with SMTP id d6-20020a17090acd0600b001cb8c742bafmr25139694pju.214.1652087422430; Mon, 09 May 2022 02:10:22 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1652087422; cv=none; d=google.com; s=arc-20160816; b=dtA3TSz4gL6m0rafGeIs1RZW+Yw+og/MKwYKF3TG7dt7kJ03MyNdTd1bWT2jIpRM+N fMvbbbUdWmnnEbxlIPJ1NjEo9Dm3sMTmdlaoHVWygx60L3XmdCuGAj5a4fb5/BM7qriR bE5dgIl4m20rN46nyEI0vBDOKIO2fGiuxG0wc1SXSTIPmi8kVEipvXYm4cjjVOZapwEF B5mopzimw2WoI2qBccrUCkdk+GN7IxLxVH26gMaokjsgyqgGWPKyhGnRPJN5DT5aOfUP YNwQhMbHpdylfrP5mOrPo/KEXdBecH6MtVNarazMQI6CNT/fNdFc68OxASp2vzBe9G5S AvJQ== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:in-reply-to:content-disposition:mime-version :references:message-id:subject:cc:to:from:date:dkim-signature; bh=xXMo3Iu7KrrtaTJNja1MGuo4fFLfSoIDMgbn2nLpUdo=; b=PfvSJRGzp7jWRHKPJvRPc4Q670/cFQ92vIHQ4YucFCz+x2IFjuyp0gbWyib1iiDG/t 2GwPh9pO7FIH1jDdE0528efjm7YYoX7k2boF5mIsuVYFTGGM8yAxK0RxZE/ijb+4vlxs 8cCAPo2lVGaVzMWlA1Z8i1aA6t2aLV3w8IjNSclxKdsVzLV0FNErlpH7L1LY8BhiV6eE hMX++PkgRMMzz3acbRLr8mkI0ILDAoDHuDCMV/nBu3ie3SswicyJmGWAX4wAGhxZDdOZ od+/y68jXe0EYdbTLSKjfNrcULISyFkRwclPFQ+gzKds4bpL2HVam9i2g7Xzlwa2RKtU HX/w== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=aB3QfVlp; spf=softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Return-Path: Received: from lindbergh.monkeyblade.net (lindbergh.monkeyblade.net. [23.128.96.19]) by mx.google.com with ESMTPS id w17-20020a170902a71100b00158d0436f45si9918948plq.76.2022.05.09.02.10.22 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 09 May 2022 02:10:22 -0700 (PDT) Received-SPF: softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) client-ip=23.128.96.19; Authentication-Results: mx.google.com; dkim=pass header.i=@chromium.org header.s=google header.b=aB3QfVlp; spf=softfail (google.com: domain of transitioning linux-kernel-owner@vger.kernel.org does not designate 23.128.96.19 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=chromium.org Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by lindbergh.monkeyblade.net (Postfix) with ESMTP id 21BAC2871B; Mon, 9 May 2022 01:58:10 -0700 (PDT) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1359151AbiEGITJ (ORCPT + 99 others); Sat, 7 May 2022 04:19:09 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:42936 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S238744AbiEGITG (ORCPT ); Sat, 7 May 2022 04:19:06 -0400 Received: from mail-pj1-x1031.google.com (mail-pj1-x1031.google.com [IPv6:2607:f8b0:4864:20::1031]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id E478C99 for ; Sat, 7 May 2022 01:15:20 -0700 (PDT) Received: by mail-pj1-x1031.google.com with SMTP id cx11-20020a17090afd8b00b001d9fe5965b3so12778552pjb.3 for ; Sat, 07 May 2022 01:15:20 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=chromium.org; s=google; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to; bh=xXMo3Iu7KrrtaTJNja1MGuo4fFLfSoIDMgbn2nLpUdo=; b=aB3QfVlpaiIgXfJVGa7V+xBdgjQvqYuHrEHa44Lugwxotnhmu7SYRcLLaANWk71r7Z pj3AAOtEcShLdlyWi5orxLvllFG0gItB9nAOqfTlgDjuD/iOCgN8swAhV0TJGNdEtGoj SWjIiHyeSoakBw0OKka4o4zUdMj/KvNxrvNB8= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to; bh=xXMo3Iu7KrrtaTJNja1MGuo4fFLfSoIDMgbn2nLpUdo=; b=dzkpwCj03K5G6QfG1rEV3QjuOGaFAbOCo4HOr6YBPMq3EaKXgOcdR61MlalX5Ic9bu PlRVHoDIiJwtqNb69W3ImSJfR5QWJnWvBldunjtTRx+5IEjqxZt71pvji0Fi2DsmAXGf DJ8YF/OEQ2ZqdcgF1Qx24pOUnIo+x2butqkIug8wj7psv4e8UlsmaLN/iWzFjCe4VNsg kdx183zTmBZgGFilRTGBMtwa/yEJv2sxnHDOHviQLOWF+xvFhapGCdjQq9kW4qlENkep rutVHUtXONyTEkeA2JwrbNZFUt5YUGs9hBOzP7GVfAfnjYxtUJIp6IAFvNA13xYpk5b7 WWZw== X-Gm-Message-State: AOAM5323LadM2vt3nYo7xEbTTTV+U1V5dY1Et5o1OgfoOpiZboaHIhYX W6uGOGcY9Vc4FpwHa6l2lpD/XA== X-Received: by 2002:a17:902:7597:b0:15e:b5d3:267d with SMTP id j23-20020a170902759700b0015eb5d3267dmr7774306pll.55.1651911320431; Sat, 07 May 2022 01:15:20 -0700 (PDT) Received: from www.outflux.net (smtp.outflux.net. [198.145.64.163]) by smtp.gmail.com with ESMTPSA id q1-20020a056a00084100b005107da0f34csm2981701pfk.20.2022.05.07.01.15.19 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 07 May 2022 01:15:20 -0700 (PDT) Date: Sat, 7 May 2022 01:15:19 -0700 From: Kees Cook To: Miguel Ojeda Cc: Linus Torvalds , Greg Kroah-Hartman , rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Jarkko Sakkinen , Alex Gaynor , Finn Behrens , Adam Bratschi-Kaye , Wedson Almeida Filho , Michael Ellerman , Sven Van Asbroeck , Wu XiangCheng , Gary Guo , Boris-Chengbiao Zhou , Yuki Okushi , Wei Liu , Daniel Xu , Julian Merkle , Jonathan Corbet , Masahiro Yamada , Michal Marek , Nick Desaulniers , linux-doc@vger.kernel.org, linux-kbuild@vger.kernel.org Subject: Re: [PATCH v6 18/23] docs: add Rust documentation Message-ID: <202205070114.88C59DF@keescook> References: <20220507052451.12890-1-ojeda@kernel.org> <20220507052451.12890-19-ojeda@kernel.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220507052451.12890-19-ojeda@kernel.org> X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,DKIMWL_WL_HIGH, DKIM_SIGNED,DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RDNS_NONE,SPF_HELO_NONE,T_SCC_BODY_TEXT_LINE autolearn=unavailable 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: X-Mailing-List: linux-kernel@vger.kernel.org On Sat, May 07, 2022 at 07:24:16AM +0200, Miguel Ojeda wrote: > Most of the documentation for Rust is written within the source code > itself, as it is idiomatic for Rust projects. This applies to both > the shared infrastructure at `rust/` as well as any other Rust module > (e.g. drivers) written across the kernel. > > However, these documents contain general information that does not > fit particularly well in the source code, like the Quick Start guide. > > It also contains an asset (SVG logo) used for the `rustdoc` target > and a few other small changes elsewhere in the documentation folder. I like the docs! :) It'll be interesting to see how we can grow cross-linking between rustdoc and kerndoc. Reviewed-by: Kees Cook -- Kees Cook