diff options
author | Mirza Krak <mirza.krak@endian.se> | 2017-05-23 15:14:12 +0200 |
---|---|---|
committer | Andrei Gherzan <andrei@gherzan.com> | 2017-05-26 12:16:52 +0100 |
commit | 34113350f4a4a49c9e1c665042e58396acfd358f (patch) | |
tree | 7ebb5155f1cb7fddd2e84846fcb4ab8916bd5ee4 /docs | |
parent | a30708d49c003c67cbeb75e30eaae2d26b3f1cf9 (diff) | |
download | meta-raspberrypi-34113350f4a4a49c9e1c665042e58396acfd358f.tar.gz |
docs: fix alignment of "code blocks"
We provide a lot of variable examples as code blocks in the following
format:
some text: `Variable`
or
some test:
`Variable`
Which is not as pretty as (when converted to html/pdf):
some text:
Variable
Converted all and hoppefully this will improve readability a bit.
Signed-off-by: Mirza Krak <mirza.krak@endian.se>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/contributing.md | 6 | ||||
-rw-r--r-- | docs/extra-apps.md | 3 | ||||
-rw-r--r-- | docs/extra-build-config.md | 63 |
3 files changed, 42 insertions, 30 deletions
diff --git a/docs/contributing.md b/docs/contributing.md index 370957d..728b00e 100644 --- a/docs/contributing.md +++ b/docs/contributing.md | |||
@@ -20,10 +20,12 @@ To contribute to this project you should send pull requests to the github mirror | |||
20 | the patches for review to the above specified mailing list. | 20 | the patches for review to the above specified mailing list. |
21 | 21 | ||
22 | When creating patches for the mailing list, please use something like: | 22 | When creating patches for the mailing list, please use something like: |
23 | `git format-patch -s --subject-prefix='meta-raspberrypi][PATCH' origin` | 23 | |
24 | git format-patch -s --subject-prefix='meta-raspberrypi][PATCH' origin | ||
24 | 25 | ||
25 | When sending patches to the mailing list, please use something like: | 26 | When sending patches to the mailing list, please use something like: |
26 | `git send-email --to yocto@yoctoproject.org <generated patch>` | 27 | |
28 | git send-email --to yocto@yoctoproject.org <generated patch> | ||
27 | 29 | ||
28 | ## Github issues | 30 | ## Github issues |
29 | 31 | ||
diff --git a/docs/extra-apps.md b/docs/extra-apps.md index b9ee2cb..9f9f465 100644 --- a/docs/extra-apps.md +++ b/docs/extra-apps.md | |||
@@ -5,4 +5,5 @@ | |||
5 | omxplayer depends on libav which has a commercial license. So in order to be | 5 | omxplayer depends on libav which has a commercial license. So in order to be |
6 | able to compile omxplayer you will need to whiteflag the commercial | 6 | able to compile omxplayer you will need to whiteflag the commercial |
7 | licenseadding to you local.conf: | 7 | licenseadding to you local.conf: |
8 | `LICENSE_FLAGS_WHITELIST = "commercial"` | 8 | |
9 | LICENSE_FLAGS_WHITELIST = "commercial" | ||
diff --git a/docs/extra-build-config.md b/docs/extra-build-config.md index cce2bf7..4486f5a 100644 --- a/docs/extra-build-config.md +++ b/docs/extra-build-config.md | |||
@@ -8,13 +8,13 @@ specific to it. For the rest please check: | |||
8 | ## Compressed deployed files | 8 | ## Compressed deployed files |
9 | 9 | ||
10 | 1. Overwrite IMAGE_FSTYPES in local.conf | 10 | 1. Overwrite IMAGE_FSTYPES in local.conf |
11 | * `IMAGE_FSTYPES = "tar.bz2 ext3.xz"` | 11 | * `IMAGE_FSTYPES = "tar.bz2 ext3.xz"` |
12 | 12 | ||
13 | 2. Overwrite SDIMG_ROOTFS_TYPE in local.conf | 13 | 2. Overwrite SDIMG_ROOTFS_TYPE in local.conf |
14 | * `SDIMG_ROOTFS_TYPE = "ext3.xz"` | 14 | * `SDIMG_ROOTFS_TYPE = "ext3.xz"` |
15 | 15 | ||
16 | 3. Overwrite SDIMG_COMPRESSION in local.conf | 16 | 3. Overwrite SDIMG_COMPRESSION in local.conf |
17 | * `SDIMG_COMPRESSION = "xz"` | 17 | * `SDIMG_COMPRESSION = "xz"` |
18 | 18 | ||
19 | Accommodate the values above to your own needs (ex: ext3 / ext4). | 19 | Accommodate the values above to your own needs (ex: ext3 / ext4). |
20 | 20 | ||
@@ -36,22 +36,22 @@ Accommodate the values above to your own needs (ex: ext3 / ext4). | |||
36 | 36 | ||
37 | To add you own licenses use variables `KEY_DECODE_MPG2` and `KEY_DECODE_WVC1` in | 37 | To add you own licenses use variables `KEY_DECODE_MPG2` and `KEY_DECODE_WVC1` in |
38 | local.conf. Example: | 38 | local.conf. Example: |
39 | ``` | 39 | |
40 | KEY_DECODE_MPG2 = "12345678" | 40 | KEY_DECODE_MPG2 = "12345678" |
41 | KEY_DECODE_WVC1 = "12345678" | 41 | KEY_DECODE_WVC1 = "12345678" |
42 | ``` | ||
43 | 42 | ||
44 | You can supply more licenses separated by comma. Example: | 43 | You can supply more licenses separated by comma. Example: |
45 | ``` | 44 | |
46 | KEY_DECODE_WVC1 = "0x12345678,0xabcdabcd,0x87654321" | 45 | KEY_DECODE_WVC1 = "0x12345678,0xabcdabcd,0x87654321" |
47 | ``` | 46 | |
48 | 47 | ||
49 | ## Disable overscan | 48 | ## Disable overscan |
50 | 49 | ||
51 | By default the GPU adds a black border around the video output to compensate for | 50 | By default the GPU adds a black border around the video output to compensate for |
52 | TVs which cut off part of the image. To disable this set this variable in | 51 | TVs which cut off part of the image. To disable this set this variable in |
53 | local.conf: | 52 | local.conf: |
54 | `DISABLE_OVERSCAN = "1"` | 53 | |
54 | DISABLE_OVERSCAN = "1" | ||
55 | 55 | ||
56 | ## Set overclocking options | 56 | ## Set overclocking options |
57 | 57 | ||
@@ -59,23 +59,24 @@ The Raspberry PI can be overclocked. As of now overclocking up to the "Turbo | |||
59 | Mode" is officially supported by the raspbery and does not void warranty. Check | 59 | Mode" is officially supported by the raspbery and does not void warranty. Check |
60 | the config.txt for a detailed description of options and modes. Example turbo | 60 | the config.txt for a detailed description of options and modes. Example turbo |
61 | mode: | 61 | mode: |
62 | ``` | 62 | |
63 | ARM_FREQ = "1000" | 63 | ARM_FREQ = "1000" |
64 | CORE_FREQ = "500" | 64 | CORE_FREQ = "500" |
65 | SDRAM_FREQ = "500" | 65 | SDRAM_FREQ = "500" |
66 | OVER_VOLTAGE = "6" | 66 | OVER_VOLTAGE = "6" |
67 | ``` | ||
68 | 67 | ||
69 | ## Video camera support with V4L2 drivers | 68 | ## Video camera support with V4L2 drivers |
70 | 69 | ||
71 | Set this variable to enable support for the video camera (Linux 3.12.4+ | 70 | Set this variable to enable support for the video camera (Linux 3.12.4+ |
72 | required) | 71 | required): |
73 | `VIDEO_CAMERA = "1"` | 72 | |
73 | VIDEO_CAMERA = "1" | ||
74 | 74 | ||
75 | ## Enable offline compositing support | 75 | ## Enable offline compositing support |
76 | 76 | ||
77 | Set this variable to enable support for dispmanx offline compositing: | 77 | Set this variable to enable support for dispmanx offline compositing: |
78 | `DISPMANX_OFFLINE = "1"` | 78 | |
79 | DISPMANX_OFFLINE = "1" | ||
79 | 80 | ||
80 | This will enable the firmware to fall back to off-line compositing of Dispmanx | 81 | This will enable the firmware to fall back to off-line compositing of Dispmanx |
81 | elements. Normally the compositing is done on-line, during scanout, but cannot | 82 | elements. Normally the compositing is done on-line, during scanout, but cannot |
@@ -91,12 +92,14 @@ See: <http://wayland.freedesktop.org/raspberrypi.html> | |||
91 | 92 | ||
92 | To add the kdbg over console (kgdboc) parameter to the kernel command line, set | 93 | To add the kdbg over console (kgdboc) parameter to the kernel command line, set |
93 | this variable in local.conf: | 94 | this variable in local.conf: |
94 | `ENABLE_KGDB = "1"` | 95 | |
96 | ENABLE_KGDB = "1" | ||
95 | 97 | ||
96 | ## Boot to U-Boot | 98 | ## Boot to U-Boot |
97 | 99 | ||
98 | To have u-boot load kernel image, set in your local.conf: | 100 | To have u-boot load kernel image, set in your local.conf: |
99 | `KERNEL_IMAGETYPE = "uImage"` | 101 | |
102 | KERNEL_IMAGETYPE = "uImage" | ||
100 | 103 | ||
101 | This will make kernel.img be u-boot image which will load uImage. By default, | 104 | This will make kernel.img be u-boot image which will load uImage. By default, |
102 | kernel.img is the actual kernel image (ex. Image). | 105 | kernel.img is the actual kernel image (ex. Image). |
@@ -133,12 +136,14 @@ disabled for older kernel versions. | |||
133 | ## Enable SPI bus | 136 | ## Enable SPI bus |
134 | 137 | ||
135 | When using device tree kernels, set this variable to enable the SPI bus: | 138 | When using device tree kernels, set this variable to enable the SPI bus: |
136 | `ENABLE_SPI_BUS = "1"` | 139 | |
140 | ENABLE_SPI_BUS = "1" | ||
137 | 141 | ||
138 | ## Enable I2C | 142 | ## Enable I2C |
139 | 143 | ||
140 | When using device tree kernels, set this variable to enable I2C: | 144 | When using device tree kernels, set this variable to enable I2C: |
141 | `ENABLE_I2C = "1"` | 145 | |
146 | ENABLE_I2C = "1" | ||
142 | 147 | ||
143 | ## Enable PiTFT support | 148 | ## Enable PiTFT support |
144 | 149 | ||
@@ -154,7 +159,8 @@ and specified as well (dtoverlay=<driver> in config.txt). | |||
154 | 159 | ||
155 | Below is a list of currently supported PiTFT models in meta-raspberrypi, the | 160 | Below is a list of currently supported PiTFT models in meta-raspberrypi, the |
156 | modelname should be added as a MACHINE_FEATURES in local.conf like below: | 161 | modelname should be added as a MACHINE_FEATURES in local.conf like below: |
157 | `MACHINE_FEATURES += "pitft <modelname>"` | 162 | |
163 | MACHINE_FEATURES += "pitft <modelname>" | ||
158 | 164 | ||
159 | List of currently supported models: | 165 | List of currently supported models: |
160 | * pitft22 | 166 | * pitft22 |
@@ -166,7 +172,8 @@ List of currently supported models: | |||
166 | If you would like to use the Waveshare "C" 1024×600, 7 inch Capacitive Touch | 172 | If you would like to use the Waveshare "C" 1024×600, 7 inch Capacitive Touch |
167 | Screen LCD, HDMI interface (<http://www.waveshare.com/7inch-HDMI-LCD-C.htm>) Rev | 173 | Screen LCD, HDMI interface (<http://www.waveshare.com/7inch-HDMI-LCD-C.htm>) Rev |
168 | 2.1, please set the following in your local.conf: | 174 | 2.1, please set the following in your local.conf: |
169 | `WAVESHARE_1024X600_C_2_1 = "1"` | 175 | |
176 | WAVESHARE_1024X600_C_2_1 = "1" | ||
170 | 177 | ||
171 | ## Enable UART | 178 | ## Enable UART |
172 | 179 | ||
@@ -177,7 +184,9 @@ needs a fixed core frequency and enable_uart wil set it to the minimum. Certain | |||
177 | operations - 60fps h264 decode, high quality deinterlace - which aren't | 184 | operations - 60fps h264 decode, high quality deinterlace - which aren't |
178 | performed on the ARM may be affected, and we wouldn't want to do that to users | 185 | performed on the ARM may be affected, and we wouldn't want to do that to users |
179 | who don't want to use the serial port. Users who want serial console support on | 186 | who don't want to use the serial port. Users who want serial console support on |
180 | RaspberryPi3 will have to explicitely set in local.conf: `ENABLE_UART = "1"`. | 187 | RaspberryPi3 will have to explicitely set in local.conf: |
188 | |||
189 | ENABLE_UART = "1" | ||
181 | 190 | ||
182 | Ref.: | 191 | Ref.: |
183 | * <https://github.com/raspberrypi/firmware/issues/553> | 192 | * <https://github.com/raspberrypi/firmware/issues/553> |