Skip to content

Commit 29b3d35

Browse files
committed
docs: 'Internals' updated
1 parent 25613a6 commit 29b3d35

File tree

1 file changed

+65
-59
lines changed

1 file changed

+65
-59
lines changed

docs/internals.rst

Lines changed: 65 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,78 @@
11
Internals
22
=========
33

4-
Underlying tool steps
5-
---------------------
4+
Underlying steps
5+
----------------
66

77
.. code-block::
88
9-
create project
10-
config project
11-
part
12-
precfg (hook)
13-
params
14-
defines
15-
includes
16-
files
17-
top
18-
postcfg (hook)
19-
close project
9+
project creation [options]
10+
project configuration
11+
part
12+
precfg hook
13+
params
14+
defines
15+
includes
16+
files [options]
17+
top
18+
postcfg hook
19+
project close
2020
21-
open project
22-
presyn (hook)
23-
synthesis
24-
postsyn (hook)
25-
prepar (hook)
26-
place_and_route
27-
postpar (hook)
28-
prebit (hook)
29-
bitstream
30-
postbit (hook)
31-
close project
21+
project open
22+
presyn hook
23+
synthesis [options]
24+
postsyn hook
25+
prepar hook
26+
place_and_route [options]
27+
postpar hook
28+
prebit hook
29+
bitstream [options]
30+
postbit hook
31+
project close
3232
3333
Internal data structure
3434
-----------------------
3535

3636
.. code-block::
3737
38-
data = {
39-
'part': 'PARTNAME',
40-
'includes': ['DIR1', 'DIR2', 'DIR3'],
41-
'files': {
42-
'FILE1': {'hdl': 'vhdl', 'lib': 'LIB1', 'opt': 'OPTS'},
43-
'FILE2': {'hdl': 'vlog', 'opt': 'OPTS'},
44-
'FILE3': {'hdl': 'slog', 'opt': 'OPTS'}
45-
},
46-
'top': 'TOPNAME',
47-
'constraints': {
48-
'FILE1': {'opt': 'OPTS'},
49-
'FILE2': {'opt': 'OPTS'},
50-
'FILE3': {'opt': 'OPTS'}
51-
},
52-
'params': {
53-
'PAR1': 'VAL1',
54-
'PAR2': 'VAL2',
55-
'PAR3': 'VAL3'
56-
},
57-
'defines': {
58-
'DEF1': 'VAL1',
59-
'DEF2': 'VAL2',
60-
'DEF3': 'VAL3'
61-
},
62-
'hooks': {
63-
'precfg': ['CMD1', 'CMD2'],
64-
'postcfg': ['CMD1', 'CMD2'],
65-
'presyn': ['CMD1', 'CMD2'],
66-
'postsyn': ['CMD1', 'CMD2'],
67-
'prepar': ['CMD1', 'CMD2'],
68-
'postpar': ['CMD1', 'CMD2'],
69-
'prebit': ['CMD1', 'CMD2'],
70-
'postbit': ['CMD1', 'CMD2']
71-
}
72-
}
38+
data = {
39+
'part': 'PARTNAME',
40+
'includes': ['DIR1', 'DIR2', 'DIR3'],
41+
'files': {
42+
'FILE1': {'hdl': 'vhdl', 'lib': 'LIB1', 'opt': 'OPTS'},
43+
'FILE2': {'hdl': 'vlog', 'opt': 'OPTS'},
44+
'FILE3': {'hdl': 'slog', 'opt': 'OPTS'}
45+
},
46+
'top': 'TOPNAME',
47+
'constraints': {
48+
'FILE1': {'opt': 'OPTS'},
49+
'FILE2': {'opt': 'OPTS'},
50+
'FILE3': {'opt': 'OPTS'}
51+
},
52+
'params': {
53+
'PAR1': 'VAL1',
54+
'PAR2': 'VAL2',
55+
'PAR3': 'VAL3'
56+
},
57+
'defines': {
58+
'DEF1': 'VAL1',
59+
'DEF2': 'VAL2',
60+
'DEF3': 'VAL3'
61+
},
62+
'hooks': {
63+
'precfg': ['CMD1', 'CMD2'],
64+
'postcfg': ['CMD1', 'CMD2'],
65+
'presyn': ['CMD1', 'CMD2'],
66+
'postsyn': ['CMD1', 'CMD2'],
67+
'prepar': ['CMD1', 'CMD2'],
68+
'postpar': ['CMD1', 'CMD2'],
69+
'prebit': ['CMD1', 'CMD2'],
70+
'postbit': ['CMD1', 'CMD2']
71+
},
72+
'options': {
73+
'prj': 'OPTS',
74+
'syn': 'OPTS',
75+
'pre': 'OPTS',
76+
'pre': 'OPTS'
77+
}
78+
}

0 commit comments

Comments
 (0)