OpenCores
URL https://opencores.org/ocsvn/openrisc/openrisc/trunk

Subversion Repositories openrisc

[/] [openrisc/] [trunk/] [rtos/] [ecos-3.0/] [doc/] [sgml/] [user-guide/] [config-tool.sgml] - Blame information for rev 786

Details | Compare with Previous | View Log

Line No. Rev Author Line
1 786 skrzyp
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
The eCos Configuration Tool
32
 
33
34
 
35
36
Getting Started
37
 
38
39
 
40
41
Introduction
42
 
43
 The eCos Configuration Tool is used
44
          to tailor eCos at source level, prior to compilation or
45
          assembly, and provides a configuration file and a set of
46
          files used to build user applications. The sources and other
47
          files used for building a configuration are provided in a
48
          component repository, which is loaded
49
          when the eCos Configuration Tool
50
          is invoked. The component repository includes a set of files
51
          defining the structure of relationships between the
52
          Configuration Tool and other components, and is written in a
53
          Component Definition Language (CDL).
54
          For a description of the concepts underlying component
55
          configuration, see .
56
57
 
58
59
 
60
61
Invoking the <productname>eCos</productname> <application>Configuration Tool</application>
62
 
63
64
On Linux
65
 
66
Add the eCos Configuration Tool install directory to your PATH, for example:
67
 
68
69
export PATH=/opt/ecos/ecos&Version;/bin:$PATH
70
71
 
72
You may run configtool with zero, one or two arguments. You can specify the eCos repository
73
 location, and/or an eCos save file (extension .ecc) on the command line. The ordering of these
74
two arguments is not significant. For example:
75
 
76
77
configtool /opt/ecos/ecos&Version;/packages myfile.ecc
78
79
 
80
The Configuration Tool will be displayed (see ).
81
82
 
83
84
On Windows
85
 
86
There are two ways in which to invoke the eCos Configuration Tool:
87
88
89
              from the desktop explorer or program set up at installation
90
              time (by default
91
              Start
92
              ->
93
              Programs
94
              ->
95
              eCos
96
              ->
97
              Configuration Tool
98
              ).
99
100
101
type (at a command prompt or in the
102
            Start
103
            menu’s
104
            Run
105
            item): <foldername>\ConfigTool.exe where <foldername> is
106
            the full path of the directory in which you installed the eCos
107
            Configuration Tool.
108
114
 
115
116
117
The
118
            Configuration Tool
119
            will be displayed (see ).
120
121
122
 
123
124
You may run configtool with zero, one or two arguments. You can specify the eCos repository
125
location, and/or an eCos save file (extension .ecc) on the command line. The ordering of these
126
two arguments is not significant. For example:
127
 
128
129
configtool "c:\Program Files\eCos\packages" myfile.ecc
130
131
 
132
137
 
138
If you invoke the configuration tool from the command line with
139
--help, you will see this output:
140
 
141
142
Usage: eCos Configuration Tool [-h] [-e] [-v] [-c] [input file 1] [input file 2]
143
  -h  --help            displays help on the command line parameters
144
  -e  --edit-only       edit save file only
145
  -v  --version         print version
146
  -c  --compile-help    compile online help only
147
148
 
149
This summarizes valid parameters and switches. Switches are shown with
150
both short form and long form.
151
 
152
--help shows valid options and parameters, as above.
153
 
154
--edit-only runs the Configuration Tool in a mode that
155
suppresses creation of a build tree, in case you only want to create and edit save files.
156
 
157
--version shows version and build date information, and exits.
158
 
159
--compile-help compiles help contents files from the HTML documentation
160
files that the tool finds in the eCos repository, and exits.
161
 
162
163
<application>Configuration Tool</application>
164
165
166
167
168
 
169
170
 
171
 
172
173
The Component Repository
174
When you invoke the eCos Configuration Tool, it accesses the Component
175
          Repository, a read-only location of configuration
176
          information. For an explanation of “Component
177
          Repository” see .
178
The eCos Configuration Tool will look
179
          for a component repository using (in descending order of preference):
180
181
182
A location specified on the command line
183
184
185
186
The component repository most recently used by the
187
current user
188
189
190
An eCos distribution under /opt/ecos (under
191
Linux) or a default location set by the installation procedure (under
192
Windows)
193
194
195
User input
196
197
198
The final case above will normally only occur if the previous
199
          repository has been moved or (under Windows) installation information stored in
200
          the Windows registry has been modified; it will result in a dialog box
201
being displayed that allows you to specify the repository location:
202
203
Repository relocation dialog box
204
205
206
Note that in order to use the eCos Configuration Tool you are obliged to provide a
207
          valid repository location. 
