Message ID | 20240116160141.165951-4-kernel@valentinobst.de |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel+bounces-27553-ouuuleilei=gmail.com@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:42cf:b0:101:a8e8:374 with SMTP id q15csp353519dye; Tue, 16 Jan 2024 08:03:15 -0800 (PST) X-Google-Smtp-Source: AGHT+IHsmkR+3mEY7o9IvwdHK4QBP7ROfsVGENnM2/aGJBBdtE7fVdq5iCTgjFzn2jh5icoPnQ6c X-Received: by 2002:aa7:d0c2:0:b0:559:beb0:36e9 with SMTP id u2-20020aa7d0c2000000b00559beb036e9mr351184edo.10.1705420995382; Tue, 16 Jan 2024 08:03:15 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1705420995; cv=none; d=google.com; s=arc-20160816; b=io+ZMzof0EZ09kgJFuQ7HLOq4fpMI8I5WaEc6X461p+dcMRlawURPRRThboI+kUHCP mqeVcbr25tK6MhASCzbMyjvL+Gxsq1bK3RMe0aNimuaixsyVRR7UNDQON6+CuDPiWILN /sob8xEj6vlT5aICj3J28HNfZlCywDl/ssU3/UN6th/iRWJs0YrEyv0eQXUEwT7te7m6 3hGR5CkchbszXi/73Rp6xfYwlZB7B1sDOdZ0kNMQZFINrH1VhNtQDof4BpxQNbm6S4Je 7Y6wcm4ZYO7utCfTryigIHDUvH5ywg1+B5kxNgNlPy7u9hccg6j1jQI8LZzE1wBIvIuT DBpg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=ui-outboundreport:content-transfer-encoding:mime-version :list-unsubscribe:list-subscribe:list-id:precedence:references :in-reply-to:message-id:date:subject:cc:to:from; bh=kXz7FcZz9eznbjHJoubOEQdwcF4iVQr6ipdmeyxmw7A=; fh=mB5qiQ7ps5IWvjuQS9+zcxjK3ZInVolb8UwIN1mvAmg=; b=TyOHDL12yamJI5mHpq1R0RhvJWeslGr+IxfnmHhyfxtDTd28WHpTcOcBzhD8IabFVc U4M5gi5ArZ32+9T2rotLi2dtoldSUH7rgJinUo2cSGNw3EC7uxXY3/sGNInYY40AJJZ+ LD91PyuX0xqwqWAbN9lZLjIUdkb06yWxiSV9VLzRfIrQfQeouBTccNKjUao4+qIQ5dhY +VQAGK5JHE/AFnymsXS5u2omieCjvRm3RQpKBFmhZJLdJ/u0VCdYmS20CM0RIQFcPx1c xqEI9ED8D4pSoVGuA1BCL33QnH4wHs7zW2L3hDNhC5958yg38QRb5v7IX4SVc3C/7TQW pBpw== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: domain of linux-kernel+bounces-27553-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-27553-ouuuleilei=gmail.com@vger.kernel.org" Received: from am.mirrors.kernel.org (am.mirrors.kernel.org. [147.75.80.249]) by mx.google.com with ESMTPS id k18-20020aa7c392000000b00559ba177b2bsi389885edq.61.2024.01.16.08.03.15 for <ouuuleilei@gmail.com> (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 16 Jan 2024 08:03:15 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-27553-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) client-ip=147.75.80.249; Authentication-Results: mx.google.com; spf=pass (google.com: domain of linux-kernel+bounces-27553-ouuuleilei=gmail.com@vger.kernel.org designates 147.75.80.249 as permitted sender) smtp.mailfrom="linux-kernel+bounces-27553-ouuuleilei=gmail.com@vger.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 am.mirrors.kernel.org (Postfix) with ESMTPS id 037CD1F2224B for <ouuuleilei@gmail.com>; Tue, 16 Jan 2024 16:03:15 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id 318C21C6BC; Tue, 16 Jan 2024 16:02:55 +0000 (UTC) Received: from mout.kundenserver.de (mout.kundenserver.de [212.227.126.133]) (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 DD7EC1C2AF; Tue, 16 Jan 2024 16:02:51 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=none (p=none dis=none) header.from=valentinobst.de Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=valentinobst.de Received: from localhost.localdomain ([217.245.156.100]) by mrelayeu.kundenserver.de (mreue011 [213.165.67.97]) with ESMTPSA (Nemesis) id 1MCbVD-1rGfMM1ilP-009kbA; Tue, 16 Jan 2024 17:02:37 +0100 From: Valentin Obst <kernel@valentinobst.de> To: Miguel Ojeda <ojeda@kernel.org>, Alex Gaynor <alex.gaynor@gmail.com>, Wedson Almeida Filho <wedsonaf@gmail.com> Cc: Boqun Feng <boqun.feng@gmail.com>, Gary Guo <gary@garyguo.net>, =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= <bjorn3_gh@protonmail.com>, Benno Lossin <benno.lossin@proton.me>, Andreas Hindborg <a.hindborg@samsung.com>, Alice Ryhl <aliceryhl@google.com>, rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, Valentin Obst <kernel@valentinobst.de> Subject: [PATCH 03/13] rust: ioctl: end top level module docs with full stop Date: Tue, 16 Jan 2024 17:01:28 +0100 Message-ID: <20240116160141.165951-4-kernel@valentinobst.de> X-Mailer: git-send-email 2.43.0 In-Reply-To: <20240116160141.165951-1-kernel@valentinobst.de> References: <20240116160141.165951-1-kernel@valentinobst.de> Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: <linux-kernel.vger.kernel.org> List-Subscribe: <mailto:linux-kernel+subscribe@vger.kernel.org> List-Unsubscribe: <mailto:linux-kernel+unsubscribe@vger.kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Provags-ID: V03:K1:Vl604ifirTqxSRb0VeZq6n9STXQC2equyytItghMfY5eTvyOnz2 uM88EOQgOFfBZV2pVFZWqVdFt2heBqC3+1onll4HVVvSWl0hq/Sgvj1co03zc4404udJ0XO V0lzfaOqs4OQtaSkc+RqPiTOq/er+938r++R2R/p3ctFexrPFTJyqXphq6FQdvSgGKW5J85 nUvnBocn8ivhaATyEjn9w== X-Spam-Flag: NO UI-OutboundReport: notjunk:1;M01:P0:M8ewJpf3SNc=;6DkxcoBATZk9fCkhsgRqI9hD4de 97eMdKprz8PDEy7+1kgGahldajB3zz0kBfU477TFKBiWASXN3YHIczg4ufCS90nUVkTjLDFKD oBaqBowC8P8vESRyK6+q3XF3xdhiqO7eb3X+tBFPsusH/cUzZbAdFYgeu5zUCpcK+bWcduSCQ Gq7FCJ5oLOa6/YNeXKLqKi9n+X49JDuQ2v00ISAqr76zEhJuhNmFqwGbiRI9eYYe0upLuUq4g 1PnlbtQFDQgj98grVp4pGExl+txnDyXCOtayxSmJqUQQas9HyASK0udF0rhKb7DYyEfG+u68j HZCkRXZMZBEL/610uLcZNDzqzRngKWRs1zRakzCaMEWGr9d73UKrWyW4x3qQk8/roAdyUDe6v 1eAv1y5ifzpxO6DjIDjbMWjzSMxT3FeNagV/rIlq7U+xTkEgerrDscSuGkYnnXILzv/8le9Rs tHoee+FN5oCr52YX726iYwTDtb/FUe6Lvarfbv+c+g62CozwGlQbsXWD3vnHjGNqgnJr7Vsvr TTBYhZJwOrex3TyrKrImIAgw8PJS/GTtEUgftDiYXV+/V8ejUj7/bEU4OppS0NKTGpjmrz1ow asiEX25v56sRgxvhcHxiydFfIZDtL3fRo5MQCkOw0I3K/FisbQoTb9GfNvLiEUhApz4viL0V/ xiQuqITQXfFExAhimf53hjod/OAqqk/uS0q/8yyPd6I6n/hXGczCxhk7tDd21faL9OfCHXys5 UneRJXfZs9Qam1u4exGbAWNutykFCEU75MOJviyc85JazhAG9s3hkX6BP9qhBhjzHY8+VSl3b QrgU5B4XQ4cicDDTyF09avY9zhTS9bxMei0LUKY4P/+o5zYQF90tZGVeqNZOb4tvR7IS0AcPo OelptaDa0dTRYsQ== X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1788263525521188466 X-GMAIL-MSGID: 1788263525521188466 |
Series |
rust: kernel: documentation improvements
|
|
Commit Message
Valentin Obst
Jan. 16, 2024, 4:01 p.m. UTC
Every other module ends its first line of documentation with a full
stop. Adapt the only outlier.
Signed-off-by: Valentin Obst <kernel@valentinobst.de>
---
rust/kernel/ioctl.rs | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
Comments
On Tue, Jan 16, 2024 at 11:05 AM Valentin Obst <kernel@valentinobstde> wrote: > > Every other module ends its first line of documentation with a full > stop. Adapt the only outlier. > > Signed-off-by: Valentin Obst <kernel@valentinobst.de> > --- > rust/kernel/ioctl.rs | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/rust/kernel/ioctl.rs b/rust/kernel/ioctl.rs > index 59050e5f5a5a..5987ad6d38a7 100644 > --- a/rust/kernel/ioctl.rs > +++ b/rust/kernel/ioctl.rs > @@ -1,6 +1,6 @@ > // SPDX-License-Identifier: GPL-2.0 > > -//! ioctl() number definitions > +//! ioctl() number definitions. Would you mind also adding backticks to `ioctl()` while you're here? - Trevor > //! > //! C header: [`include/asm-generic/ioctl.h`](srctree/include/asm-generic/ioctl.h) > > -- > 2.43.0 >
On Wed, Jan 17, 2024 at 7:32 PM Trevor Gross <tmgross@umich.edu> wrote: > > On Tue, Jan 16, 2024 at 11:05 AM Valentin Obst <kernel@valentinobst.de> wrote: > > > > Every other module ends its first line of documentation with a full > > stop. Adapt the only outlier. > > > > Signed-off-by: Valentin Obst <kernel@valentinobst.de> > > --- > > rust/kernel/ioctl.rs | 2 +- > > 1 file changed, 1 insertion(+), 1 deletion(-) > > > > diff --git a/rust/kernel/ioctl.rs b/rust/kernel/ioctl.rs > > index 59050e5f5a5a..5987ad6d38a7 100644 > > --- a/rust/kernel/ioctl.rs > > +++ b/rust/kernel/ioctl.rs > > @@ -1,6 +1,6 @@ > > // SPDX-License-Identifier: GPL-2.0 > > > > -//! ioctl() number definitions > > +//! ioctl() number definitions. > > Would you mind also adding backticks to `ioctl()` while you're here? > > - Trevor > > > //! > > //! C header: [`include/asm-generic/ioctl.h`](srctree/include/asm-generic/ioctl.h) > > > > -- > > 2.43.0 > > Nevermind, I see you got this in patch 8/13. Reviewed-by: Trevor Gross <tmgross@umich.edu>
diff --git a/rust/kernel/ioctl.rs b/rust/kernel/ioctl.rs index 59050e5f5a5a..5987ad6d38a7 100644 --- a/rust/kernel/ioctl.rs +++ b/rust/kernel/ioctl.rs @@ -1,6 +1,6 @@ // SPDX-License-Identifier: GPL-2.0 -//! ioctl() number definitions +//! ioctl() number definitions. //! //! C header: [`include/asm-generic/ioctl.h`](srctree/include/asm-generic/ioctl.h)