about summary refs log tree commit diff stats
diff options
context:
space:
mode:
-rw-r--r--linux/labels_baremetal.subx16
-rw-r--r--linux/survey_baremetal.subx12
2 files changed, 12 insertions, 16 deletions
diff --git a/linux/labels_baremetal.subx b/linux/labels_baremetal.subx
index a4ea991d..e1743c0b 100644
--- a/linux/labels_baremetal.subx
+++ b/linux/labels_baremetal.subx
@@ -1,16 +1,14 @@
-# Assign addresses (co-ordinates) to instructions (landmarks) in a program
-# (landscape).
-# Read a list of addresses and labels from a file called 'labels',
-# then replace labels in stdin with their addresses.
+# Read a list of labels and their addresses from a file called 'labels', then
+# replace labels in stdin with their addresses.
 #
 # To build:
 #   $ bootstrap/bootstrap translate [01]*.subx subx-params.subx labels_baremetal.subx  -o labels_baremetal
 #
 # Stdin should be a stream of bytes and some interspersed labels. Comments and
-# '==' segment headers are allowed, but names are ignored. The emitted code
-# will all lie in a single contiguous address range starting at address 0x7c00.
-# Addresses in segment headers are optional. If provided, this program will
-# insert padding in the output until the desired address is reached.
+# '==' segment headers are allowed, but segment names are ignored. The emitted
+# code will all lie in a single contiguous address range starting at address
+# 0x7c00. Addresses in segment headers are optional. If provided, this program
+# will insert padding in the output until the desired address is reached.
 #
 #   $ cat x
 #   == code
@@ -26,7 +24,7 @@
 # The output is the stream of bytes without segment headers or label definitions,
 # and with label references replaced with numeric values/displacements.
 #
-#   $ cat x  |bootstrap/bootstrap run survey_baremetal labels
+#   $ cat x  |bootstrap/bootstrap run labels_baremetal labels
 #   # 0x7c00
 #   aa bb nn  # some computed address
 #   cc dd nn nn nn nn  # some computed displacement
diff --git a/linux/survey_baremetal.subx b/linux/survey_baremetal.subx
index 5a8f46af..40115cd8 100644
--- a/linux/survey_baremetal.subx
+++ b/linux/survey_baremetal.subx
@@ -1,15 +1,13 @@
-# Assign addresses (co-ordinates) to instructions (landmarks) in a program
-# (landscape).
+# Assign addresses (co-ordinates) to labels (landmarks) in a program
+# (landscape) on stdin.
 #
 # To build:
 #   $ bootstrap/bootstrap translate [01]*.subx subx-params.subx survey_baremetal.subx  -o survey_baremetal
 #
 # The expected input is a stream of bytes and some interspersed labels.
-# Comments and '==' segment headers are allowed, but names are ignored. The
-# emitted code will all lie in a single contiguous address range starting at
-# address 0x7c00. Addresses in segment headers are optional. If provided, this
-# program will insert padding in the output until the desired address is
-# reached.
+# Comments and '==' segment headers are allowed, but segment names are ignored.
+# Mappings between labels and addresses are emitted to stdout, assuming the
+# program starts at address 0x7c00. Addresses in segment headers are optional.
 #
 #   $ cat x
 #   == code
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