208
In the rare event that you subsequently wish to change
209
          the component location, select
210
          Build->Repository
211
          and the above dialog box will then be displayed.
212
You can check the location of the current repository, the current save file
213
path, and the current hardware template and default package,
214
by selecting Help->Repository Information....
215
A summary will be displayed.
216
217
 
218
219
 
220
 
221
222
<productname>eCos</productname> <application>Configuration Tool</application> Documents
223
224
Configuration Save File
225
eCos configuration settings and other information
226
            (such as disabled conflicts) that are set using the
227
            eCos Configuration Tool are saved to
228
            a file between sessions. By default, when the
229
            eCos Configuration Tool is first
230
            invoked, it reads and displays information from the
231
            Component Registry and displays the information in an
232
            untitled blank document. You can perform the following
233
            operations on a document:
234
235
Save the currently active document
236
Use the “File->Save” menu
237
            item or click the Save Document icon on the
238
            toolbar; if the current document is unnamed, you will be prompted
239
            to supply a name for the configuration save file.
240
241
Save As dialog box
242
243
244
245
246
Open an existing document
247
Select File->Open,
248
            or click the Open Document icon on the toolbar.
249
            You will be prompted to supply a name for the configuration save
250
            file. 
251
252
Open dialog box
253
254
255
256
257
Open a document you have used recently
258
Click its name at the bottom of the
259
            File menu. 
260
Documents may also be opened by:
261
262
263
double-clicking a Configuration Save File in the desktop
264
explorer (Windows only);
265
266
267
invoking the eCos
268
Configuration Tool
269
with the name of a Configuration File as command-line argument,
270
or by creating a shortcut to the eCos Configuration Tool with such an argument
271
(under Windows or a suitable Linux desktop environment).
272
273
274
275
276
Create a new blank document based on the Component</code></pre></td>
      </tr>
      <tr valign="middle">
         <td>277</td>
         <td></td>
         <td></td>
         <td class="code"><pre><code>              Registry
278
Select File->New,
279
or click the New Document icon on the toolbar.
280
281
282
Save to a different file name
283
Select File->Save
284
                As. You will be prompted to supply a new
285
              name for the configuration save file.
286
287
288
289
Build and Install Trees
290
The location of the build and install trees are
291
            derived from the eCos save file name as illustrated in the
292
            following example:
293
Save file name = “c:\My
294
            eCos\config1.ecc”
295
Install tree folder = “c:\My
296
            eCos\config1_install”
297
Build tree folder = “c:\My
298
            eCos\config1_build”
299
These names are automatically generated from the name
300
            of the save file.
301
See also .
302
303
304
305
 
306
307
308
 
309
310
Getting Help
311
 
312
The eCos Configuration Tool contains
313
several methods for accessing online help.
314
 
315
316
 
317
318
 
319
Context-sensitive Help for Dialogs
320
Most dialogs displayed by the eCos Configuration Tool are supplied
321
with context-sensitive help. You can then get help relating
322
to any control within the current dialog box by
323
 
324
325
326
Right-clicking the control (or pressing
327
              F1
328
              )
329
A “What’s This?” popup menu will
330
          be displayed. Click the menu to display a brief description of the
331
          function of the selected control.
332
333
334
Clicking the question mark icon in the dialog
335
            caption bar (Windows) or the question mark button on the dialog (Linux).
336
A question mark cursor will be displayed. Click on
337
              any control to display a brief description of its
338
              function.
339
340
341
Some dialogs may have a Help
342
          button. You can press this to display a more general
343
          description of the function of the dialog box as a whole.
344
          This help will be in HTML form; for more information, see
345
          below.
346
347
 
348
349
 
350
351
Context-sensitive Help for Other Windows
352
In the Help menu, click
353
          Help On...
354
358
and then click on a window (or click on the arrow/question mark button
359
on the toolbar, then click on a window). A small popup window page describing the
360
window will be displayed. The same thing can be achieved by right-clicking
361
on a window and clicking on What's This?.
362
366
367
368
369
Context-sensitive Help for Configuration Items
370
In the configuration window, right-click on a configuration
371
item (or use Shift+F10). A context
372
menu will be displayed; select Visit Documentation
373
to display the page in the eCos documentation that most closely
374
corresponds to the selected item.
375
376
 
377
378
Methods of Displaying HTML Help
379
 
380
381
 
382
383
384
Using the internal help system. This will show an internal viewer similar to Microsoft HTML Help, with a contents
385
hierarchy on the left and HTML pages on the right; see . The index is regenerated for each repository. If the documentation in
386
the repository has changed but the contents does not reflect this, please use the Tools Regenerate Help Index menu
387
item.
388
389
390
 
