Re: [PATCH v1 1/2] PCI: Document patch submission hints

Bjorn Helgaas
2018-07-30T21:56:46Z

On Mon, Jul 30, 2018 at 04:31:36PM +0200, Lukas Wunner wrote:
> On Thu, Jul 12, 2018 at 10:59:46AM -0500, Bjorn Helgaas wrote:
> > But on reflection, I think the overall value of this writeup is
> > minimal. It's a lot of repetition of things already documented
> > elsewhere and most of it boils down to "pay attention to existing
> > practice and don't do things differently unless you're innovating and
> > adding value." That *should* be obvious, and if it's not, I doubt
> > that adding one more thing to read is going to make it more obvious.
>
> So my opinion is that your writeup does contain valid points that are
> worth documenting: For an open source project, a top priority is to
> attract and retain contributors who improve the bus factor, who keep
> the code base alive and maintained, thereby avoiding bit rot.
>
> Knowledge diffusion, including documentation of best practices and
> conventions, goes a long way towards that goal. Your writeup was
> mainly from a maintainer perspective: "consistency makes maintenance
> easier". But consistency is also valuable from a contributor
> perspective: It makes it easier to dive into a code base and find
> your way around, and that includes changelogs in the git history.
>
> There are important bits of knowledge in the writeup, if those can
> be distilled, the result would very much be valuable to have in the tree.
>
> Example:
>
> > I generally use
> > "PCI/XXX" for things in the core (mostly capabilities like MSI, AER,
> > DPC, etc) and "PCI: xxx:" for drivers (shpchp, pciehp, etc).
>
> That was in fact unknown to me.
>
> If you find it difficult to put yourself in the shoes of a contributor,
> I could try to rework the document and distill the points I find important.

I definitely want to make it easy and attractive for people to
contribute to Linux in general. I'd be glad for any hints. You're
right, it's hard for me to put myself in the shoes of a contributor,
at least a new one.

I guess I'm hesitant because a lot of the things I included there seem
like they border on the obsessive, and I don't want to ask
contributors to make trivial changes to fit in with my personal
quirks. Since they're my quirks, I'd rather just silently fix them up
as I apply patches.

If there were a wider consensus on some things and they could be
folded into Documentation/process/ somehow, that would be ideal, but
I'm not sure there would be enough of a consensus, and I don't really
want to start a big discussion about it. But maybe there are a few
things that wouldn't be controversial, I dunno.

Bjorn