From 44f6539e20c1b6df459598360884ae358414da2c Mon Sep 17 00:00:00 2001 From: Sean McGinnis Date: Thu, 27 Jun 2019 15:53:27 -0500 Subject: [PATCH] Update .gitreview wording in retire process We had a note in the repo retirement process regarding steps to take before removing the .gitreview file. Later we determined that it is best to keep that file in the repo rather than removing it, but the note mentioning its removal was kept after other wording updates noting it should stay. This removes the removal reference and updates the notes about keeping the file to attempt to make things more clear. Change-Id: Id4ee69de31569645c3486f7b8508db3d6e64da8f Signed-off-by: Sean McGinnis --- doc/source/drivers.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/doc/source/drivers.rst b/doc/source/drivers.rst index 8a246e9..ae9632d 100644 --- a/doc/source/drivers.rst +++ b/doc/source/drivers.rst @@ -399,7 +399,8 @@ Double check that all dot files (such as ``.gitignore`` and Removing the ``.gitreview`` file from the master branch of a repository breaks much of the release tools, so it will be harder - to continue to tag releases on existing stable branches. + to continue to tag releases on existing stable branches. Take care + to remove all files other than ``README.rst`` and ``.gitreview``. Replace the contents of the README with a message such as this:: @@ -420,11 +421,6 @@ Replace the contents of the README with a message such as this:: Merge this commit to your project. -.. note:: - - Before removing ``.gitreview`` be sure to run ``git review -s``, this - will record the necessary information about the repository. - If any users missed the announcement that the project is being retired, removing the content of the repository will cause any users who continuously deploy the software as well as users who track