391
392
393
Using the default HTML browser. On Unix, you will need a .mailcap entry similar to this:
394
395
 
396
397
398
text/html; netscape -no-about-splash %s
399
400
401
402
 
403
404
405
Using the specified browser.
406
407
408
 
409
410
 
411
 
412
413
HTML Help viewer
414
415
416
If you wish, you may choose to have HTML Help displayed
417
in a browser of your choice. To do this, select View->Settings and
418
use the controls in the View Documentation group to select the replacement browser.
419
Note that the Navigation facilities of the built-in HTML
420
Help system will be unavailable if you choose this method
421
of displaying help.
422
423
424
 
425
426
427
 
428
429
Customization
430
The following visual aspects of the eCos Configuration Tool can be changed to suit
431
        individual preferences. These aspects are saved on a per-user
432
        basis, so that when the eCos Configuration Tool is next invoked by the same
433
        user, the appearance will be as set in the previous
434
        session.
435
436
Window Placement
437
The relative sizes of all windows in the eCos Configuration Tool may be adjusted by dragging
438
          the splitter bars that separate the windows. The chosen
439
          sizes will be used the next time the eCos Configuration Tool is invoked by the current
440
          user. 
441
All windows except the Configuration
442
            Window may be shown or hidden by using the
443
          commands under the View menu (for
444
          example, View->Output) or the
445
          corresponding keyboard accelerators
446
          (Alt+1 to
447
          Alt+4).
448
452
453
Your chosen set of windows (and their relative sizes) will
454
be preserved between invocations of the eCos Configuration
455
Tool.
456
457
466
467
Settings
468
To change other visual aspects, select
469
          View->Settings
470
          and then select the Display and
471
          View tabs depending on the settings
472
          you wish to alter..
473
          The options are as follows:
474
475
 
476
 
477
478
Settings: Display tab
479
 
480
481
Settings dialog, Display tab
482
483
484
 
485
486
Labels
487
 
488
In the configuration window, you can choose to have
489
            either descriptive names (the
490
            default) or macro names displayed as
491
            tree item labels. Descriptive names are generally more
492
            comprehensible, but macro names are used in some contexts
493
            such as conflict resolution and may be directly related to
494
            the source code of the configuration. Note that it is
495
            possible to search for an item in the configuration view
496
            by selecting
497
            Find->Edit
498
            (see ). Both
499
            descriptive names and macro names can be searched.
500
501
 
502
503
Integer Items
504
You can choose to have integer items in the
505
            Configuration Window displayed in decimal or hexadecimal
506
            format.
507
508
 
509
510
Font
511
 
512
513
Change the font for a particular window by selecting the window name using the drop-down list,
514
then clicking on Change Font to select a font for that
515
window. The changes will be applied when the press OK to dismiss the Settings dialog.
516
If you never make font changes, then the windows will take
517
the default setting determined by your current Windows or Unix environment.
518
519
520
 
521
522
Miscellaneous
523
 
524
525
If the Splash Screen checkbox is checked, a splash
526
window will appear as the application is loading. Uncheck this to eliminate the splash screen.
527
528
 
529
530
531
 
532
533
Settings: Viewers tab
534
 
535
536
Settings dialog, Viewers tab
537
538
539
 
540
541
View header files
542
 
543
You can change the viewer used to display header files.
544
545
 
546
547
View documentation
548
 
549
You can change the viewer used to display HTML files.
550
See .
551
552
 
553
 
554
 
555
556
 
557
558
 
559
560
561
 
562
563
564
 
565
566
Screen Layout
567
The following windows are available within the
568
      eCos  Configuration
569
        Tool:
570
    
571
572
573
                Configuration Window
574
575
576
                Properties Window
577
578
579
                Short Description
580
581
582
                Conflicts
583
584
585
                Output
586
587
588
 
589
The layout of the windows may be adjusted to suit your
590
        preferences: see .
591
 
592
593
Configuration Window
594
This is the principal window used to configure eCos. It
595
          takes the form of a tree-based representation of the
596
          configuration items within the currently loaded eCos
597
          packages.
598
In the case of items whose values may be changed,
599
          controls are available to set the item values. These either
600
          take the form of check boxes or radio buttons within the
601
          tree itself or cells to the right of the thin vertical
602
          splitter bar. Controls in the tree may be used in the usual
603
          way; cells, however, must first be activated.
604
To activate a cell, simply click on it: it will assume a sunken
605
appearance and data can then be edited in the cell. To terminate
606
in-cell editing, click elsewhere in the configuration window or
607
press ENTER. To discard the partial results
608
of in-cell editing and revert to the previous value, press ESCAPE.
609
613
614
615
Cells come in three varieties, according to the type of
616
          data they accept:
617
618
Cell types
619
620
621
622
Cell Type
623
Data Accepted
624
625
626
627
628
Integer
629
Decimal or hexadecimal values
630
631
632
Floating Point
633
Floating point values
634
635
636
String
637
Any
638
639
640
641
652
In the case of string cells, you can double-click the cell
653
to display a dialog box containing a larger region in which to edit
654
the string value. This is useful in the case of long strings, or
655
those spanning multiple lines.
656
657
Disabled items
658
Some items will appear disabled. In this case the item
659
            label and any associated controls and cells will be
660
            grayed. It is not be possible to change the values of
661
            disabled items.
662
663
Right-Clicking
664
You can right-click on an item in the configuration
665
              window item to display a pop-up menu which (depending on
666
              the type of the item selected) allows you to:
667
668
669
 Properties
670
                  information relating to the currently selected item
671
                  is displayed. The information is equivalent to that
672
                  displayed in the Properties
673
                  Window.
674
675
676
 Restore Defaults -
677
                  the default value of the currently selected item is
678
                  restored.
679
680
681
Visit Documentation
682
                  - causes the HTML page most closely relating to the
683
                  currently selected item to be displayed. This has
684
                  the same effect as double-clicking the URL property
685
                  in the Properties Window.
686
687
688
 View Header File
689
                  – this causes the file containing the items to
690
                  be displayed. This is equivalent to double-clicking
691
                  on the File property in the Properties Window. The
692
                  viewer used for this purpose may be changed using
693
                  the View->Settings menu item
694
                  (see ).
695
                  Note that this operation is only possible when the
696
                  current configuration is saved, in order to avoid
697
                  the possibility of changing the source
698
                  repository.
699
700
701
Unload Package -
702
                  this is equivalent to using the
703
                  Build->Packages menu item to
704
                  select and unload the package in
705
                  question.
706
707
708
709
710
711
Conflicts Window
712
This window exists to display any configuration item
713
            conflicts. Conflicts are the result of failures to meet
714
            the requirements between configuration items expressed in
715
            the CDL. See  .
717
The window comprises three columns:
718
719
720
                Item
721
This is the macro name of the first item involved
722
                in the conflict.
723
724
725
726
                Conflict
727
This is a description of the conflict type. The currently
728
                supported types are “unresolved”, “illegal
729
                value”, “evaluation exception”, “goal
730
                unsatisfied” and “bad data”.
731
732
733
734
                Property
735
This contains a description of the configuration
736
                item’s property that caused the conflict.
737
Within the conflicts window you can right-click on
738
                any item to display a context menu which allows you to
739
                choose from one of the following options:
740
741
742
 
743
To locate the item involved in the
744
conflict, double-click in the first or third column, or
745
right-click over the item and choose Locate
746
from the popup menu.
747
748
 
749
You can use the Tools->Resolve Conflicts menu
750
item, or right-click over the item and select Resolve from the popup menu,
751
to resolve conflicts — .
752
753
Output Window
754
This window displays any output generated by
755
              execution of external tools and any error messages that
756
              are not suitable for display in other forms (for
757
              example, as message boxes).
758
Within the output window you can right-click to display a
759
context menu which allows you to:
760
761
762
Save the contents of the window to a
763
                  file
764
765
766
Clear the contents of the
767
                  window
768
769
770
771
772
Properties Window
773
This window displays the CDL properties of the item
774
              currently selected in the configuration window. The same
775
              information may be displayed by right-clicking the item
776
              and selecting “properties”.
777
              
778
Two properties may be double-clicked as
779
            follows:
780
781
782
URL
783
                  double-clicking on a URL property causes the
784
                  referenced HTML page to be displayed. This has the
785
                  same effect as right-clicking on the item and
786
                  choosing “Visit
787
                  Documentation”.
788
789
790
File
791
                  double-clicking on a File property in a saved
792
                  configuration causes the File to be displayed. The
793
                  viewer used for this purpose may be changed using
794
                  the View->Settings menu
795
                  item. Note that this operation is only possible when
796
                  the current configuration is saved, in order to
797
                  avoid the possibility of changing the source
798
                  repository.
799
800
801
802
803
Short Description Window
804
This window displays a short description of the item
805
              currently selected in the configuration window. More
806
              extensive documentation may be available by
807
              right-clicking on the item and choosing “Visit
808
              Documentation”.
809
810
811
812
813
 
814
815
816
 
