linux-kernel - Re: [PATCH v2 2/2] gpu: nova-core: add initial documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CANiq72mxKhCudmRaS=gwnC=gjkCLMhZcC2ZpfzKKaGX1Hivz9g@mail.gmail.com>
Date: Wed, 5 Feb 2025 15:13:12 +0100
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Zhi Wang <zhiw@...dia.com>
Cc: Danilo Krummrich <dakr@...nel.org>, airlied@...il.com, simona@...ll.ch, corbet@....net, 
	maarten.lankhorst@...ux.intel.com, mripard@...nel.org, tzimmermann@...e.de, 
	ajanulgu@...hat.com, lyude@...hat.com, pstanner@...hat.com, cjia@...dia.com, 
	jhubbard@...dia.com, bskeggs@...dia.com, acurrid@...dia.com, ojeda@...nel.org, 
	alex.gaynor@...il.com, boqun.feng@...il.com, gary@...yguo.net, 
	bjorn3_gh@...tonmail.com, benno.lossin@...ton.me, a.hindborg@...nel.org, 
	aliceryhl@...gle.com, tmgross@...ch.edu, dri-devel@...ts.freedesktop.org, 
	linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org, 
	nouveau@...ts.freedesktop.org, rust-for-linux@...r.kernel.org
Subject: Re: [PATCH v2 2/2] gpu: nova-core: add initial documentation

On Wed, Feb 5, 2025 at 2:57 PM Zhi Wang <zhiw@...dia.com> wrote:
>
> It would be also helpful to make the process explicit. E.g. sharing your
> command lines used to checking the patches. So folks can align with the
> expected outcome, e.g. command line parameters.

These two guidelines (and generally the few others above) are intended
to apply to all Rust code in the kernel (i.e. not just `rust/`) --
their command lines are mentioned in `Documentation/rust/`. We could
add a note to make that clearer if that helps. So I would suggest
avoiding repetition here by referencing those.

We also mention it in our "Subsystem Profile document" at
https://rust-for-linux.com/contributing#submit-checklist-addendum.

> > +The availability of proper documentation is essential in terms of scalability,
> > +accessability for new contributors and maintainability of a project in general,

Typo: accessibility?

Cheers,
Miguel