patches for DPDK stable branches
 help / color / mirror / Atom feed
From: Christian Ehrhardt <christian.ehrhardt@canonical.com>
To: dpdk stable <stable@dpdk.org>
Cc: Luca Boccassi <luca.boccassi@microsoft.com>,
	Kevin Traynor <ktraynor@redhat.com>,
	Christian Ehrhardt <christian.ehrhardt@canonical.com>
Subject: [dpdk-stable] [PATCH] README: 'validation' and 'known_issues' have to follow rst format
Date: Wed, 17 Mar 2021 16:56:33 +0100	[thread overview]
Message-ID: <20210317155632.3219855-1-christian.ehrhardt@canonical.com> (raw)

Signed-off-by: Christian Ehrhardt <christian.ehrhardt@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


             reply	other threads:[~2021-03-17 15:56 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-17 15:56 Christian Ehrhardt [this message]
2021-03-17 15:59 ` Luca Boccassi

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210317155632.3219855-1-christian.ehrhardt@canonical.com \
    --to=christian.ehrhardt@canonical.com \
    --cc=ktraynor@redhat.com \
    --cc=luca.boccassi@microsoft.com \
    --cc=stable@dpdk.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).