817
818
Updating the Configuration
819
820
Adding and Removing Packages
821
To add or remove packages from the configuration, select
822
          Build->Packages.
823
            The following dialog box will be displayed:
824
825
Packages dialog box
826
827
828
The left-hand list shows those packages that are available to
829
          be loaded. The right-hand list shows those that are
830
          currently loaded. In order to transfer packages from one
831
          list to another (that is, to load or unload packages)
832
          double-click the selection or click the
833
          Add or Remove
834
          buttons.
835
 
836
The version drop-down list displays the versions of the
837
          selected packages. When loading packages, this control may
838
          be used to load versions other than the most recent
839
          (current). Note that if more than one package is selected,
840
          the version drop-down list will display only the versions
841
          common to all the selected packages.
842
 
843
The window under the version displays a brief
844
          description of the selected package. If more than one
845
          package is selected, this window will be blank.
846
 
847
848
        Under the description window there is a Keywords
849
control into which you can type a string to be matched against
850
package names, macro names and descriptions. The lists are updated
851
a second or so after typing has stopped.
852
If you type several separate words,
853
all of these words must be associated with a given package
854
for that package to be displayed. If you select
855
the Match exactly checkbox, then the string
856
is taken to be a complete fragment and matched against the beginning
857
of a name, macro name or descriptions. All matches are done
858
case-insensitively.
859
 
860
861
If you check Omit hardware packages, only
862
non-hardware packages will be shown.
863
864
 
865
866
867
Platform Selection
868
To add, modify or remove entries in the list of
869
          platforms used for running tests, select
870
          Tools->Platforms. The following
871
          dialog will be displayed:
872
873
Platforms dialog box
874
875
876
You may add, modify or remove platform entries as you
877
          wish, but in order to run tests, a platform must be defined
878
          to correspond to the currently loaded hardware template. The
879
          information associated with each platform name is used to
880
          run tests.
881
To modify a platform, click the
882
          Modify button with the appropriate
883
          platform selected, or double-click on an entry in the list.
884
          A dialog will be displayed that allows you to change the
885
          command prefix, platform type and arguments for
886
          GDB. 
887
888
Platform Modify dialog box
889
890
891
To add a new platform, click the
892
          Add button. A similar dialog will be
893
          displayed that allows you to define a new platform. To
894
          remove a platform, click the Delete
895
          button or press the DEL key with the
896
          appropriate platform selected.
897
 
898
The command prefix is used when running tests in order
899
          to determine the names of the executables (such as gdb) to
900
          be used. For example, if the gdb executable name is
901
          “arm-elf-gdb.exe” the prefix should be set to
902
          “arm-elf”.
903
The platform type indicates the capabilities of the platform
904
- whether it is hardware or a simulator, and whether breakpoints
905
are supported.
906
The arguments for the GDB field allow
907
additional arguments to be passed to gdb when it is used to run
908
a test.  This is typically used in the case of simulators linked
909
to gdb in order to define memory layout.
910
911
912
Using Templates
913
To load a configuration based on a template, select
914
          Build->Templates.
915
The following dialog box will be displayed:
916
917
Templates dialog box
918
919
920
Change the hardware template, the packages template, or
921
          both. To select a hardware template, choose from the first
922
          drop-list. To choose a packages template, choose from the
923
          second. Brief descriptions of each kind of template are
924
          provided in the corresponding edit boxes.
925
926
Resolving conflicts
927
During the process of configuring eCos it is possible
928
            that conflicts will be created. For more details of the
929
            meaning of conflicts, see .
930
The Conflicts Window displays all conflicts in the
931
            current configuration. Additionally, a window in the
932
            status bar displays a count of the conflicts. Because the
933
            resolution of conflicts can be time-consuming, a mechanism
934
            exists whereby conflicts can be resolved
935
            automatically.
936
You can choose to have a conflicts resolution dialog
937
            box displayed by means of the View->Settings...
938
              menu item, on the Conflict Resolution
939
tab of the dialog.
940
941
Options
942
943
944
You can choose to have conflicts checked under the
945
            following circumstances:
946
947
948
After any item is changed (in other words,
949
                as soon as the conflict is created)
950
951
952
Before saving the configuration (including
953
                building)
954
955
956
Never
957
958
959
The method you chose depends on how much you need
960
                your configuration to be free of conflicts. You may
961
                want to avoid having to clean up all the conflicts at
962
                once, or you may want to keep the configuration
963
                consistent at all times. If you have major changes to
964
                implement, which may resolve the conflicts, then you
965
                might want to wait until after you have completed
966
                these changes before you check for conflicts.
