Whamcloud - gitweb
b=6427
[fs/lustre-release.git] / lustre / mdc / doc / dld.lyx
1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
2 \lyxformat 221
3 \textclass book
4 \begin_preamble
5 \usepackage{listings}
6 \usepackage{color}
7 \usepackage{courier}
8
9 %\usepackage{pt}
10 %\usepackage{units}
11 \usepackage{coz}
12
13 %\usepackage{epsf}
14 %\usepackage{lncsexample}
15 %\conttrue
16 %\usepackage{times}
17 %\usepackage{top}
18 %\usepackage{graphicx}
19 \newcommand{\lst}[2] {
20         \noindent\rule[-0.3mm]{\textwidth}{0.3mm}\vspace{-0.3mm}
21         \lstinputlisting[caption={#2},
22         label={#1},
23         showstringspaces=false, 
24         numbers=left, 
25         stepnumber=1,
26         frame=bottomline,
27         extendedchars=true,
28         basicstyle=\small\tt,
29         numberstyle=\tiny,
30         keywordstyle=\color{red},
31         language=C,
32         emph={1, 2, 3, 4, 5, 6, 7, 8, 9, 0, NULL, lustre, CFS},
33         emphstyle=\color{blue},
34         breaklines=true]{#1}
35         \vspace{0.3mm}       
36 }
37 \end_preamble
38 \language english
39 \inputencoding auto
40 \fontscheme default
41 \graphics default
42 \paperfontsize default
43 \spacing single 
44 \papersize Default
45 \paperpackage a4
46 \use_geometry 0
47 \use_amsmath 0
48 \use_natbib 0
49 \use_numerical_citations 0
50 \paperorientation portrait
51 \secnumdepth 3
52 \tocdepth 3
53 \paragraph_separation indent
54 \defskip medskip
55 \quotes_language english
56 \quotes_times 2
57 \papercolumns 1
58 \papersides 1
59 \paperpagestyle default
60
61 \layout Section
62
63 Object API
64 \layout Paragraph
65
66 In this section, we will describe the funnctional specials, logic specials,
67  the state machine and case:
68 \layout Subsection
69
70 Functional Specification
71 \layout Subsubsection
72
73 CREATE
74 \layout Standard
75
76
77 \begin_inset ERT
78 status Open
79
80 \layout Standard
81
82 \backslash 
83 begin{class}{Create}
84 \newline 
85
86 \backslash 
87 begin{sidebyside}
88 \newline 
89
90 \backslash 
91 begin{op}{Attribution}
92 \newline 
93 ~~~~XXX
94 \backslash 
95
96 \backslash 
97
98 \newline 
99 ~~~~XXX
100 \backslash 
101
102 \backslash 
103
104 \newline 
105 ~~~
106 \backslash 
107
108 \backslash 
109
110 \newline 
111
112 \backslash 
113 end{op}
114 \newline 
115
116 \backslash 
117 begin{init}
118 \newline 
119 Some~Entry~Criterias
120 \newline 
121
122 \backslash 
123 end{init}
124 \newline 
125
126 \backslash 
127 nextside
128 \newline 
129
130 \backslash 
131 begin{op}{Creator}
132 \newline 
133  Name:~~Peter
134 \backslash 
135
136 \backslash 
137
138 \newline 
139  Date:~~~01/06/2005 
140 \backslash 
141
142 \backslash 
143  
144 \newline 
145  Language:~C
146 \newline 
147
148 \backslash 
149 end{op}
150 \newline 
151
152 \backslash 
153 end{sidebyside}
154 \newline 
155
156 \backslash 
157 zbreak
158 \newline 
159 Write something here
160 \backslash 
161
162 \backslash 
163
164 \newline 
165 Write something here
166 \newline 
167
168 \backslash 
169 end{class}
170 \end_inset 
171
172
173 \layout Subsubsection
174
175 REQUEST
176 \layout Standard
177
178
179 \begin_inset ERT
180 status Open
181
182 \layout Standard
183
184 \backslash 
185 begin{class}{request}
186 \newline 
187
188 \backslash 
189 begin{sidebyside}
190 \newline 
191
192 \backslash 
193 begin{op}{Attribution}
194 \newline 
195 ~~~~XXX
196 \backslash 
197
198 \backslash 
199
200 \newline 
201 ~~~~XXX
202 \backslash 
203
204 \backslash 
205
206 \newline 
207 ~~~
208 \backslash 
209
210 \backslash 
211
212 \newline 
213
214 \backslash 
215 end{op}
216 \newline 
217
218 \backslash 
219 begin{init}
220 \newline 
221 Some~Entry~Criterias
222 \newline 
223
224 \backslash 
225 end{init}
226 \newline 
227
228 \backslash 
229 nextside
230 \newline 
231
232 \backslash 
233 begin{op}{Creator}
234 \newline 
235  Name:~~Peter
236 \backslash 
237
238 \backslash 
239
240 \newline 
241  Date:~~~01/06/2005 
242 \backslash 
243
244 \backslash 
245  
246 \newline 
247  Language:~C
248 \newline 
249
250 \backslash 
251 end{op}
252 \newline 
253
254 \backslash 
255 end{sidebyside}
256 \newline 
257
258 \backslash 
259 zbreak
260 \newline 
261 Write something here
262 \backslash 
263
264 \backslash 
265
266 \newline 
267 Write something here
268 \newline 
269
270 \backslash 
271 end{class}
272 \end_inset 
273
274
275 \layout Subsection
276
277 Use cases
278 \layout Subsubsection
279
280 Case 1
281 \layout Subsubsection
282
283 Case 2
284 \layout Paragraph
285
286 ......
287 \layout Subsection
288
289 Testability
290 \layout Subsection
291
292 Logic specification
293 \layout Subsubsection
294
295 OSC_CREATE
296 \layout Standard
297
298 Example of Pseudocode
299 \layout Standard
300
301
302 \begin_inset ERT
303 status Open
304
305 \layout Standard
306
307 \backslash 
308 lst{../../mdc/doc/dld_pseudo.c}{Pseudocode of dld pseudo.c}
309 \end_inset 
310
311
312 \layout Subsubsection
313
314 OSC_REQUEST
315 \layout Subsection
316
317 State
318 \layout Standard
319
320
321 \begin_inset ERT
322 status Open
323
324 \layout Standard
325
326 \backslash 
327 begin{lstlisting}[frame = single]
328 \layout Standard
329 Some states definition and the relationships between them.
330 \layout Standard
331
332 \backslash 
333 end{lstlisting}
334 \end_inset 
335
336
337 \layout Subsection
338
339 Recovery
340 \layout Subsection
341
342 Protocol
343 \the_end