On Fri, Apr 05, 2024 at 11:57:17AM +0200, Ilya Maximets wrote:
> On 4/2/24 16:44, Simon Horman wrote:
> > Recently OVS adopted a policy of using the inclusive naming word list v1
> > [1, 2].
> >
> > In keeping with this policy rename the primary development branch from
> > 'master' to 'main'. This patch does not actually make that change,
> > but rather updates references to the branch in the source tree.
> > It is intended to be applied at (approximately) the same time that the
> > change is made.
> >
> > OVS is currently hosted on GitHub. We can expect the following behaviour
> > after the rename:
> >
> > 1. GitHub pull requests against are renamed branch are automatically
> > re-homed on new branch
> > 2. GitHub Issues do not seem to be affected - at least the test issue I
> > created had no association with a branch
> > 3. URLs accessed via the GitHub web UI are automatically renamed
> > (so long as a new branch called master is not created).
> > 4. Using the git cli command, fetch will fetch the new branch (main),
> > and fetch -p will remove (prune) the old branch (master)
> >
> > [1] df5e5cf4318a ("Documentation: Add section on inclusive language.")
> > [2] https://inclusivenaming.org/word-lists/
> >
> > Signed-off-by: Simon Horman <[email protected]>
> > ---
> > Changes in v2:
> > - Keep two blank lines between versions.
> > - Drop bogus update to OpenSSL hashes URL in appveyor.yml.
> > - Drop other appveyor.yml changes, they are now present upstream.
> > + appveyor: Prepare for rename of primary development branch.
> > https://github.com/openvswitch/ovs/commit/95ff912edef8
>
> We still need to remove the 'master' branch from the appveyor.yml
> at some point and we also need to remove the 'master' branch
> lookup from build-clang-analyze GHA job.
>
> Or do you plan to send a separate patch for those?
For some reason I had it in mind to send a separate patch
for that after the rename. But I don't feel strongly about it.
> If we're not touching CI configuration in this patch it may also
> be appropriate to have 'Documentation: ' prefix in the subject.
Good point, will do.
> > - Add note about updates to git configuration.
> > ---
> > Notes:
> >
> > * Now is the time to raise any concerns regarding this patch.
> > It is planned to implement this change next week.
> >
> > * If you have an automation that fetches the master branch then
> > the suggested action is:
> > 1. Before the branch rename occurs: update the automation to pull main an
> > fall back to pulling master if that fails
> > 2. After the rename occurs: Update the automation to only fetch main
> >
> > * After the change it may be necessary to update your local
> > git configuration for checked out branches.
> >
> > For example:
> > # Fetch origin: new remote main branch; remote master branch is deleted
> > git fetch -tp origin
> > # Rename local branch
> > git branch -m master main
> > # Update local main branch to use remote main branch as it's upstream
> > git branch --set-upstream-to=origin/main main
> > ---
> > .../internals/committer-responsibilities.rst | 12 +++---
> > .../internals/contributing/backporting-patches.rst | 12 +++---
> > Documentation/internals/release-process.rst | 50
> > +++++++++++-----------
> > Documentation/intro/install/dpdk.rst | 2 +-
> > Documentation/intro/install/fedora.rst | 2 +-
> > Documentation/intro/install/general.rst | 2 +-
> > Documentation/intro/install/rhel.rst | 2 +-
> > Documentation/topics/language-bindings.rst | 2 +-
> > Documentation/tutorials/faucet.rst | 6 +--
> > Documentation/tutorials/ovs-conntrack.rst | 2 +-
> > NEWS | 3 ++
> > README.rst | 2 +-
> > 12 files changed, 50 insertions(+), 47 deletions(-)
> >
>
> <snip>
>
> > diff --git a/Documentation/tutorials/ovs-conntrack.rst
> > b/Documentation/tutorials/ovs-conntrack.rst
> > index e8a58c4eb298..6b0b73cd1173 100644
> > --- a/Documentation/tutorials/ovs-conntrack.rst
> > +++ b/Documentation/tutorials/ovs-conntrack.rst
> > @@ -35,7 +35,7 @@ to match on the TCP segments from connection setup to
> > connection tear down.
> > It will use OVS with the Linux kernel module as the datapath for this
> > tutorial. (The datapath that utilizes the openvswitch kernel module to do
> > the packet processing in the Linux kernel)
> > -It was tested with the "master" branch of Open vSwitch.
> > +It was tested with the "main" branch of Open vSwitch.
>
> Nit: This sentence doesn't make a lot of sense to me. It may have been
> meaningful at the point of introduction of that doc, but not today.
> Maybe we can just remove it?
Sure, I will remove it.
> > Definitions
> > -----------
> > diff --git a/NEWS b/NEWS
> > index c9e4064e67a7..5c9fff54595c 100644
> > --- a/NEWS
> > +++ b/NEWS
> > @@ -4,6 +4,9 @@ Post-v3.3.0
> > * Conntrack now supports 'random' flag for selecting ports in a range
> > while natting and 'persistent' flag for selection of the IP address
> > from a range.
> > + - The primary development branch has been renamed from 'master' to
> > 'main'.
> > + The OVS tree remains hosted on GitHub.
> > + https://github.com/openvswitch/ovs.git
>
> We use 3 spaces for the first level of indentation in the NEWS file.
> I don't know why... I suppose it was an accident in the notes for v2.1.0,
> where indentation went from 4 to 3 spaces. But we used it ever since
> and it's better to keep the doc uniform.
Thanks, will fix.
_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev
