From 64fb182cc926050c8ad58930b0bb22bb50d0c8c9 Mon Sep 17 00:00:00 2001
From: Thibault Martin <thi.martin.pro@pm.me>
Date: Tue, 14 May 2024 20:01:25 +0200
Subject: [PATCH] [doc] Use markdown code format when necessary
---
doc/release/validation.tex | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/doc/release/validation.tex b/doc/release/validation.tex
index 668193f2e5..da1623971c 100644
--- a/doc/release/validation.tex
+++ b/doc/release/validation.tex
@@ -195,8 +195,11 @@ expected format is:
# ...
\end{lstlisting}
-It should only list main changes, that will be displayed on the event section
-of the website and the wiki page.
+It should only list main changes, that will be displayed on the event section of
+the website and the wiki page. Make sure to use markdown code formating
+\verb+``+ if the texte contains things that could be affected by markdown
+formatting (for example \verb+\word1_word2+ will be displayed as
+\verb+word2+ without code formatting.
Create the version commit, tag it using \texttt{git tag \$(cat VERSION | sed -e "s/\textasciitilde /-/")}
and push it (e.g. via \texttt{git push origin \$(cat VERSION | sed -e "s/\textasciitilde/-/")}).
--
GitLab