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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
|
<!doctype html public "-//w3c//dtd html 4.0 transitional//en">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<meta name="Author" content="Joachim Gabler">
<meta name="GENERATOR" content="Mozilla/4.76C-CCK-MCD [en] (X11; U; SunOS 5.8 sun4u) [Netscape]">
</head>
<body>
<h1>
Source code documentation using adoc</h1>
An essential characteristic of high quality source code is a comprehensive
documentation.
<p>For the Grid Engine development, we started some time ago to use so
called Autodoc Headers that are interpreted by the adoc utility.
<p>Adoc was originally written by Tobias Ferber and published unter the
GPL.
<br>It can create ASCII and Texinfo output, Texinfo can be used to
publish the documentation in a lot of different output formats including
HTML, PDF, GNU Info, DVI etc.
<p>It's functionality is a little bit rudimentory and can not really compete
with tools like doxygen or the javadoc tool, but it has the advantage,
that it can be used to parse not only C or Java source code, but also any
scripting languages like tcl, shell etc. using the same syntax.
<p>The source code of adoc can be found in the directory <tt>source/3rdparty/adoc</tt>.
<br>We modified it to support 3 levels of chapters/sections instead of
only 2.
<br>
<h2>
Generating the documentation</h2>
The documentation can be generated automatically using the aimk script
(<tt>source/aimk</tt>).
<br>Calling <tt>aimk -adoc</tt> will
<ul>
<li>
compile the adoc tool</li>
<li>
generate 3 texinfo files:</li>
<ul>
<li>
documentation of the library functions (<tt>libs.texi</tt>)</li>
<li>
documentation of the core system (<tt>core.texi</tt>)</li>
<li>
documentation of the testsuite (<tt>testsuite.texi</tt>)</li>
</ul>
</ul>
The texinfo files can be used to generate a readable documentation in different
output formats.
<p>Examples:
<ul>
<li>
Generate HTML-Documentation:</li>
<br><tt>texi2html libs.texi</tt>
<br>Writes a file <tt>libs.html</tt> containing the documentation and a
file <tt>libs_toc.html</tt> containing a table of contents with links to
<tt>libs.html</tt>
<li>
Generate Documentation in PDF Format:</li>
<br><tt>texi2pdf libs.texi</tt>
<br>Creates a file <tt>libs.pdf</tt></ul>
<h2>
Writing documentation</h2>
Each function of C, TCL or shell code should have an autodoc header, especially
these in function libraries.
<br>The header can be inserted from a template (see<tt><font color="#000000">doc/devel/c-header</font></tt>for
C-Syntax, <tt><font color="#000000">doc/devel/sh-header</font></tt>for
TCL and shell syntax) or by using a tcl script defined as editor macro.
<h3>
Macro for automated insertion of autodoc headers</h3>
The distribution contains a small tcl script that may be used to
automatically insert an autodoc header into a source file (see <tt>doc/testsuite/adoc/doc_tool.tcl</tt>).
<br>It creates an autodoc header and automatically enters data for the
category and function name, and the autodoc sections <tt>NAME</tt>, <tt>SYNOPSIS</tt>,
<tt>INPUTS</tt>
and <tt>RESULT</tt>.
<p>It can be called as macro from the editor, if the editor has some means
to include macros and the call of external programs.
<p>The doc_tool.tcl has a variety of options to parse and modify source
code for source code documentation purposes.
<h4>
Insertion of autodoc headers in the vim editor</h4>
To install such a macro in the vim editor, edit the .vimrc file in your
homedirectory and add the following line:
<p><tt>map ^P :-r !doc_tool mode C output stdout no_warnings func <cword>
%:p^M</tt>
<p>To enter the ^P and ^M, in vi press CTRL-V CTRL-p / CTRL-V CTRL-m.
<p>If you place the cursor on a C function prototype and press F11,
a new partly filled out autodoc header for the function will be inserted
into the source file.
<p>Newer vim versions (beginning with 6.0?) seem to use another syntax
in the .vimrc file. Add the following line to your .vimrc file (install
macro on F9, F11 as in the previous example didn't work for some reason:
<p><tt>map <unique> <F9> :-r !doc_tool mode C output stdout no_warnings
func <cword> %:p^M</tt>
<h3>
Choosing a function identifier</h3>
The current structure of the source code documentation provides 3 individual
files - documentation of libraries, the core system binaries and the testsuite.
<br>Within each document, we have 3 hiearchical levels of sections - in
texinfo: chapter, section and subsection.
<p>The current documentation is structured not to reflext strictly the
directory structure of the code in the section hierarchy, but the structure
reflects categories of code within a certain directory based structure.
<p>Each source file contains functions belonging to exactly one function
category.
<p>Example:
<br>The module qsh has the function category <tt>Interactive/qsh</tt>:
It is a tool to create an interactive job in Grid Engine, its name is qsh.
<p>Possible function identifiers then are
<br><tt>Interactive/qsh/--Interactive</tt>
<br><tt>Interactive/qsh/add2env()</tt>
<br><tt>...</tt>
<p>To enable the doc_tool.tcl to insert adoc headers with the correct function
categoriy filled in automatically, there exists a file doc/devel/doc_tool.cat
that maps directories and optionally filenames to function categories.
One line contains one mapping.
<p>Example:
<br><tt>source/clients/qsh Interactive/qsh</tt>
<br><tt>source/clients/qrsh Interactive/qrsh</tt>
<br><tt>source/daemons/execd execd</tt>
<br><tt>source/daemons/execd/load_avg.* execd/load</tt>
<br><tt>source/daemons/execd/sge_load_sensor.* execd/load</tt>
<br><tt>...</tt>
<br>
<h4>
Function categories for the library documentation</h4>
<ul>
<li>
Eventclient</li>
<ul>
<li>
Client</li>
</ul>
<li>
commd</li>
<ul>
<li>
commlib</li>
</ul>
<li>
cull</li>
<ul>
<li>
hash - cull specific hash table extensions, based on uti/hash</li>
<li>
list</li>
<li>
multitype</li>
</ul>
<li>
gdi</li>
<ul>
<li>
feature</li>
<li>
job_jatask</li>
<li>
queue</li>
<li>
range</li>
<li>
request</li>
<li>
security</li>
<li>
setup</li>
<li>
sge</li>
<li>
suser</li>
<li>
usermap</li>
</ul>
<li>
rmon</li>
<li>
sched</li>
<li>
uti</li>
<ul>
<li>
afsutil</li>
<li>
bitop</li>
<li>
dstring</li>
<li>
hostname</li>
<li>
htable - generic hash table implementation</li>
<li>
io</li>
<li>
language</li>
<li>
log</li>
<li>
os</li>
<li>
prog</li>
<li>
signal</li>
<li>
spool</li>
<li>
stdio</li>
<li>
stdlib</li>
<li>
string- string parsing functions</li>
<li>
time</li>
<li>
uidgid</li>
<li>
unistd</li>
</ul>
</ul>
<h4>
Function categories for the core system documentation</h4>
<ul>
<li>
commd</li>
<li>
common</li>
<ul>
<li>
General</li>
<li>
Clients</li>
<li>
Daemons</li>
</ul>
<li>
execd</li>
<li>
qacct</li>
<li>
qalter</li>
<li>
qconf</li>
<li>
qdel</li>
<li>
qhost</li>
<li>
qmaster</li>
<li>
qmod</li>
<li>
qmod</li>
<li>
qstat</li>
<li>
qsub</li>
<li>
schedd</li>
<li>
schadowd</li>
<li>
shepherd</li>
<li>
Interactive</li>
<ul>
<li>
qsh</li>
</ul>
<ul>
<li>
qlogin</li>
<li>
qmake</li>
<li>
qrsh</li>
<li>
qtcsh</li>
</ul>
<li>
Eventclient</li>
<ul>
<li>
Server</li>
</ul>
</ul>
<h4>
Function categories for the testsuite documentation</h4>
<ul>
<li>
checks</li>
<ul>
<li>
install</li>
<li>
loadcheck</li>
<li>
migration</li>
<li>
performance</li>
<li>
performance_cluster</li>
<li>
performance_scheduler</li>
<li>
qalter</li>
<li>
qconf</li>
<li>
qdel</li>
<li>
qmaster_size</li>
<li>
qmod</li>
<li>
qrsh</li>
<li>
qstat</li>
<li>
qsub</li>
<li>
shadowd_migrate</li>
</ul>
<li>
library</li>
<ul>
<li>
control</li>
<li>
file</li>
<li>
parser</li>
<li>
remote</li>
<li>
sge</li>
</ul>
<li>
scripts</li>
</ul>
<h3>
Filling out the autodoc header</h3>
The following sections of an autodoc header should always be filled out:
<ul>
<li>
<b><tt>NAME</tt></b></li>
<br>The function name and a short (one line) description
<li>
<b><tt>SYNOPSIS</tt></b></li>
<br>The function prototype, optionally preceeded by an include statement,
if needed and compiler/linker options, see <a href="#Examples for adoc headers">Examples
for adoc headers</a>
<li>
<b><tt>FUNCTION</tt></b></li>
<br>A complete function description.
<li>
<b><tt>INPUTS</tt></b></li>
<br>Description of all input parameters
<li>
<b><tt>RESULT</tt></b></li>
<br>Description of the result</ul>
<p><br>These sections are optional :
<ul>
<li>
<b><tt>EXAMPLE</tt></b></li>
<br>How to use the function
<li>
<b><tt>NOTES</tt></b></li>
<br>Notes for further development, hints for the usage etc.
<li>
<b><tt>BUGS</tt></b></li>
<br>adoc provides a BUGS section to document known bugs - please do not
create BUGS sections - use IssueZilla instead.
<li>
<b><tt>SEE ALSO</tt></b></li>
<br>References to other functions, man pages etc.</ul>
<br>
<h3>
Introduction pages for Categories</h3>
A category usually reflects some hierarchy in the source code tree, often
an individual binary, and deserves to have an introductory autodoc header
before the detailed function descriptions.
<p>Therefor an autodoc header should be written for each category that
gives a short overview of the category and may refer to other autodoc headers
giving more details.
<p>The header of such an introductory page has the form
<br><tt>/****** chapter/section/--topic *****************</tt>
<p>The hyphens (-) before the topic influence autodoc's sorting algorithm:
The introductory page will always be the the first page of a section.
<br>
<br>
<h3>
Documentation of defines, global variables etc.</h3>
It is desirable to have documentation also for constants/defines, global
variables, structures, typedefs etc.
<p>The following special function identifiers are used for this type of
documentation:
<br>-topic-Defines
<br>-topic-Global_Variables
<br>-topic-Templates
<br>-topic-Typedefs
<br>-topic-Misc
<p>Again, the hyphen before the identifiers name influence adoc's sorting
algorithm.
<br>
<h2>
<a NAME="Examples for adoc headers"></a>Examples for adoc headers</h2>
<h3>
An introduction header</h3>
<tt>/****** Interactive/qmake/--qmake ***************************************</tt>
<br><tt>*</tt>
<br><tt>* NAME</tt>
<br><tt>* qmake -- Scheduled parallel distributed
make</tt>
<br><tt>*</tt>
<br><tt>* SYNOPSIS</tt>
<br><tt>* qmake <sge options> -- <gmake options></tt>
<br><tt>*</tt>
<br><tt>* FUNCTION</tt>
<br><tt>* Scheduled, parallel, distributed make.</tt>
<br><tt>* qmake is implemented based on GNU make
3.78.1 using the remote stub</tt>
<br><tt>* mechanism of gmake.</tt>
<br><tt>* qmake will start a parallel job and run
make tasks as task in the</tt>
<br><tt>* parallel job using the Grid Engine qrsh
-inherit command.</tt>
<br><tt>*</tt>
<br><tt>* INPUTS</tt>
<br><tt>* sge options - all options that can be
specified with qsub command</tt>
<br><tt>* gmake options - all possible gmake
options</tt>
<br><tt>*</tt>
<br><tt>* RESULT</tt>
<br><tt>* returncode from gmake or EXIT_FAILURE,
if remote mechanism fails.</tt>
<br><tt>* On error, an appropriate error description
is written to stderr.</tt>
<br><tt>*</tt>
<br><tt>* EXAMPLE</tt>
<br><tt>* qmake -cwd -v PATH -- -j 5</tt>
<br><tt>* Build sge system: aimk -qmake -parallel
10</tt>
<br><tt>*</tt>
<br><tt>* NOTES</tt>
<br><tt>* not yet internationalized</tt>
<br><tt>*</tt>
<br><tt>****************************************************************************</tt>
<br><tt>*/</tt>
<br>
<h3>
A header describing defines</h3>
<tt>/****** Interactive/qmake/-qmake-Defines ***************************************</tt>
<br><tt>*</tt>
<br><tt>* NAME</tt>
<br><tt>* Defines -- constant and macro definitions</tt>
<br><tt>*</tt>
<br><tt>* SYNOPSIS</tt>
<br><tt>* #define LOCK_SLEEP_TIME 500</tt>
<br><tt>* #define WAIT_SLOT_TIME
5</tt>
<br><tt>*</tt>
<br><tt>* FUNCTION</tt>
<br><tt>* LOCK_SLEEP_TIME - Defines how long qmake
should (u)sleep</tt>
<br><tt>*
after an unsuccessful try to get a lock to the</tt>
<br><tt>*
hostfile</tt>
<br><tt>* WAIT_SLOT_TIME - Time to wait,
if no slot is free in hostfile</tt>
<br><tt>*</tt>
<br><tt>****************************************************************************</tt>
<br><tt>*/</tt>
<br>
<h3>
A function description</h3>
<tt>/****** Interactive/qmake/remote_exit() ***************************************</tt>
<br><tt>*</tt>
<br><tt>* NAME</tt>
<br><tt>* remote_exit() -- exit qmake</tt>
<br><tt>*</tt>
<br><tt>* SYNOPSIS</tt>
<br><tt>* static void remote_exit(int code, const
char *message,</tt>
<br><tt>*
const char *reason);</tt>
<br><tt>*</tt>
<br><tt>* FUNCTION</tt>
<br><tt>* Outputs the error messages passed as
parameters to stderr</tt>
<br><tt>* and then exits with the error code passed
as parameter.</tt>
<br><tt>*</tt>
<br><tt>* INPUTS</tt>
<br><tt>* code - exit code</tt>
<br><tt>* message - message to output before exit,
should describe the</tt>
<br><tt>*
situation when error occurs</tt>
<br><tt>* reason - description of the error
reason, e.g. result from</tt>
<br><tt>*
system call strerror(errno)</tt>
<br><tt>*</tt>
<br><tt>* RESULT</tt>
<br><tt>* program exits</tt>
<br><tt>*</tt>
<br><tt>* EXAMPLE</tt>
<br><tt>* #include <stdlib.h></tt>
<br><tt>* #include <string.h></tt>
<br><tt>* #include <errno.h></tt>
<br><tt>*</tt>
<br><tt>* ...</tt>
<br><tt>*</tt>
<br><tt>* if(write(filehandle, buffer, size) !=
size) {</tt>
<br><tt>* remote_exit(EXIT_FAILURE,
"writing to file failed", strerror(errno));</tt>
<br><tt>* }*</tt>
<br><tt>****************************************************************************</tt>
<br><tt>*/</tt>
<br>
<h3>
Description of a Cull object/class</h3>
<tt>/****** gdi/range/--RN_Type ***************************************************</tt>
<br><tt>* NAME</tt>
<br><tt>* RN_Type - CULL range element</tt>
<br><tt>*</tt>
<br><tt>* ELEMENTS</tt>
<br><tt>* SGE_ULONG(RN_min)</tt>
<br><tt>* minimum or start value
of an id range (e.g. 1)</tt>
<br><tt>*</tt>
<br><tt>* SGE_ULONG(RN_max)</tt>
<br><tt>* maximum or end value
of an id range (e.g. 9)</tt>
<br><tt>*</tt>
<br><tt>* SGE_ULONG(RN_step)</tt>
<br><tt>* stepsize (e.g. 2)</tt>
<br><tt>*</tt>
<br><tt>* FUNCTION</tt>
<br><tt>* CULL element holding values which define
a id range</tt>
<br><tt>* (e.g. 1-9:2 => 1, 3, 5, 7, 9).</tt>
<br><tt>* Lists of this CULL element are hold within
a CULL job element</tt>
<br><tt>* (JB_Type) to hold job array task ids.</tt>
<br><tt>* Several functions may be used to access/modify/delete
range</tt>
<br><tt>* elements and range lists. You may find
them in the 'SEE ALSO'</tt>
<br><tt>* section. It is highly advised to use
these access functions</tt>
<br><tt>* because they assure and require a defined
structure of</tt>
<br><tt>* elements and lists.</tt>
<br><tt>*</tt>
<br><tt>* Range elements and lists stored in other
CULL elements fullfill</tt>
<br><tt>* following conditions:</tt>
<br><tt>*</tt>
<br><tt>* - min <= max</tt>
<br><tt>* - step >= 1</tt>
<br><tt>* - real range elements
(e.g. 1-9:2 instead of 1-10:2)</tt>
<br><tt>* - min-ids within range
elements part of the same</tt>
<br><tt>* list are
in ascending order: min_id(n) < min_id(n+1)</tt>
<br><tt>* (e.g. NOT
11-20:1; 1-9:2)</tt>
<br><tt>* - ids within range
elements part of the same</tt>
<br><tt>* list are
non-overlapping: max_id(n) < min_id(n+1)</tt>
<br><tt>* (e.g. 1-9:2;
11-20:1; 25-28:3)</tt>
<br><tt>*</tt>
<br><tt>* SEE ALSO</tt>
<br><tt>* gdi/range/RN_Type</tt>
<br><tt>* gdi/range/range_list_calculate_union_set()</tt>
<br><tt>* gdi/range/range_list_calculate_difference_set()</tt>
<br><tt>* gdi/range/range_list_calculate_intersection_set()</tt>
<br><tt>* gdi/range/range_list_compress()</tt>
<br><tt>* gdi/range/range_list_get_first_id()</tt>
<br><tt>* gdi/range/range_list_get_last_id()</tt>
<br><tt>* gdi/range/range_list_get_number_of_ids()</tt>
<br><tt>* gdi/range/range_list_initialize()</tt>
<br><tt>* gdi/range/range_list_insert_id()</tt>
<br><tt>* gdi/range/range_list_is_id_within()</tt>
<br><tt>* gdi/range/range_list_move_first_n_ids()</tt>
<br><tt>* gdi/range/range_list_print_to_string()</tt>
<br><tt>* gdi/range/range_list_remove_id()</tt>
<br><tt>* gdi/range/range_correct_end()</tt>
<br><tt>* gdi/range/range_get_all_ids()</tt>
<br><tt>* gdi/range/range_get_number_of_ids()</tt>
<br><tt>* gdi/range/range_is_overlapping()</tt>
<br><tt>* gdi/range/range_is_id_within()</tt>
<br><tt>* gdi/range/range_set_all_ids()</tt>
<br><tt>* gdi/range/range_sort_uniq_compress()</tt>
<br><tt>* gdi/job/JB_Type</tt>
<br><tt>******************************************************************************/</tt>
<h3>
Documentation of a TCL function</h3>
#<tt>****** library/control/ps_grep() ******</tt>
<br><tt>#</tt>
<br><tt># NAME</tt>
<br><tt># ps_grep -- call get_ps_info and return
only expected ps information</tt>
<br><tt>#</tt>
<br><tt># SYNOPSIS</tt>
<br><tt># ps_grep { forwhat { host "local" } {
variable ps_info } }</tt>
<br><tt>#</tt>
<br><tt># FUNCTION</tt>
<br><tt># This procedure will call the get_ps_info
procedure. It will parse the</tt>
<br><tt># get_ps_info result for the given strings
and return only those process</tt>
<br><tt># ids which match.</tt>
<br><tt>#</tt>
<br><tt># INPUTS</tt>
<br><tt># forwhat
- search string (e.g. binary name)</tt>
<br><tt># { host "local" }
- host on which the ps command should be called</tt>
<br><tt># { variable ps_info } - variable name
to store the result (default ps_info)</tt>
<br><tt>#</tt>
<br><tt># RESULT</tt>
<br><tt># returns a list of indexes where the search
string matches the ps output.</tt>
<br><tt>#</tt>
<br><tt># EXAMPLE</tt>
<br><tt>#</tt>
<br><tt># set myprocs [ ps_grep "execd" "fangorn" ]</tt>
<br><tt>#</tt>
<br><tt># puts "execd's on fangorn index list: $myprocs"</tt>
<br><tt>#</tt>
<br><tt># foreach elem $myprocs {</tt>
<br><tt># puts $ps_info(string,$elem)</tt>
<br><tt># }</tt>
<br><tt>#</tt>
<br><tt># output of example:</tt>
<br><tt>#</tt>
<br><tt># execd's on fangorn index list: 34 39 50 59 61</tt>
<br><tt># 2530 140 1
259 S Sep12 1916 00:00:14 /sge_s/glinux/sge_execd</tt>
<br><tt># 7700 142 1
339 S Sep13 2024 00:03:49 /vol2/bin/glinux/sge_execd</tt>
<br><tt># 19159 0
1 0 S Sep14 1772 00:31:09 /vol/bin/glinux/sgeee_execd</tt>
<br><tt># 24148 0
1 0 S Sep14 2088 00:06:23 bin/glinux/sge_execd</tt>
<br><tt># 15085 0
1 0 S Sep14 1904 00:27:04 /vol2/glinux/sgeee_execd</tt>
<br><tt>#</tt>
<br><tt># NOTES</tt>
<br><tt># look at get_ps_info procedure for more information!</tt>
<br><tt>#</tt>
<br><tt># SEE ALSO</tt>
<br><tt># library/control/get_ps_info()</tt>
<br><tt>#*******************************</tt>
<h3>
Documentation of a shell script</h3>
<tt>#****** utilities/preemption/high_prolog.sh ***************************************</tt>
<br><tt>#</tt>
<br><tt># NAME</tt>
<br><tt># high_prolog.sh -- prolog for high priority
queues</tt>
<br><tt>#</tt>
<br><tt># SYNOPSIS</tt>
<br><tt># high_prolog.sh</tt>
<br><tt>#</tt>
<br><tt># FUNCTION</tt>
<br><tt># If the number of slots occupied in queues
belonging to the preemption</tt>
<br><tt># mechanism exceeds the number of slots
reserved, an appropriate number</tt>
<br><tt># of low priority jobs/tasks are suspended.</tt>
<br><tt># The jobid's of the jobs suspended are
written to a job context variable</tt>
<br><tt># "suspended" separated by a colon (:).</tt>
<br><tt>#</tt>
<br><tt># If the number of slots occupied is equal
or exceeds the number of</tt>
<br><tt># reserved slots, the low priority queues
are disabled.</tt>
<br><tt>#</tt>
<br><tt># SEE ALSO</tt>
<br><tt># utilities/preemption/--Preemption</tt>
<br><tt># utilities/preemption/high_epilog.sh</tt>
<br><tt># utilities/preemption/low_prolog.sh</tt>
<br><tt># utilities/preemption/low_epilog.sh</tt>
<br><tt>#</tt>
<br><tt>#***************************************************************************</tt>
<br>
</body>
</html>
|