967
968
969
If you choose to check conflicts after any item
970
              is changed, only newly arising conflicts are displayed.
971
              If you choose to check for conflicts before saving the
972
              configuration, the complete set is
973
              displayed.
974
975
976
977
Automatic resolution
978
If you check the “Automatically suggest
979
            fixes” check box, a conflicts resolution dialog box
980
            will be displayed whenever new conflicts are created. The
981
            same dialog box may be displayed at any stage by means of
982
            the Tools->Resolve Conflicts
983
            menu item.
984
            
985
The conflicts resolution dialog box contains two major windows. 
986
987
Resolve conflicts window
988
989
990
The upper contains the set of conflicts to be addressed; the
991
format of the data being as that of the Conflicts Window. The lower
992
window contains a set of proposed resolutions – each entry
993
is a suggested configuration item value change that as a whole may
994
be expected to lead to the currently selected conflict being resolved. 
995
Note that there is no guarantee:
996
997
998
that automatic resolutions will be determinable for every
999
conflict.
1000
1001
1002
        that the resolutions for separate conflicts will be independent.
1003
In other words, the resolution of one conflict may serve to prevent
1004
the resolution of another.
1005
1006
1007
        that the resolution conflicts will not create further
1008
conflicts.
1009
1010
1011
The above warnings are, however, conservative. In practice
1012
(so long as the number and extent of conflicts are limited) automatic
1013
conflict resolution may be used to good effect to correct problems
1014
without undue amounts of programmer intervention.
1015
In order to select the conflicts to be applied, select or
1016
clear the check boxes against the resolutions for each proposed
1017
resolution. By default all resolutions are selected; you can return
1018
to the default state (in other words, cause all check boxes for
1019
each conflict to again become checked) by pressing the “Reset” button.
1020
Note that multiple selection may be used in the resolutions control
1021
to allow ranges of check boxes to be toggled in one gesture.
1022
When you are happy to apply the selected resolutions for each
1023
conflict displayed, click Apply; this will
1024
apply the resolutions. Alternatively you may cancel from the dialog
1025
box without any resolutions being applied.
1026
1027
1028
1029
 
1030
1031
1032
 
1033
1034
Searching
1035
Select Edit --> Find.
1036
You will be presented with a Find dialog box:
1037
1038
Find dialog box
1039
1040
1041
Using this dialog box you can search for an exact text string
1042
in any one of three ways, as specified by your selection in the “Search
1043
in” drop-list:
1044
1045
1046
Macro names - the search is for a text match within
1047
configuration item macro names
1048
1049
1050
                        Item names - the search is for a text match within
1051
configuration item descriptive names
1052
1053
1054
                        Short descriptions - the search is for a text match
1055
within configuration item short descriptions
1056
1057
1058
Note that to invoke Find you can also
1059
click the Find icon on the toolbar. 
1060
1061
 
1062
1063
1064
 
1065
1066
Building
1067
When you have configured eCos, you may build the configuration.
1068
On the Build menu, click:
1069
1070
1071
1072
Library
1073
 (or click the Build Library icon on the toolbar) – this
1074
causes the eCos configuration to be built. The result of a successful
1075
build will be (among other things) a library against which user
1076
code can be linked
1077
1078
1079
1080
Tests
1081
 – this causes the eCos configuration to be built, and
1082
additionally builds the relevant test cases linked against the eCos library
1083
1084
1085
1086
Clean
1087
 – this removes all intermediate files, thus causing a
