forked from OCR-D/olena
-
Notifications
You must be signed in to change notification settings - Fork 0
/
TODO
81 lines (54 loc) · 1.87 KB
/
TODO
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
See also the TODOs in oln-proto-1.0 and oln-proto-stl-style.
* Clean up
** Separate interface from implementation
Move the contents of each block surrounded by OLN_INCLUDE_ONLY into a
.hxx file. Don't forget to keep the #ifndef/#endif directives, and to
comment the closing #endif. Hence, this:
// ------------------------------------------------------------
// foo.hh
#ifndef FOO_HH
# define FOO_HH
// (Interface.)
# ifndef OLN_INCLUDE_ONLY
// (Implementation.)
# endif
#endif // ! FOO_HH
// ------------------------------------------------------------
should be turned into these:
// ------------------------------------------------------------
// foo.hh
#ifndef FOO_HH
# define FOO_HH
// (Interface.)
# ifndef OLN_INCLUDE_ONLY
# include <foo.hxx>
# endif
#endif // ! FOO_HH
// ------------------------------------------------------------
// ------------------------------------------------------------
// foo.hxx
#ifndef FOO_HXX
# define FOO_HXX
// (Implementation.)
#endif // ! FOO_HXX
// ------------------------------------------------------------
(BTW, I (Roland) think that OLN_INTERFACE_ONLY would be more
appropriate than OLN_INCLUDE_ONLY.)
** Check dates for every copyright header
Use the repository of Olena 0.11 (and previous) and Olena proto-1.0 to
find when files have been created and modified. This task could be a
part of the code review process.
* Release process
This is to be done later, before the release of the whole project or
of one or some of its components.
** Tests output
The tests should print nothing on the stantard output, nor on the
standard error.
** Add the UPGRADING file from Olena 0.11 and complete it
N.B.: This file is generated.
We might want to break the pseudo-compatibility with Olena 0.x, and
get rid of UPGRADING.
Local Variables:
mode: outline
ispell-local-dictionary: "american"
End: