Re: [PATCH v6 18/23] docs: add Rust documentation

[Josh Triplett]

On Mon, May 09, 2022 at 08:14:54PM -0700, Gaelan Steele wrote:
> 
> 
> > On May 9, 2022, at 3:32 PM, Jonathan Corbet <corbet@xxxxxxx> wrote:
> > 
> >> +It is convenient to instruct editors/IDEs to format while typing,
> >> +when saving or at commit time. However, if for some reason reformatting
> >> +the entire kernel Rust sources is needed at some point, the following can be
> >> +run::
> >> +
> >> +	make LLVM=1 rustfmt
> > 
> > I will ask whether we want this, though. Why would anybody want to
> > mass-reformat the entire body of kernel code? This seems like something
> > that would generate an endless stream of "helpful" patches and a lot of
> > churn.
> 
> That would only happen if the code diverged from rustfmt’s output in the
> first place. Generally, in Rust projects, the source tree is always kept
> formatted with rustfmt - so running `make LLVM=1 rustfmt` would only
> ever touch code that you’d just changed. 

Exactly. This is convenient for the same reason doing a project-wide
`cargo fmt` is useful in Rust projects: you can do all your editing,
then format your code before committing.