[dpdk-stable] [PATCH 1/2] README: add some lessons learned from using the stable scripts

[Christian Ehrhardt]

Signed-off-by: Christian Ehrhardt <christian.ehrhardt at canonical.com>
---
 README | 19 ++++++++++++++++++-
 1 file changed, 18 insertions(+), 1 deletion(-)

diff --git a/README b/README
index 772382d..8a2ccea 100644
--- a/README
+++ b/README
@@ -1,12 +1,22 @@
 Here is a short description of the scripts I used for managing DPDK
 stable/LTS releases.
 
+It is expected to run these scripts from the directory of the stable-scripts
+repository. The settings in lib.sh will make it know about you (signature) and
+your directories holding the stable and dpdk git.
+So as the first step you should adapt the setting in lib.sh to your own needs.
+
+Note: often the same directory is used for stable and upstream dpdk trees with
+both remotes fully fetched.
+
 0-set-stable-release
 --------------------
 
 Set the current stable release you want to work on. With that, you
 don't need to provide the stable release info for following scripts.
 
+It will also create a local directory that will be used as tmp dir for
+the patches and mails.
 
 1-import
 --------
@@ -19,7 +29,8 @@ Where, the commit list should be provided from the "git-log-fixes.sh"
 script from DPDK. Assuming v17.11-rc1 is out and I then could prepare
 patches for v17.08.1 stable release, I normally do:
 
-    $ ./devtools/git-log-fixes v17.08..v17.11-rc1 > /tmp/list
+    $ ./devtools/git-log-fixes.sh v17.08..v17.11-rc1 > /tmp/list
+
 
 I then will check the generated list and edit it manually if necessary,
 say removing some false commits. Notably, they are:
@@ -34,6 +45,12 @@ say removing some false commits. Notably, they are:
   We probably need add an option for "gitl-log-fixes.sh" to let it do
   that automatically.
 
+Note: if this is the first time a particular release gets a stable branch
+XX.YY.1 then you'll need to check out a branch for it based on the release tag.
+For example for 18.05 you'd do like:
+  $ git checkout v18.05
+  # check this really is what you want to base on
+  $ git checkout -b 18.05
 
 2-send-notice
 -------------
-- 
2.17.1