Skip to content

Commit 21c44ea

Browse files
committed
Made some little changes in different files
1 parent e694cfb commit 21c44ea

File tree

5 files changed

+26
-21
lines changed

5 files changed

+26
-21
lines changed

Makefile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ user_manual_en:
88
en/embox_quick_overview_en.md \
99
en/embox_quick_start_en.md \
1010
en/embox_modular_structure_en.md \
11+
en/embox_build_en.md \
1112
en/platforms/embox_supported_platforms_en.md \
1213
en/platforms/embox_supported_platforms_qemu_en.md \
1314
en/platforms/embox_supported_platforms_x86_en.md \

en/embox_build_en.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ For example, the abstract module *heap_api*:
7979
```
8080
To add the *heap_simple* module,
8181
```
82-
module heap_simple extends heap_api {module heap_simple extends heap_api {
82+
module heap_simple extends heap_api {
8383
...
8484
}
8585
```
@@ -97,11 +97,11 @@ You can manage some flags of compilation. The "conf/build.conf" has them. For ex
9797
```
9898
CFLAGS += -O0
9999
```
100-
To build the Embox with optimization 2, you should the line above to the next one:
100+
To build the Embox with optimization 2, you should the line above change to the next one:
101101
```
102102
CFLAGS += -O2
103103
```
104-
Also another important flag is the *-g* linker flag, that is the same as adding debugging information in system image:
104+
Also another important flag is the *-g* linker flag, that is the same as adding debugging information in the system image:
105105
```
106106
LDFLAGS += -N -g
107107
```
@@ -160,7 +160,7 @@ The command below will allow you to get graph of modules in png-format:
160160
```
161161
$ make dot
162162
```
163-
После выполнения команды *$ make dot* появится файл *build/doc/embox.png*.After running *make dot* command the *build/doc/embox.png* will appear.
163+
After running the *make dot* command the *build/doc/embox.png* will appear.
164164

165165
You'll need to install the *graphviz* package:
166166
```

en/examples/embox_examples_opencv_stm32_en.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ This board has enough flash memory for OpenCV, so it's pretty easy to run a simp
1919

2020
3. Run `edges 20` on Embox console
2121

22+
![image](https://raw.githubusercontent.com/wiki/embox/embox/images/platforms/stm32f769idiscovery-opencv.jpg)
2223

2324
## STM32F746GDISCOVERY
2425
This board has only 1MiB flash memory, so it's a little bit more compilated. OpenCV requires too much read-only memory (it's mostly code), so you have to use QSPI flash to run it.

ru/embox_build_ru.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080
```
8181
Для подключения модуля *heap_simple*, который также реализует данный интерфейс *heap_api*
8282
```
83-
module heap_simple extends heap_api {module heap_simple extends heap_api {
83+
module heap_simple extends heap_api {
8484
...
8585
}
8686
```
Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Пример “Hello World”
2-
Чтобы написать пример команды "Hello, World!" -- нужно создать файл "hello.c" с исходным кодом на языке "C":
1+
# Пример “Hello, World!
2+
Чтобы написать пример команды "Hello, World!" -- нужно создать файл **hello.c** с исходным кодом на языке **C**:
33
```c
44
#include <stdio.h>
55

@@ -11,15 +11,17 @@ int main(int argc, char **argv) {
1111
И затем добавить описание модуля.
1212
1313
## Добавление модуля
14-
Все модули и интерфейсы системы описываются в "my"-файлах. **"My"-файлы** -- это файлы, имеющие расширение **".my"** или имя **"Mybuild"**.
14+
Все модули и интерфейсы системы описываются в my-файлах.
1515
16-
**Структурно каждый "my"-файл содержит:**
16+
**My-файлы** -- это файлы, имеющие расширение **.my** или имя **Mybuild** (без расширения).
17+
18+
**Структурно каждый my-файл содержит:**
1719
1820
* объявление пакета, которому принадлежат все определяемые в файле сущности
1921
* список импортируемых имен из других пакетов (опционально)
2022
* определения самих модулей и интерфейсов
2123
22-
Например, чтобы добавить команду в командный интерпретатор, встроенный в ядро, нужно создать файл "Hello.my" с таким содержанием:
24+
Например, чтобы добавить команду в командный интерпретатор, встроенный в ядро, нужно создать файл **Hello.my** с таким содержанием:
2325
```java
2426
package embox.cmd.tutorial
2527
@@ -29,28 +31,28 @@ module hello {
2931
source "hello.c"
3032
}
3133
```
32-
В этом примере мы описали простой модуль с единственным атрибутом "source" -- файлом "hello.c", который будем скомпилирован и связан с ядром, если модуль будет добавлен в сборку.
34+
В этом примере мы описали простой модуль с единственным атрибутом **source** -- файлом **hello.c**, который будет скомпилирован и связан с ядром, если модуль будет добавлен в сборку.
3335

34-
**Аннотация "@Cmd"** регистрирует модуль в системе как команду встроенного интерпретатора. Это позволяет запускать модуль по имени "hello".
36+
Аннотация **@Cmd** регистрирует модуль в системе как команду встроенного интерпретатора. Это позволяет запускать модуль по имени *hello*.
3537

36-
Опциональный **параметр "help"** содержит строку, которая будет выведана при запуске команды help hello (если модуль "help" включен в сборку).
38+
Опциональный параметр **help** содержит строку, которая будет выведана при запуске команды *help hello* (если модуль help включен в сборку).
3739

38-
**Аннотация "@AutoCmd"** позволяет использовать привычную функцию "main()" в качестве точки входа в программу.
40+
Аннотация **@AutoCmd** позволяет использовать привычную функцию *main()* в качестве точки входа в программу.
3941

4042
### Атрибуты модуля
41-
**Модуль "hello"** достаточно примитивен и не определяет никаких внешних зависимостей или опций.
42-
Единственный его атрибут - "source" - определяет набор исходных файлов для компиляции.
43+
Модуль **hello** достаточно примитивен и не определяет никаких внешних зависимостей или опций.
44+
Единственный его атрибут - *source* - определяет набор исходных файлов для компиляции.
4345

4446
### Опции
45-
Теперь давайте зададим строку приветствия в виде опции. Для этого мы воспользуемся атрибутом "option" и добавим модулю "hello" опцию "greeting":
47+
Теперь давайте зададим строку приветствия в виде опции. Для этого мы воспользуемся атрибутом **option** и добавим модулю *hello* опцию *greeting*:
4648
```c
4749
// ...
4850
module hello {
4951
// ...
5052
option string greeting = "World"
5153
}
5254
```
53-
И изменим файл "hello.c" таким образом, чтобы команда после слова "Hello" выводила строку, которая содержится в значении опции "greeting":
55+
А также изменим файл **hello.c** таким образом, чтобы команда после слова *Hello* выводила строку, которая содержится в значении опции *greeting*:
5456
```c
5557
#define GREETING OPTION_STRING_GET(greeting)
5658

@@ -60,7 +62,7 @@ module hello {
6062
```
6163
6264
## Включение в сборку
63-
Для того, чтобы новый модуль оказался в результирующем образе ядра, его необходимо добавить в конфигурацию сборки, которая описывается в файле "conf/mods.conf":
65+
Для того, чтобы новый модуль оказался в конечном образе ядра, его необходимо добавить в конфигурацию сборки, которая описывается в файле *conf/mods.conf*:
6466
```
6567
package genconfig
6668

@@ -76,13 +78,14 @@ configuration conf {
7678
// ...
7779
```
7880
Как и многие атрибуты модуля, конфигурация поддерживает добавление аннотаций.
79-
Чаще всего используется аннотация **"@Runlevel"**. Она позволяет загружать модули поэтапно и определять порядок их загрузки.
81+
82+
Чаще всего используется аннотация **@Runlevel**. Она позволяет загружать модули поэтапно и определять порядок их загрузки.
8083
8184
**Как правило, на ранних стадиях (runlevel=0) загружаются:**
8285
8386
* драйверы устройств, необходимых для корректного функционирования системы (например, контроллер прерываний)
8487
* основные компоненты системы
8588
Также на ранних стадиях исполняются низкоуровневые тесты и процедуры самодиагностики.
8689
87-
**Обратите внимание**: порядок загрузки модулей по зависимостям имеет самый высокий приоритет. Поэтому опция "@Runlevel" работает в тех случаях, когда она не противоречит порядку загрузки по зависимостям.
90+
**Обратите внимание**: порядок загрузки модулей по зависимостям имеет самый высокий приоритет. Поэтому опция *@Runlevel* работает в тех случаях, когда она не противоречит порядку загрузки по зависимостям.
8891

0 commit comments

Comments
 (0)