[dpdk-stable] [PATCH] README: 'validation' and 'known_issues' have to follow rst format

Christian Ehrhardt christian.ehrhardt at canonical.com
Wed Mar 17 16:56:33 CET 2021


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

diff --git a/README b/README
index 9d90e58..70f4320 100644
--- a/README
+++ b/README
@@ -171,6 +171,11 @@ does:
 - update the release note with skipped patches from the 'failed_list' file
 - commit above changes with a short commit log ("release $stable_release")
 
+* Be careful, the files 'validation' and 'known_issues' will be inserted
+  into the .rst based release notes and therefore have to follow that format
+  in regard to indents and such.
+  It is recommended to once build docs locally (e.g. just call `make doc`)
+  before you push the tag as that will run on the server.
 
 5.5 push & change dpdk-web
 
-- 
2.30.0



More information about the stable mailing list