Re: [PATCH 4/4] doc: Migrate Process wiki page to sphinx

[Tom Rini <trini@konsulko.com>]

[-- Attachment #1: Type: text/plain, Size: 4518 bytes --]

On Fri, Jul 08, 2022 at 08:22:12AM +0100, Martin Bonner wrote:
> Martin
> 
> 
> On Fri, 8 Jul 2022 at 08:06, Claudius Heine <ch@denx.de> wrote:
> 
> > Hi Tom,
> >
> > On 2022-06-27 19:17, Tom Rini wrote:
> > > Move the current Process wiki page to doc/develop/process.rst.  The
> > > changes here are for formatting or slight rewording so that it reads
> > > well when linking to other sphinx documents.
> > >
> > > Signed-off-by: Tom Rini <trini@konsulko.com>
> > > ---
> > >   doc/develop/index.rst   |   1 +
> > >   doc/develop/process.rst | 182 ++++++++++++++++++++++++++++++++++++++++
> > >   2 files changed, 183 insertions(+)
> > >   create mode 100644 doc/develop/process.rst
> > >
> > > diff --git a/doc/develop/index.rst b/doc/develop/index.rst
> > > index c0f4f0ba413a..eab00a55382a 100644
> > > --- a/doc/develop/index.rst
> > > +++ b/doc/develop/index.rst
> > > @@ -11,6 +11,7 @@ General
> > >
> > >      codingstyle
> > >      designprinciples
> > > +   process
> > >
> > >   Implementation
> > >   --------------
> > > diff --git a/doc/develop/process.rst b/doc/develop/process.rst
> > > new file mode 100644
> > > index 000000000000..dd279fb9eff1
> > > --- /dev/null
> > > +++ b/doc/develop/process.rst
> > > @@ -0,0 +1,182 @@
> > > +.. SPDX-License-Identifier: GPL-2.0+:
> > > +
> > > +U-Boot Development Process
> > > +==========================
> > > +
> > > +Management Summary
> > > +------------------
> > > +
> > > +* Development happens in Release Cycles of 3 months.
> > > +* The first 2 weeks are called Merge Window, which is followed by a
> > > +  Stabilization Period.
> > > +* Patches with new code get only accepted while the Merge Window is
> > open.
> > > +* A patch that is generally in good shape and that was submitted while
> > the
> > > +  Merge Window was open is eligible to go into the upcoming release,
> > even if
> > > +  changes and resubmits are needed.
> > > +* During the Stabilization Period, only patches that contain bug fixes
> > get
> > > +  applied.
> > > +
> > > +Phases of the Development Process
> > > +---------------------------------
> > > +
> > > +U-Boot development takes place in `Release Cycles
> > > +<https://www.denx.de/wiki/U-Boot/ReleaseCycle>`_.  A Release Cycle
> > lasts
> > > +normally for three months.
> > > +
> > > +The first two weeks of each Release Cycle are called *Merge Window*.
> > > +
> > > +It is followed by a *Stabilization Period*.
> > > +
> > > +The end of a Release Cycle is marked by the release of a new U-Boot
> > version.
> > > +
> > > +Merge Window
> > > +------------
> > > +
> > > +The Merge Window is the period when new patches get submitted
> > > +(and hopefully accepted) for inclusion into U-Boot mainline.
> > > +
> > > +This is the only time when new code (like support for new processors or
> > new
> > > +boards, or other new features or reorganization of code) is accepted.
> > > +
> > > +Twilight Time
> > > +-------------
> > > +
> > > +Usually patches do not get accepted as they are - the peer review that
> > takes
> > > +place will usually require changes and resubmits of the patches before
> > they
> > > +are considered to be ripe for inclusion into mainline.
> > > +
> > > +Also, the review often happens not immediately after a patch was
> > submitted,
> > > +but only when somebody (usually the responsible custodian) finds time
> > to do
> > > +this.
> > > +
> > > +In the result, the final version of such patches gets submitted after
> > the
> >
> Should be: "The result is that the final version..." or "This can mean the
> final version..."
> 
> 
> > > +merge window has been closed.
> > > +
> > > +It is current practice in U-Boot that such patches are eligible to go
> > into the
> > > +upcoming release.
> > > +
> > > +In the result, the release of the ``"-rc1"`` version does not
> > immediately follow
> >
> Should be "The result is that the release..." or "Thus the release..."
> 
> The first of both my two choices is closer to the original wording, the
> second feels to me (as a British English speaker) to be more idiomatic.
> (Beware, idiomatic English is not necessarily good - not everyone here is a
> native speaker, and it can be overly complex.)

Thanks for the feedback.  I suspect that Wolfgang wrote these pages
initially.  I'll cc you both on patches to adjust the wording slightly.
I'm doing the read-aloud test on these sections now.

-- 
Tom

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 659 bytes --]