From a1098b88e289c466fdcb832029c4ad83f7e1f9b4 Mon Sep 17 00:00:00 2001 From: Virgile Prevosto <virgile.prevosto@m4x.org> Date: Tue, 12 May 2020 16:58:31 +0200 Subject: [PATCH] [release] small updates to release manual --- doc/release/branch.tex | 10 +++++----- doc/release/build.tex | 12 +++++++++++- doc/release/intro.tex | 2 +- 3 files changed, 17 insertions(+), 7 deletions(-) diff --git a/doc/release/branch.tex b/doc/release/branch.tex index ac7bb4a8631..5ee6c9b56ce 100644 --- a/doc/release/branch.tex +++ b/doc/release/branch.tex @@ -16,8 +16,8 @@ $\rightarrow$ Repository $\rightarrow$ Protected Branches. \textbf{The \texttt{master} branch must be protected \emph{at all times}. Parameters \texttt{Allowed to merge} and \texttt{Allowed to push} must be set to - \texttt{Developers + Masters} during non-freeze times, and to - \texttt{Masters} during freeze time.} + \texttt{Developers + Maintainers} during non-freeze times, and to + \texttt{Maintainers} during freeze time.} \section{Creating the branch} @@ -41,14 +41,14 @@ These branches are directly created on the gitlab server. \end{enumerate} What can be committed in this branch must follow the release schedule, and go through Merge-requests. Everything else should go in \texttt{master}, -which can then be reset to standard-level protection (Developers + Masters +which can then be reset to standard-level protection (Developers + Maintainers allowed to push/merge). \section{Creating the milestones} Create the milestones for the next release on \textsf{Mantis} -\expertise{Julien, Boris} and \textsf{Gitlab} -\expertise{François, Julien, Boris} +\expertise{Julien} and \textsf{Gitlab} +\expertise{François, Julien} \section{BTS} diff --git a/doc/release/build.tex b/doc/release/build.tex index 4817577339a..2cddd5b7e45 100644 --- a/doc/release/build.tex +++ b/doc/release/build.tex @@ -2,6 +2,16 @@ The procedure for creating the source distribution. +\section{Prerequisites} + +\begin{itemize} +\item All tools needed to compile Frama-C (that you should have anyways) +\item \texttt{bash} v4.0 or higher +\item \texttt{git-lfs} +\item GNU \texttt{parallel} +\item a \TeX distribution +\end{itemize} + \section{Final checks} \begin{itemize} @@ -137,7 +147,7 @@ manuals. %\texttt{install} target below). Run the script \texttt{doc/build-manuals.sh} to compile and install all manuals, -even for E-ACSL. +even for E-ACSL. Note that this script requires \texttt{GNU parallel}. Otherwise, if you want to do it \textbf{manually}, in each directory: \begin{shell} diff --git a/doc/release/intro.tex b/doc/release/intro.tex index b2b314ea2a4..f3d47d4b1fd 100644 --- a/doc/release/intro.tex +++ b/doc/release/intro.tex @@ -21,7 +21,7 @@ roles, and we must distinguish between: %% of the release for a specific architecture \expertise{none currently}. \item[Web Site Maintainers:] they are responsible for updating the web site, during the release and for possible later updates \expertise{Florent}. -\item[Release Manager:] he is responsible for the organisation of the +\item[Release Manager:] they are responsible for the organisation of the release process \end{description} -- GitLab