From b9defb2dde9ef33b4bb51e9b9295d5f500f5e132 Mon Sep 17 00:00:00 2001
From: Arthur VUAGNIAUX <arthur.vuagniaux@telecom-paristech.fr>
Date: Mon, 24 Sep 2018 10:16:36 +0200
Subject: [PATCH] Issue #115: Update part 3: Development with Text Editor
---
.../ttool_development_infrastructure.tex | 11 +++++------
1 file changed, 5 insertions(+), 6 deletions(-)
diff --git a/doc/dev_infrastructure/ttool_development_infrastructure.tex b/doc/dev_infrastructure/ttool_development_infrastructure.tex
index a195caacd0..fa83d5184f 100644
--- a/doc/dev_infrastructure/ttool_development_infrastructure.tex
+++ b/doc/dev_infrastructure/ttool_development_infrastructure.tex
@@ -202,14 +202,14 @@ commit messages. \\
\section{Development with Text Editor (emacs, vim) and Make}
-The text editor of your choice can be used to edit the files of TTool. Yet, you must be sure that the correct indentation is respected. Use \textbf{4 spaces for each indentation level}.\\
+The text editor of your choice can be used to edit the files of TTool. Yet, you must be sure that the correct indentation is respected. Use \textbf{4 spaces for each indentation level} and refer yourself to the \textbf{Coding Instruction} (\ref{sec:code_info}) .\\
Also, don't forget to insert your name at the top of the file in the authors list.\\
The main Makefile can be used to compile the source files of TTool, and to generate the jar libraries in bin/.
To compile TTool, do as follows, from the top directory of TTool:
\begin{verbatim}
-42sh$ make 1ttool
+42sh$ make ttool
\end{verbatim}
Other compilation targets can be obtained with:
@@ -222,12 +222,11 @@ or:
\end{verbatim}
In particular, compiling the sources of all subprojects can be done with the
\textit{all} target:
- \begin{verbatim}
+\begin{verbatim}
42sh$ make all
\end{verbatim}
-
\section{Development with Eclipse}
Eclipse is a well-known Integrated Development Environment (IDE) providing many advanced functionalities to support developers and improve code quality by the application of built-in on the fly code analyses. One advantage of Eclipse is that it is a multi-platform application so it can be used on Linux, Windows and Mac. The procedures described in this section are valid for all platforms although some elements such as C++ projects need to be different due to different platform-specific compilation tool chains to be used. More information on this is provided on the concerned subsections. \\
@@ -235,7 +234,7 @@ Eclipse is a well-known Integrated Development Environment (IDE) providing many
\subsection{Installing and Configuring Eclipse}
Download Eclipse IDE for Java developers here: \\
-\url{http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/neon2}
+\url{http://www.eclipse.org/downloads/packages/release/photon/r/eclipse-ide-java-developers}
\\
Unzip the package and launch the eclipse executable. For developing C++
@@ -599,7 +598,7 @@ commands.
Here are gathered all tricks on how TTool source codes are organized, and what function is coded where, and also how to extend TTool, e.g. adding a new diagram.
\subsection{Coding Instructions}
-
+\label{sec:code_info}
\subsubsection{Best practices}
TTool is a constantly evolving project with more or less experimental parts. As
--
GitLab