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;
MIME-Version: 1.0
References: <20210414184604.23473-1-ojeda@kernel.org> <fae4873e-2ff9-df35-0ab9-34bf4417b717@schinagl.nl>
In-Reply-To: <fae4873e-2ff9-df35-0ab9-34bf4417b717@schinagl.nl>
From:   Miguel Ojeda <miguel.ojeda.sandonis@gmail.com>
Date:   Mon, 27 Jun 2022 19:44:13 +0200
Message-ID: <CANiq72mRxM-7griYF+0FWqYoSoNL8ad=L-i6a2-GsaCeb0C6qQ@mail.gmail.com>
Subject: Re: [PATCH 00/13] [RFC] Rust support
To:     oliver+list@schinagl.nl
Cc:     Miguel Ojeda <ojeda@kernel.org>,
        Linus Torvalds <torvalds@linux-foundation.org>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        rust-for-linux <rust-for-linux@vger.kernel.org>,
        Linux Kbuild mailing list <linux-kbuild@vger.kernel.org>,
        Linux Doc Mailing List <linux-doc@vger.kernel.org>,
        linux-kernel <linux-kernel@vger.kernel.org>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

Hi Olliver,

On Mon, Jun 20, 2022 at 5:11 PM Olliver Schinagl <oliver@schinagl.nl> wrote:
>
> I apologize for being late to the party and for potentially using the
> wrong thread, but I recall somewhere in v5 that it was best to respond
> to the RFC for general comments.

No need to apologize! Feel free to use the latest threads or a new
thread in e.g. the rust-for-linux ML.

> On 14-04-2021 20:45, ojeda@kernel.org wrote:
> > From: Miguel Ojeda <ojeda@kernel.org>
> >
> > Moreover, as explained above, we are taking the chance to enforce
> > some documentation guidelines. We are also enforcing automatic code
> > formatting, a set of Clippy lints, etc. We decided to go with Rust's
> > idiomatic style, i.e. keeping `rustfmt` defaults. For instance, this
> > means 4 spaces are used for indentation, rather than a tab. We are
> > happy to change that if needed -- we think what is important is
> > keeping the formatting automated
>
> Enforcing this is great, but how will you enforce this 'everywhere'?
> Right now, you can easily 'bypass' any CI put in place, and while 'for
> now' this is only about the Rust infra, where this can be strongly
> enforced, once we see actual drivers pop-up; these won't go through the
> Rust CI before merging CI forever? A maintainer can 'just merge'
> something still, right?

Indeed, but there are workarounds, for instance, we could have a bot
checking -next.

Or we could put it in an opt-in compilation mode (i.e. not for users)
where extra things are checked (like `W=`) that maintainers use so
that e.g. `allmodconfig` builds are kept clean.

> Anyway, what I wanted to criticize, is the so called "keeping with
> `rustfmt` defaults". It has been known, that, well Rust's defaults are
> pretty biased and opinionated. For the Rust project, that's fair of
> course, their code, their rules.
>
> However, there's two arguments against that. For one, using the Rust
> 'style', now means there's 2 different code styles in the Kernel.
> Cognitively alone, that can be quite frustrating and annoying. Having to
> go back and forth between two styles can be mentally challenging which
> only causes mistakes and frustration. So why change something that
> already exists? Also, see my first point. Having to constantly
> remember/switch to 'in this file/function the curly brace is on a
> different line'. Lets try to stay consistent, the rules may not be
> perfect (80 columns ;), but so far consistency is tried. OCD and Autism
> etc doesn't help with this ;)

Note that the point of using `rustfmt` is that one does not need to
care about the details -- one can e.g. run the tool on file save. So
no need to remember how to do it when writing Rust.

Now, it is true that the Rust syntax resembles C in many cases, so
things like the curly braces for function definitions are similar
enough that we could do the same thing in both sides.

However, most Rust code uses `rustfmt` and typically also follow most
of its defaults, including the standard library, books, etc.; which
helps when reading and reusing other code. This is different from C
and C++, where as you know there is no single style (at least as
prevalent as `rustfmt`), thus one needs to become accustomed to each
project's C style (or ideally use `clang-format` to avoid having to
learn it). So while this is not relevant for C, in the case of Rust,
there is value in using the `rustfmt` style.

As for consistency, one could argue that by using `rustfmt` we are
being consistent with the rest of the Rust code out there. This may be
important for those that have expressed interest on sharing some code
between kernel and userspace; as well as if we end up vendoring some
external crates (similar to what we do with `alloc` now).

> Secondly, and this is really far more important, the Rust default style
> is not very inclusive, as it makes readability harder. This has been
> brought up by many others in plenty of places, including the `rustfmt`
> issue tracker under bug #4067 [0]. While the discussion eventually only
> led to the 'fmt-rfcs' [1], where it was basically said 'you could be on
> to something, but this ship has sailed 3 years ago (when nobody was
> looking caring), and while we hear you, we're not going to change our
> defaults anymore.
>
> But I also agree and share these commenters pain. When the tab character
> is used for indenting (and not alignment mind you), then visually
> impaired (who can still be amazing coders) can more easily read code by
> adjusting the width what works best to them.
>
> With even git renaming `master` to `main` to be more inclusive, can we
> also be more inclusive to us that have a hard time distinguishing narrow
> indentations?

As noted in the RFC, we are happy to tweak the style to whatever
kernel developers prefer. We think the particular style is not that
important. Absent other reasons, the defaults seem OK, so we chose
that for simplicity and consistency with as most existing Rust code as
possible.

As for accessibility, I am no expert, so that may be a good point,
especially if editors cannot solve this on their end (so that everyone
could program in all languages/projects regardless of style).

> Thanks, and sorry for rubbing any ones nerves, but to "some of us" this
> actually matters a great deal.

No nerves were damaged :) Thanks for all the input!

> P.S. would we expect inline C/Rust code mixed? What then?

Everything is possible, e.g. we could have Rust proc macros that parse
C and things like that. But if we ended up with such a thing, the
solution would be to format each accordingly to its style (indentation
could be an exception, I guess).

Cheers,
Miguel