doc: Add a quick example on how to use release_notes.py

Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>

diff --git a/doc/developer/frr-release-procedure.rst b/doc/developer/frr-release-procedure.rst
index 9378637dedb460cec559df96f5350c2e9a7e88f2..9dbc9b48d7496deb887814591802ac621f41bac5 100644 (file)
--- a/doc/developer/frr-release-procedure.rst
+++ b/doc/developer/frr-release-procedure.rst
@@ -13,6 +13,13 @@ Stage 1 - Preparation
 
    Note: use ``tools/release_notes.py`` to help draft release notes changelog
 
+   .. code-block:: console
+
+      ./tools/release_notes.py -b dev/9.1 -t frr-9.0.1
+
+   dev/9.1 is the branch to be renamed to stable/9.1, and frr-9.0.1 in this
+   example is the latest tag from which to generate the logs.
+
 #. Checkout the existing ``dev/<version>`` branch.
 
    .. code-block:: console