1088
subsequent build/library or build/tests operation
1089
to cause recompilation of all relevant files.
1090
1091
1092
1093
Stop
1094
 – this causes a currently executing build (any of the
1095
above steps) to be interrupted
1096
1097
1098
Build options may be displayed by using the Build->Options menu
1099
item. This displays a dialog box containing a drop-list control
1100
and two windows. The drop-list control allows you to select the
1101
type of build option to be displayed (for example “LDFLAGS” are
1102
the options applied at link-time. The left-hand window is a tree
1103
view of the packages loaded in the current configuration. The right-hand
1104
window is a list of the build options that will be used for the
1105
currently selected package.
1106
Note that this dialog box currently affords only read-only
1107
access to the build options. In order to change build options you
1108
must edit the relevant string configuration item.
1109
A single level of inheritance is supported: each package’s
1110
build options are combined with the global options (these are to
1111
be found in the “Global build options” folder
1112
in the configuration view).
1113
1114
1115
Selecting Build Tools
1116
Normally the installation process will supply the information
1117
required for the eCosConfiguration Tool to
1118
locate the build tools (compiler, linker, etc.) necessary
1119
to perform a build. However if this information is not registered,
1120
or it is necessary to specify the location manually (for example,
1121
when a new toolchain installation has been made), select Tools->Paths->Build
1122
Tools. The following dialog box will be displayed:
1123
1124
Build tools
1125
1126
1127
This dialog box allows you to locate the folder containing
1128
the build tools. 
1129
1130
1131
Selecting User Tools
1132
Normally the installation process will supply the information
1133
required for the eCosConfiguration Tool to
1134
locate the user tools (cat, ls, etc.) necessary to perform
1135
a build. However if this information is not registered, or it is
1136
necessary to specify the location manually (for example, when a
1137
new toolchain installation has been made), select Tools->Paths->User
1138
Tools. The following dialog box will be displayed:
1139
1140
User tools
1141
1142
1143
1144
1145
 
1146
1147
1148
 
1149
1150
Execution
1151
Test executables that have been linked using the Build/Tests
1152
operation against the current configuration can be executed by selecting Tools->Run
1153
Tests.
1154
When tests are run, the Configuration Tool looks
1155
for a platform name corresponding to the currently loaded hardware template.
1156
If no such platform is found, a dialog will be displayed for you
1157
to define one; this dialog is similar to that displayed by the Add function
1158
in the Tools->Platforms dialog, but
1159
in this case the platform name cannot be changed.
1160
When a test run is invoked, a property sheet is displayed,
1161
comprising three tabs: Executables, Output and Summary.
1162
Note that the property sheet is resizable.
1163
Three buttons appear on the property sheet itself: Run/Stop, Close and Properties.
1164
The Run button is used to initiate a
1165
test run. Those tests selected on the Executables tab
1166
are run, and the output recorded on the Output and Summary tabs.
1167
During the course of a run, the Run button
1168
changes to “Stop”. The button may be used to interrupt
1169
a test run at any point.
1170
1171
Properties
1172
The Properties button is used to change
1173
the connectivity properties for the test run.
1174
1175
Properties dialog box
1176
1177
1178
1179
Download Timeout
1180
            This group of controls serves to set the maximum time that
1181
            is allowed for downloading a test to the target board. If
1182
            the time is exceeded, the test will be deemed to have
1183
            failed for reason of “Download Timeout” and
1184
            the execution of that particular test will be abandoned.
1185
            This option only applies to tests run on hardware, not to
1186
            those executed in a simulator. Times are in units of
1187
            elapsed seconds.
1188
Three options are available using the drop-down
1189
            list:
1190
1191
1192
Calculated from file size - an estimate of the maximum
1193
time required for download is made using the (stripped) executable
1194
size and the currently used baud rate
1195
1196
1197
                        Specified - a user-specified value may be entered in
1198
the adjacent edit box
1199
1200
1201
                        None - no maximum download time is to be applied.
1202
1203
1204
1205
1206
Run time Timeout
1207
This group of controls serves to set the maximum time
1208
            that is allowed for executing a test on the target board
1209
            or in a simulator. If the time is exceeded, the test will
1210
            be deemed to have failed for reason of
1211
            “Timeout” and the execution of that particular
1212
            test will be abandoned. In the case of hardware, the time
1213
            is measured in elapsed seconds: in the case of a simulator
1214
            it is in CPU seconds.
1215
Three options are available using the drop-down
1216
          list:
1217
1218
1219
None - no maximum download time is to be
1220
                applied.
1221
1222
1223
Specified - a user-specified value may be
1224
                entered in the adjacent edit box
1225
1226
1227
Default - a default value of 30 seconds is
1228
                used
1229
1230
1231
1232
1233
Connection
1234
The Connection controls may be used
1235
            to specify how the target board is to be accessed.
1236
 
1237
If the target board is connected using a serial cable, the Serial radio
1238
button should be checked. In this case you can select a port (COM1,
1239
COM2, …) and an appropriate baud rate using drop-list boxes.
1240
If the target board is accessed remotely using GDB remote
1241
protocol, the “TCP/IP” radio button should
1242
be checked. In this case you can select a host name and TCP/IP port
1243
number using edit boxes.
1244
1245
1246
Executables Tab
1247
This is used to adjust the set of tests available for execution.
1248
A check box against each executable name indicates whether that
1249
executable will be included when the Run button
1250
is pressed. The Check All and Uncheck
1251
All buttons may be used to check or uncheck all items.
1252
When the property sheet is first displayed, it will be pre-populated
1253
with those test executables that have been linked using the Build/Tests
1254
operation against the current configuration. 
1255
1256
Run tests 
1257
1258
1259
You can right-click in the window to display a context menu
1260
containing Add and Remove items.
1261
Clicking Remove  will remove those executables
1262
selected. Clicking Add will display a dialog
1263
box that allows you to add to the set of items. Equivalently the Add button
1264
may be used to add executables, and the DEL key
1265
may be used to remove them.
1266
You can use the Add from Folder button
1267
to add a number of executables in a specified folder (optionally
1268
including subfolders, if you click on Yes when
1269
asked).
1270
1271
Add files from folder 
1272
1273
1274
 
1275
1285
1286
1287
Output Tab
1288
This tab is used to display the output from running tests.
1289
The output can be saved to a file or cleared by means of the popup
1290
menu displayed when you right-click in the window.
1291
1292
1293
Summary Tab
1294
This tab is used to display a record, in summary form, of
1295
those tests executed. For each execution, the following information
1296
is displayed:
1297
1298
1299
                        Time - the date and time of execution
1300
1301
1302
                        Host - the host name of the machine
1303
from which the test was downloaded
1304
1305
1306
                        Platform - the platform on which
1307
the test was executed
1308
1309
1310
                        Executable - the executable (file
1311
name) of the test executed
1312
1313
1314
                        Status - the result of executing
1315
the test. This will be one of the following:
1316
1317
1318
                                Not started
1319
1320
1321
No result
1322
1323
1324
Inapplicable
1325
1326
1327
                                Pass
1328
1329
1330
DTimeout
1331
1332
1333
Timeout
1334
1335
1336
Cancelled
1337
1338
1339
                                Fail
1340
1341
1342
Assert fail
1343
1344
1345
                        Size - the size [stripped/unstripped] of
1346
the test executed
1347
1348
1349
                        Download - the download time [mm:ss/mm:ss] used.
1350
The first of the two times displayed represents the actual time
1351
used: the second the limit time.
1352
1353
1354
                        Elapsed - the elapsed time [mm:ss] used.
1355
1356
1357
                        Execution - the execution time
1358
 [mm:ss/mm:ss] used. The first of the
1359
two times displayed represents the actual time used: the second
1360
the limit time.
1361
1362
1363
The output can be saved to a file or cleared by means of the
1364
popup menu displayed when you right-click in the window.
1365
1366
1367
1368
 
1369
1370
1371
 
1372
1373
Creating a Shell
1374
To call up a shell window, select Tools->Shell.
1375
Under Windows, you will get a Cygwin shell similar to the one below. On Linux, you will
1376
get a standard Linux shell window.
1377
1378
1379
Keyboard Accelerators
1380
The following table presents the list of keyboard accelerators
1381
that can be used with the Configuration Tool. 
1382
 
1383
Keyboard accelerators
1384
1385
          
1386
            
1387
              Accelerator
1388
              Action
1389
              Remarks
1390
            
1391
          
1392
1393
 
1394
1395
Alt+1
1396
hide/show properties window
1397
1398
1399
 
1400
1401
Alt+2
1402
hide/show output window
1403
1404
 
1405
1406
Alt+3
1407
hide/show short description window
1408
1409
 
1410
1411
Alt+4
1412
hide/show conflicts window
1413
1414
1415
 
1416
1417
Ctrl+A
1418
select alloutput
1419
window and in-cell editing
1420
1421
Ctrl+C
1422
copyoutput window
1423
and in-cell editing
1424
1425
Ctrl+F
1426
Edit->Find
1427
1428
Ctrl+N
1429
File->New
1430
1431
Ctrl+O
1432
File->Open
1433
1434
Ctrl+S
1435
File->Save
1436
1437
Ctrl+V
1438
Pastein-cell editing
1439
only
1440
1441
Ctrl+X
1442
Cutin-cell-editing
1443
only
1444
1445
Ctrl+Z
1446
Undoin-cell editing
1447
only
1448
1449
F1
1450
Context-sensitive help
1451
1452
F3
1453
Find next
1454
1455
F7
1456
Build->Library
1457
1458
Shift+F7
1459
Build->Tests
1460
1461
Alt+F6
1462
View->Next window
1463
1464
1465
Shift+Alt+0
1466
View->Previous window
1467
1468
1469
Shift+Ins
1470
Pastein-cell editing
1471
only
1472
1473
Shift+F10
1474
Display context menuConfiguration
1475
window
1476
1477
Alt+Enter
1478
Display properties dialog box
1479
Configuration window
1480
1481
>
1482
Increment item valueConfiguration
1483
window
1484
1485
<Decrement
1486
item valueConfiguration window
1487
1488
Space
1489
Toggle item valueConfiguration
1490
window
1491
          
1492
        
1493
      
1494
 
1495
1496
1497
 
1498
1499
 
1500
 
1501
1502

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.