28 Feb
2013
28 Feb
'13
12:22 p.m.
(CC to Christophe Ecobar, as this message contains general information
useful to all Olena beginners.)
On 13/02/2013 10:44, Anthony Seure wrote:
---
.../examples/split/tuto3_first_routine-1.cc.raw | 1 -
milena/doc/examples/tuto3/first_routine.cc | 1 -
milena/doc/tutorial.tex | 66 ++++++++++++++++---
3 files changed, 55 insertions(+), 13 deletions(-)
First of all, do not forget to add ChangeLog entries to you patches.
See one of my patches to see what format is expected, e.g. commit
f782485fde :
== milena/ChangeLog ========================================
2013-02-06 Roland Levillain <roland(a)lrde.epita.fr>
Address errors reported by clang++ in Scribo.
* scribo/io/text_boxes/save.hh,
* scribo/primitive/extract/components.hh,
* scribo/primitive/link/with_single_right_link.hh,
* scribo/text/recognition.hh,
* scribo/toolchain/content_in_doc.hh,
* scribo/toolchain/content_in_hdoc.hh,
* scribo/toolchain/text_in_doc.hh,
* scribo/toolchain/text_in_doc_preprocess.hh,
* scribo/toolchain/text_in_picture.hh:
Do not provide default arguments twice.
======================================== milena/ChangeLog ==
The commit message corresponding to this patch should use the same
contents as the ChangeLog entry, except the first two lines and the
leading tabulation character in front of the commit's title :
== commit message ==========================================
Address errors reported by clang++ in Scribo.
* scribo/io/text_boxes/save.hh,
* scribo/primitive/extract/components.hh,
* scribo/primitive/link/with_single_right_link.hh,
* scribo/text/recognition.hh,
* scribo/toolchain/content_in_doc.hh,
* scribo/toolchain/content_in_hdoc.hh,
* scribo/toolchain/text_in_doc.hh,
* scribo/toolchain/text_in_doc_preprocess.hh,
* scribo/toolchain/text_in_picture.hh:
Do not provide default arguments twice
========================================== commit message ==
A few hints about ChangeLog entries:
- use the infinitive tense ;
- try to group files when mentioning a common change ;
- wite changes in the right ChangeLog (Olena has several ChangeLogs for
its subprojects : ChangeLog, milena/ChangeLog, scribo/ChangeLog, etc.);
- write file paths relative to the location of the ChangeLog (e.g. strip
`milena/' from file paths mentioned in `milena/ChangeLog/);
- if a change require long explanations, it's probably better to write
them as comments in the code, and summarize them in ChangeLog.
There are instructions about ChangeLogs in the LRDE guidelines (see
https://www.lrde.epita.fr/dload/guide/guide.html#htoc94), though some of
them are a bit outdated. We'll update them ASAP.
Note that after the Olena 2.1 release, we won't write ChangeLog entries
anymore *but* we'll stick to the same format for commit messages. This
way we'll be able to generate ChangeLog entries from commit messages
before releasing the project.
[...]
diff --git a/milena/doc/tutorial.tex
b/milena/doc/tutorial.tex
index 8fee888..d975de4 100644
--- a/milena/doc/tutorial.tex
+++ b/milena/doc/tutorial.tex
@@ -159,7 +159,8 @@ The latter may also be interested by the Developer HTML
documentation
There are two ways of getting Milena on the web:
\begin{itemize}
\item Download a tarball/package from the website,
- \item Checkout the SVN repository.
+ \item Checkout the SVN repository,
We no longer maintain the Subversion repository, so you can kill this line.
@@ -188,6 +189,49 @@ We strongly advise you to not use
it for production use.
%download page.
%--------------------------
+\doxysubsection{tuto1dowloadinggit}{Downloading from Git}
+
+First, be sure that Git is already installed on your system.
+Open a terminal and type:
+
+\begin{verbatim}
+$ git --version
+git version 1.7.10.4
+\end{verbatim}
+
+You should see your version of Git installed. If you read 'Command not found'
+then you need to install Git.
+
+To install Git on Debin or Ubuntu, run:
Debian
+\begin{verbatim}
+$ sudo apt-get install git
+\end{verbatim}
+
+For other distributions, please refer to the user documentation of your system.
+
+Once you have Git installed, go to the directoy where you would like to download
directory
+Olena and then, clone the repository with the
following command:
+
+\begin{verbatim}
+$ git clone git@git.lrde.epita.fr:olena
+\end{verbatim}
This is not the right URL for external users. The correct URL (as seen
in https://olena.lrde.epita.fr/cgi-bin/twiki/view/Olena/Download) is
git://git.lrde.epita.fr/olena (read-only Git protocol access).
[...]
@@ -1070,10 +1114,10 @@ This trace allows to follow
the stack trace at runtime. It also provides the
time passed in each function call if the call last at least 10ms.
In order to enable traces in a program, set the related global variable to
-true:
+false:
\begin{verbatim}
...
-trace::quiet = true;
+trace::quiet = false;
...
\end{verbatim}
Thanks!
[...]
@@ -1116,7 +1160,7 @@ Milena also provides a lot of
debug tools. Here is a small list of the tools:
\doxymoutput[1]{tuto3_println}
\item mln::debug::println\_with\_border, print an image in the console withs
with
- its border.
+ its border (3 by default).
\doxycode[2]{tuto3_println}
\doxymoutput[2]{tuto3_println}
@@ -1214,16 +1258,16 @@ This box is defined from \val{(0,0)} to \val{(4,4)} :
A box can also starts from a site different from \val{(0,0)}.
-\doxycode[4]{tuto4_site_set_create}
+\doxycode[5]{tuto4_site_set_create}
-This box is defined from \val{(0,0)} to \val{(4,4)} :
+This box is defined from \val{(-2,-2)} to \val{(2,2)} :
\doxymoutput[3]{tuto4_site_set_create}
Another common site set is \type{p\_array}. It contains only sites which have been added
to it.
-\doxycode[2]{tuto4_site_set_create}
+\doxycode[3]{tuto4_site_set_create}
This site only contains :
@@ -1471,7 +1515,7 @@ is a workaround to make it read-write.
\begin{center}
\begin{tabular}{c c c}
\doxyimg{small-enlarged}{3cm} & ~\huge{$\rightarrow$}~ &
\doxyfigure[1]{tuto4_genericity_and_algorithms}{3cm} \\
- \multicolumn{3}{c}{Fill with blue a region of interest defined by a
+ \multicolumn{3}{c}{Fill with green a region of interest defined by a
\type{box2d}.} \\
\end{tabular}
\end{center}
Thanks for these changes. Do not forget to spell-check your
modifications when you're working on the documentation (e.g. using ``M-x
ispell'' in Emacs).
To correct a patch (e.g. to add a ChangeLog entry), please use `git
rebase --interactive'. If you are not familiar with this command, tell
me and I'll show you how to use it.