From e142f4a11030643a78d6413d10f1c3e63faa1bba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?El=C5=91d=20Ill=C3=A9s?= Date: Thu, 4 Mar 2021 13:27:54 +0100 Subject: [PATCH] Update list_eol_stale_branches.sh documentation With the new option of the script (delete a branch) the documentation is updated to express this as well. Change-Id: I9445b4f8abff81c11a397a15a85cb1ffe1e5bfec --- doc/source/reference/using.rst | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/doc/source/reference/using.rst b/doc/source/reference/using.rst index 72e57a45c7..ee079d23e2 100644 --- a/doc/source/reference/using.rst +++ b/doc/source/reference/using.rst @@ -819,7 +819,8 @@ For more usage and examples: tools/list_eol_stale_branches.sh --------------------------------- -A script to detect deliverables who have eol stale branches in their repos. +A script to detect deliverables who have EOL stale branches and optionally +delete them. Example: @@ -827,11 +828,22 @@ Example: tools/list_eol_stale_branches.sh -The reason behind this tool is that since the extended maintenance model -have been introduced we stopped removing automatically EOL branches when a -deliverable become EOL, this tool aim to list projects that have been declared -EOL on a series that is EM and where the corresponding series branch -still exists. +Another example with predefining the gerrit user to be used for branch deletion: + +:: + + GERRIT_USER= tools/list_eol_stale_branches.sh + +The reason behind this tool is that since the Extended Maintenance model +have been introduced we stopped removing automatically End of Life (EOL) +branches. This tool aims to list projects with branches that have been +declared ``End of Life`` (that is, tagged with ``$series-eol``), but the +corresponding series branch still exists. The script also offers to delete +these stale branches. + +.. note:: + + Only release managers have the access rights to delete branches. tools/list_unbranched_projects.sh ---------------------------------