From 894e2863919420a6f3e3ac55d14bc46b222de447 Mon Sep 17 00:00:00 2001 From: Eric Engestrom Date: Thu, 5 Mar 2020 20:23:07 +0100 Subject: [PATCH] docs: fix typos in the release docs Signed-off-by: Eric Engestrom Reviewed-by: Jordan Justen Reviewed-by: Andres Gomez Tested-by: Marge Bot Part-of: --- docs/releasing.html | 4 ++-- docs/submittingpatches.html | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/releasing.html b/docs/releasing.html index 15ec38a..2223472 100644 --- a/docs/releasing.html +++ b/docs/releasing.html @@ -381,7 +381,7 @@ git cherry-pick -x X.Y~1 git cherry-pick -x X.Y -

Then run the

./bin/post_verison.py X.Y.Z
, where X.Y.Z is the +

Then run the

./bin/post_version.py X.Y.Z
, where X.Y.Z is the version you just made. This will updated docs/relnotes.html, docs/index.html, and docs/release-calendar.html. It will then generate a git commit automatically. Check that everything looks correct and push: @@ -407,7 +407,7 @@ series, if that is the case.

Update gitlab issues

-Parse through the bugreports as listed in the docs/relnotes/X.Y.Z.html +Parse through the bug reports as listed in the docs/relnotes/X.Y.Z.html document. If there's outstanding action, close the bug referencing the commit ID which addresses the bug and mention the Mesa version that has the fix.

diff --git a/docs/submittingpatches.html b/docs/submittingpatches.html index 7378dda..0f8bcb3 100644 --- a/docs/submittingpatches.html +++ b/docs/submittingpatches.html @@ -146,7 +146,7 @@ to check for regressions.

-As mentioned at the begining, patches should be bisectable. +As mentioned at the beginning, patches should be bisectable. A good way to test this is to make use of the `git rebase` command, to run your tests on each commit. Assuming your branch is based off origin/master, you can run: @@ -279,12 +279,12 @@ release.

  • By adding the Cc: mesa-stable@ tag as described below.
  • By adding the fixes: tag as described below. -
  • By submitting a merge requestion against the "staging/year.quarter" branch on gitlab. +
  • By submitting a merge request against the "staging/year.quarter" branch on gitlab.

Please DO NOT send patches to -mesa-stable@lists.freedektop.org, it is not monitored actively and is a +mesa-stable@lists.freedesktop.org, it is not monitored actively and is a historical artifact.

@@ -305,13 +305,13 @@ you should add an appropriate note to the commit message.

Using a "fixes tag" as described in Patch formatting -is the prefered way to nominate a commit that you know ahead of time should be +is the preferred way to nominate a commit that you know ahead of time should be backported. There are scripts that will figure out which releases to apply the patch to automatically, so you don't need to figure it out.

-Alternatively, you maye use a "CC:" tag. +Alternatively, you may use a "CC:" tag. Here are some examples of such a note:

@@ -393,12 +393,12 @@ patch.

For patches that either need to be nominated after they've landed in master, or that are known ahead of time to not not apply cleanly to a stable branch (such -as due to a rename), using a gitlab MR is most appropirate. +as due to a rename), using a gitlab MR is most appropriate. The MR should be based on and target the staging/year.quarter branch, not on the year.quarter branch, per the stable branch policy. -Assinging the MR to release maintainer for said branch or mentioning them is +Assigning the MR to release maintainer for said branch or mentioning them is helpful, but not required.

-- 2.7.4