From a7d99d294107a55fb958c0cadc1a23dfc2316b02 Mon Sep 17 00:00:00 2001
From: Allan Blanchard <allan.blanchard@cea.fr>
Date: Mon, 7 Dec 2020 16:51:28 +0100
Subject: [PATCH] [doc] A few typos in the release manual
---
doc/release/branch.tex | 4 ++--
doc/release/build.tex | 4 +++-
doc/release/website.tex | 32 ++++++++++++++++----------------
3 files changed, 21 insertions(+), 19 deletions(-)
diff --git a/doc/release/branch.tex b/doc/release/branch.tex
index 5f5a9c22351..ca2cb8d1c8e 100644
--- a/doc/release/branch.tex
+++ b/doc/release/branch.tex
@@ -21,7 +21,7 @@ $\rightarrow$ Repository $\rightarrow$ Protected Branches.
\section{Creating the branch}
-Note that ou must be member of the groups "frama-c", "dev" and have
+Note that you must be member of the GitLab groups "frama-c", "dev" and have
access to each plugin of continuous integration.
Create the branch \texttt{stable/release}, where \texttt{release} is the
@@ -67,7 +67,7 @@ the issues should be tagged with the current release, or with the next one.
Create headers in the Changelog(s). This is to avoid some merge conflicts,
but also so that merge requests add information in the proper part of
-the Changelog.
+the Changelog.
\begin{itemize}
\item Add the following in the Changelog, in \texttt{stable/element}
diff --git a/doc/release/build.tex b/doc/release/build.tex
index c1a0c6cea70..e3c9386b25c 100644
--- a/doc/release/build.tex
+++ b/doc/release/build.tex
@@ -7,9 +7,11 @@ The procedure for creating the source distribution.
\begin{itemize}
\item All tools needed to compile Frama-C (that you should have anyways)
\item \texttt{bash} v4.0 or higher
+\item \texttt{rgrep}
\item \texttt{git-lfs}
\item GNU \texttt{parallel}
\item a \TeX distribution
+\item (recommended) \texttt{texfot}
\end{itemize}
\section{Final checks}
@@ -283,7 +285,7 @@ The performed sanity checks are:
\begin{itemize}
\item verification that no non-free files are distributed,
\item verification that no non-free plugins are distributed,
- \item no \texttt{/home/user} path can be found is the distribution,
+ \item no \texttt{/home/user} path can be found in the distribution,
\item the source code can be compiled and tests succeed.
\end{itemize}
diff --git a/doc/release/website.tex b/doc/release/website.tex
index 2f94f3ccb61..6e6b79dc3ae 100644
--- a/doc/release/website.tex
+++ b/doc/release/website.tex
@@ -13,12 +13,12 @@ the website.
\section{Generate website}
-Before pushing the branch to the websit, it can be deployed locally but
+Before pushing the branch to the website, it can be deployed locally but
this is not absolutely necessary.
Push the branch generated by the release script on the website repository.
-You can have a look to the generated pages on \texttt{pub.frama-c.com}.
+You can have a look at the generated pages on \texttt{pub.frama-c.com}.
Note however that the download links won't work as they are available only
once the branch is merged (\texttt{download} links are handled by Git-LFS).
@@ -42,24 +42,24 @@ Check the following pages:
\item \texttt{rss.xml}: check last event
\end{itemize}
-On GitLab, the following files must appear as \textbf{new} in \texttt{download}
-note that for beta versions, if you have not included all manuals, not all of
+On GitLab, the following files must appear as \textbf{new} in \texttt{download}.
+Note that for beta versions, if you have not included all manuals, not all of
them will appear:
\begin{itemize}
\item \texttt{acsl-X.XX.pdf}
- \item \texttt{acsl-implementation-NN.N-VERSION.pdf}
- \item \texttt{plugin-development-guide-NN.N-VERSION.pdf}
- \item \texttt{user-manual-NN.N-VERSION.pdf}
- \item \texttt{<plugin>-manual-NN.N-VERSION.pdf}\\
+ \item \texttt{acsl-implementation-NN.N-CODENAME.pdf}
+ \item \texttt{plugin-development-guide-NN.N-CODENAME.pdf}
+ \item \texttt{user-manual-NN.N-CODENAME.pdf}
+ \item \texttt{<plugin>-manual-NN.N-CODENAME.pdf}\\
for Aorai, EVA, Metrics, RTE and WP
\item \texttt{e-acsl/e-acsl-X.XX.pdf}
- \item \texttt{e-acsl/e-acsl-implementation-NN.N-VERSION.pdf}
- \item \texttt{e-acsl/e-acsl-manual-NN.N-VERSION.pdf}
- \item \texttt{aorai-example-NN.N-VERSION.tgz}
- \item \texttt{frama-c-NN.N-VERSION.tar.gz}
- \item \texttt{frama-c-api-NN.N-VERSION.tar.gz}
- \item \texttt{hello-NN.N-VERSION.tar.gz}
+ \item \texttt{e-acsl/e-acsl-implementation-NN.N-CODENAME.pdf}
+ \item \texttt{e-acsl/e-acsl-manual-NN.N-CODENAME.pdf}
+ \item \texttt{aorai-example-NN.N-CODENAME.tgz}
+ \item \texttt{frama-c-NN.N-CODENAME.tar.gz}
+ \item \texttt{frama-c-api-NN.N-CODENAME.tar.gz}
+ \item \texttt{hello-NN.N-CODENAME.tar.gz}
\end{itemize}
For final release \textbf{ONLY}, the following files must appear as \textbf{modified} in \texttt{download}:
@@ -141,8 +141,8 @@ You should also push the wiki changes. Note that all files listed as \textbf{new
in the website section should appear in the wiki but:
\begin{itemize}
- \item \texttt{frama-c-api-NN.N-VERSION.tar.gz}
- \item \texttt{hello-NN.N-VERSION.tar.gz}
+ \item \texttt{frama-c-api-NN.N-CODENAME.tar.gz}
+ \item \texttt{hello-NN.N-CODENAME.tar.gz}
\end{itemize}
and E-ACSL files are not in a sub-folder \texttt{e-acsl} on the wiki.
--
GitLab