summaryrefslogtreecommitdiff
path: root/fml/doc/en/tutorial/internals/design.sgml
blob: dd9c55f4d4c04126132162c503e74327341a1209 (plain)
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
<!--
   $FML: design.sgml,v 1.1 2005/07/28 13:27:47 fukachan Exp $
-->


<chapter id="design">
	<title>
	[LOG] Original Idea Of &fml8; Project
	</title>


<!-- ========================================================
		section 1
     ========================================================
-->

<sect1 id="design.overview">
	<title>
	The Original Idea Of &fml8; (fml-devel) Project
	</title>

<para>
&fml8; project called as
<ulink url="http://www.fml.org/software/fml8/">
fml-devel
</ulink>
also is refactoring of &fml4; mailing list driver.
</PARA>

<para>
See
<ulink url="http://www.fml.org/software/fml8/">
http://www.fml.org/software/fml8/
</ulink>
for more details on the furure plan, design and implementation 
of fml-current.
</PARA>


<!--
	OLD DESCRIPTIONS ARE CUT OFF.
-->

</sect1>


<!-- ======================================================== -->

<sect1 id="design.idea.detail">
	<title>
	Details Of Idea
	</title>

<itemizedlist>

   <listitem>
	<para>
	simple implementation of configuration files and menu.
	</para>
   </listitem>

   <listitem>
	<para>
	perl module (> perl 5.00504 )
	</para>
   </listitem>

   <listitem>
	<para>
	support more integrated CUI (makefml) and GUI.
	</para>
   </listitem>

   <listitem>
	<para>
	Separation
	</para>

	<itemizedlist>

	   <listitem>
		<para>
		easy <link linkend="upgrade"> upgrade </link>
		</para>
	   </listitem>

	   <listitem>
		<para>
		use CPAN modules as could as possible.
		</para>
	   </listitem>

	   <listitem>
		<para>
		3rd party directory
		</para>
	   </listitem>

	</itemizedlist>
   </listitem>

   <listitem>
	<para>
	abstracted IO layer
	</para>

		<itemizedlist>

		   <listitem>
			<para>
			file (implemented)
			</para>
		   </listitem>

		   <listitem>
			<para>
			/etc/group (implemented)
			</para>
		   </listitem>

		   <listitem>
			<para>
			NIS (implemented)
			</para>
		   </listitem>

		   <listitem>
			<para>
			SQL (MySQL implemetned)
			</para>
		   </listitem>

		   <listitem>
			<para>
			LDAP
			</para>
		   </listitem>

	</itemizedlist>

   </listitem>

   <listitem>
	<para>
	IPv4/IPv6 ready (implemented)
	</para>
   </listitem>

</itemizedlist>
</sect1>


<!-- ======================================================== -->
<sect1 id="design.refactoring">
	<title>
	Refactoring
	</title>

<table>
 <title> refactoring TODO </title>
 <tgroup cols=3>

  <thead>
	<row>
	<entry> status	</entry>
	<entry> entry	</entry>
	<entry> detail	</entry>
	</row>
   </thead>

  <tbody>
	<row>
	<entry>	done. 			</entry>
	<entry> license			</entry>
	<entry>	perl conformance	</entry>
	</row>

	<row>
	<entry>	underway.		</entry>
	<entry> image 			</entry>
	<entry>
		&fml4; to &fml8; is similar to
		sendmail to postfix.
		support configuration converter.
	</entry>
	</row>

	<row>
	<entry>	done. 		</entry>
	<entry>
		wrapper (separation layer).
	</entry>
	<entry>
		separation layer for upgrade/downgrade, debug.
	</entry>
	</row>

	<row>
	<entry>	</entry>
	<entry> adapter </entry>
	<entry>
		use CPAN modules as could as possible.
		prepare adapter layer in using CPAM module.
	</entry>
	</row>


	<row>
	<entry>	</entry>
	<entry>
	new single configuration file format.
	</entry>
	<entry>
	</entry>
	</row>


	<row>
	<entry>	</entry>
	<entry> rule of variable naming convension
	</entry>
	<entry>
		use_XXX, XXX_TYPet ...
		prohibit NOT_USE style.
	</entry>
	</row>


	<row>
	<entry> </entry>
	<entry>		function name convension

	use X11 style for main:: space.
	use method style for method.
	not use Lisp like style (-p).
	</entry>

	<entry>
		use Perl Cookbook style ?
		e.g. "MemberP() -> IsMember()"
	</entry>
	</row>

	<row>
	<entry> done. </entry>
	<entry> queue manager </entry>
	<entry>
		re-delivery by itself
	</entry>
	</row>


	<row>
	<entry>  </entry>
	<entry> tools </entry>
	<entry>
		not use BSD make.
	</entry>
	</row>
   </tbody>
 </tgroup>
</table>

</sect1>







<!-- ======================================================== -->
<sect1 id="design.architecture.image">
	<title>
	Architecture image
	</title>

<graphic entityref="image.architecture"></graphic>

</sect1>



<!-- ======================================================== -->

<sect1 id="design.releng">
	<TITLE>
	release engineering
	</TITLE>

<para>
Not be an architect nor developer.
Not too abstractive and not too object oriented.
Be between them.
Feedback in one month to manage project and code review.
</para>


<para>
<table>
 <title> release interval </title>
 <tgroup cols=2>
   <thead>
	<row>
	<entry> days in one month </entry>
	<entry> content </entry>
	</row>
   </thead>

   <tbody>

	<row>
	<entry> the first 4 - 5 days </entry>
	<entry> 
		manage project.
		apply at least 20 % of the project to this stage.
	</entry>
	</row>

	<row>
	<entry> 2 - 3 weeks </entry>
	<entry> coding. </entry>
	</row>

	<row>
	<entry> the last week </entry>
	<entry> code review, document review </entry>
	</row>

	<row>
	<entry> at the last of the month </entry>
	<entry> release a snapshot.
		alpha-0,
		alpha-1,
		alpha-2, ...
	</entry>
	</row>

   </tbody>
 </tgroup>
</table>
</para>


</sect1>


</chapter>