diff options
| author | Andrei Gherzan <andrei@gherzan.com> | 2017-06-02 12:27:12 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-06-02 12:27:12 +0100 |
| commit | 31a813c06954fed9423fabd9f21b5dd24ebce09e (patch) | |
| tree | 84028e2ad4218c7216d51ae5b371bbff60130818 | |
| parent | f6764c85e3638cc231df5b1cc78e4aa46f587519 (diff) | |
| parent | 081405feaa544b5b5c55a3ac72e629f3f3869a26 (diff) | |
| download | meta-raspberrypi-31a813c06954fed9423fabd9f21b5dd24ebce09e.tar.gz | |
Merge pull request #81 from agherzan/master
[pyro] Update to follow master
| -rw-r--r-- | .gitignore | 1 | ||||
| -rw-r--r-- | README.md | 281 | ||||
| -rw-r--r-- | docs/Makefile | 225 | ||||
| -rw-r--r-- | docs/conf.py | 343 | ||||
| -rw-r--r-- | docs/contributing.md | 38 | ||||
| -rw-r--r-- | docs/extra-apps.md | 9 | ||||
| -rw-r--r-- | docs/extra-build-config.md | 180 | ||||
| -rw-r--r-- | docs/index.rst | 26 | ||||
| -rw-r--r-- | docs/layer-contents.md | 24 | ||||
| l--------- | docs/readme.md | 1 | ||||
| -rw-r--r-- | recipes-devtools/bcm2835/bcm2835_1.52.bb | 2 | ||||
| -rw-r--r-- | recipes-kernel/linux/linux-raspberrypi-dev.bb (renamed from recipes-kernel/linux/linux-raspberrypi_dev.bb) | 9 |
12 files changed, 880 insertions, 259 deletions
| @@ -4,3 +4,4 @@ build* | |||
| 4 | *.orig | 4 | *.orig |
| 5 | *.rej | 5 | *.rej |
| 6 | *.log | 6 | *.log |
| 7 | docs/_build | ||
| @@ -1,6 +1,6 @@ | |||
| 1 | # meta-raspberrypi | 1 | # meta-raspberrypi |
| 2 | 2 | ||
| 3 | Yocto BSP layer for the Raspberry Pi boards - http://www.raspberrypi.org/ . | 3 | Yocto BSP layer for the Raspberry Pi boards - <http://www.raspberrypi.org/>. |
| 4 | 4 | ||
| 5 | [](https://yocto-ci.resin.io/job/meta-raspberrypi1) | 5 | [](https://yocto-ci.resin.io/job/meta-raspberrypi1) |
| 6 | [](https://yocto-ci.resin.io/job/meta-raspberrypi2) | 6 | [](https://yocto-ci.resin.io/job/meta-raspberrypi2) |
| @@ -8,283 +8,48 @@ Yocto BSP layer for the Raspberry Pi boards - http://www.raspberrypi.org/ . | |||
| 8 | [](https://gitter.im/agherzan/meta-raspberrypi) | 8 | [](https://gitter.im/agherzan/meta-raspberrypi) |
| 9 | 9 | ||
| 10 | ## Quick links | 10 | ## Quick links |
| 11 | * Git repository web frontend: http://git.yoctoproject.org/cgit/cgit.cgi/meta-raspberrypi/ | ||
| 12 | * Mailing list (yocto mailing list): yocto@yoctoproject.org | ||
| 13 | * Issues management (Github Issues): https://github.com/agherzan/meta-raspberrypi/issues | ||
| 14 | 11 | ||
| 15 | ## Contents | 12 | * Git repository web frontend: |
| 16 | ``` | 13 | <http://git.yoctoproject.org/cgit/cgit.cgi/meta-raspberrypi/> |
| 17 | 1. Description | 14 | * Mailing list (yocto mailing list): <yocto@yoctoproject.org> |
| 18 | 2. Yocto BSP Layer - Raspberry Pi | 15 | * Issues management (Github Issues): |
| 19 | 2.A. How to use it | 16 | <https://github.com/agherzan/meta-raspberrypi/issues> |
| 20 | 2.B. Images | 17 | |
| 21 | 3. Optional build configuration | 18 | ## Description |
| 22 | 3.A. Compressed deployed files | ||
| 23 | 3.B. GPU memory | ||
| 24 | 3.C. Add purchased license codecs | ||
| 25 | 3.D. Disable overscan | ||
| 26 | 3.E. Set overclocking options | ||
| 27 | 3.F. Video camera support with V4L2 drivers | ||
| 28 | 3.G. Enable offline compositing support | ||
| 29 | 3.H. Enable kgdb over console support | ||
| 30 | 3.I. Boot to U-Boot | ||
| 31 | 3.J. Image with Initramfs | ||
| 32 | 3.K. Device tree support | ||
| 33 | 3.L. Enable SPI bus | ||
| 34 | 3.M. Enable I2C | ||
| 35 | 3.N. Enable PiTFT support | ||
| 36 | 3.O. Misc. display | ||
| 37 | 3.P. Enable UART support | ||
| 38 | 4. Extra apps | ||
| 39 | 4.A. omxplayer | ||
| 40 | 5. Board Configuration | ||
| 41 | 5.A. Audio Routing | ||
| 42 | 6. Source code and mirrors | ||
| 43 | 7. Contribution | ||
| 44 | 7.A. Mailing list | ||
| 45 | 7.B. Patches and pull requests | ||
| 46 | 7.C. Github Issues | ||
| 47 | 8. Maintainers | ||
| 48 | ``` | ||
| 49 | 19 | ||
| 50 | ### 1. Description | ||
| 51 | This is the general hardware specific BSP overlay for the RaspberryPi device. | 20 | This is the general hardware specific BSP overlay for the RaspberryPi device. |
| 52 | More information can be found at: http://www.raspberrypi.org/ (Official Site) | 21 | |
| 53 | The core BSP part of meta-raspberrypi should work with different OpenEmbedded/Yocto distributions and layer stacks, such as: | 22 | More information can be found at: <http://www.raspberrypi.org/> (Official Site) |
| 23 | |||
| 24 | The core BSP part of meta-raspberrypi should work with different | ||
| 25 | OpenEmbedded/Yocto distributions and layer stacks, such as: | ||
| 26 | |||
| 54 | * Distro-less (only with OE-Core). | 27 | * Distro-less (only with OE-Core). |
| 55 | * Angstrom. | 28 | * Angstrom. |
| 56 | * Yocto/Poky (main focus of testing). | 29 | * Yocto/Poky (main focus of testing). |
| 57 | 30 | ||
| 58 | ### 2. Yocto BSP Layer - RaspberryPi | 31 | ## Dependencies |
| 32 | |||
| 59 | This layer depends on: | 33 | This layer depends on: |
| 34 | |||
| 60 | * URI: git://git.yoctoproject.org/poky | 35 | * URI: git://git.yoctoproject.org/poky |
| 61 | * branch: master | 36 | * branch: master |
| 62 | * revision: HEAD | 37 | * revision: HEAD |
| 38 | |||
| 63 | * URI: git://git.openembedded.org/meta-openembedded | 39 | * URI: git://git.openembedded.org/meta-openembedded |
| 64 | * layers: meta-oe, meta-multimedia, meta-networking, meta-python | 40 | * layers: meta-oe, meta-multimedia, meta-networking, meta-python |
| 65 | * branch: master | 41 | * branch: master |
| 66 | * revision: HEAD | 42 | * revision: HEAD |
| 67 | 43 | ||
| 68 | #### 2.A. How to use it | 44 | ## Quick Start |
| 45 | |||
| 69 | 1. source poky/oe-init-build-env rpi-build | 46 | 1. source poky/oe-init-build-env rpi-build |
| 70 | 2. Add this layer to bblayers.conf and dthe dependencies above | 47 | 2. Add this layer to bblayers.conf and the dependencies above |
| 71 | 3. Set MACHINE in local.conf to one of the supported boards: | 48 | 3. Set MACHINE in local.conf to one of the supported boards |
| 72 | * raspberrypi | ||
| 73 | * raspberrypi0 | ||
| 74 | * raspberrypi0-wifi | ||
| 75 | * raspberrypi2 | ||
| 76 | * raspberrypi3 | ||
| 77 | * raspberrypi3-64 (64 bit kernel & userspace) | ||
| 78 | * raspberrypi-cm (dummy alias for raspberrypi) | ||
| 79 | * raspberrypi-cm3 (dummy alias for raspberrypi2) | ||
| 80 | 4. bitbake rpi-hwup-image | 49 | 4. bitbake rpi-hwup-image |
| 81 | 5. dd to a SD card the generated sdimg file (use xzcat if rpi-sdimg.xz is used) | 50 | 5. dd to a SD card the generated sdimg file (use xzcat if rpi-sdimg.xz is used) |
| 82 | 6. Boot your RPI. | 51 | 6. Boot your RPI. |
| 83 | 52 | ||
| 84 | #### 2.B. Images | 53 | ## Maintainers |
| 85 | * rpi-hwup-image | ||
| 86 | * Hardware up image | ||
| 87 | * rpi-basic-image | ||
| 88 | * Based on rpi-hwup-image with some added features (ex: splash) | ||
| 89 | * rpi-test-image | ||
| 90 | * Image based on rpi-basic-image which includes most of the packages in this layer and some media samples. | ||
| 91 | |||
| 92 | ### 3. Optional build configuration | ||
| 93 | There are a set of ways in which a user can influence different paramenters of the build. We list here the ones that are closely related to this BSP or specific to it. For the rest please check: http://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html | ||
| 94 | |||
| 95 | #### 3.A. Compressed deployed files | ||
| 96 | 1. Overwrite IMAGE_FSTYPES in local.conf | ||
| 97 | * `IMAGE_FSTYPES = "tar.bz2 ext3.xz"` | ||
| 98 | 2. Overwrite SDIMG_ROOTFS_TYPE in local.conf | ||
| 99 | * `SDIMG_ROOTFS_TYPE = "ext3.xz"` | ||
| 100 | 3. Overwrite SDIMG_COMPRESSION in local.conf | ||
| 101 | * `SDIMG_COMPRESSION = "xz"` | ||
| 102 | |||
| 103 | Accommodate the values above to your own needs (ex: ext3 / ext4). | ||
| 104 | |||
| 105 | #### 3.B. GPU memory | ||
| 106 | | Variable | Details | | ||
| 107 | |----------------|---------------------------------------------------------------------| | ||
| 108 | | `GPU_MEM` | GPU memory in megabyte. Sets the memory split between the ARM and | | ||
| 109 | | | GPU. ARM gets the remaining memory. Min 16. Default 64. | | ||
| 110 | | `GPU_MEM_256` | GPU memory in megabyte for the 256MB Raspberry Pi. Ignored by the | | ||
| 111 | | | 512MB RP. Overrides gpu_mem. Max 192. Default not set. | | ||
| 112 | | `GPU_MEM_512` | GPU memory in megabyte for the 512MB Raspberry Pi. Ignored by the | | ||
| 113 | | | 256MB RP. Overrides gpu_mem. Max 448. Default not set. | | ||
| 114 | | `GPU_MEM_1024` | GPU memory in megabyte for the 1024MB Raspberry Pi. Ignored by the | | ||
| 115 | | | 256MB/512MB RP. Overrides gpu_mem. Max 944. Default not set. | | ||
| 116 | |||
| 117 | #### 3.C. Add purchased license codecs | ||
| 118 | To add you own licenses use variables `KEY_DECODE_MPG2` and `KEY_DECODE_WVC1` in local.conf. Example: | ||
| 119 | ``` | ||
| 120 | KEY_DECODE_MPG2 = "12345678" | ||
| 121 | KEY_DECODE_WVC1 = "12345678" | ||
| 122 | ``` | ||
| 123 | You can supply more licenses separated by comma. Example: | ||
| 124 | ``` | ||
| 125 | KEY_DECODE_WVC1 = "0x12345678,0xabcdabcd,0x87654321" | ||
| 126 | ``` | ||
| 127 | |||
| 128 | #### 3.D. Disable overscan | ||
| 129 | By default the GPU adds a black border around the video output to compensate for TVs which cut off part of the image. To disable this set this variable in local.conf: | ||
| 130 | `DISABLE_OVERSCAN = "1"` | ||
| 131 | |||
| 132 | #### 3.E. Set overclocking options | ||
| 133 | The Raspberry PI can be overclocked. As of now overclocking up to the "Turbo Mode" is officially supported by the raspbery and does not void warranty. Check the config.txt for a detailed description of options and modes. Example turbo mode: | ||
| 134 | ``` | ||
| 135 | ARM_FREQ = "1000" | ||
| 136 | CORE_FREQ = "500" | ||
| 137 | SDRAM_FREQ = "500" | ||
| 138 | OVER_VOLTAGE = "6" | ||
| 139 | ``` | ||
| 140 | |||
| 141 | #### 3.F. Video camera support with V4L2 drivers | ||
| 142 | Set this variable to enable support for the video camera (Linux 3.12.4+ required) | ||
| 143 | `VIDEO_CAMERA = "1"` | ||
| 144 | |||
| 145 | #### 3.G. Enable offline compositing support | ||
| 146 | Set this variable to enable support for dispmanx offline compositing: | ||
| 147 | `DISPMANX_OFFLINE = "1"` | ||
| 148 | |||
| 149 | This will enable the firmware to fall back to off-line compositing of Dispmanx elements. Normally the compositing is done on-line, during scanout, but cannot handle too many elements. With off-line enabled, an off-screen buffer is allocated for compositing. When scene complexity (number and sizes | ||
| 150 | of elements) is high, compositing will happen off-line into the buffer. | ||
| 151 | |||
| 152 | Heavily recommended for Wayland/Weston. | ||
| 153 | |||
| 154 | See: http://wayland.freedesktop.org/raspberrypi.html | ||
| 155 | |||
| 156 | #### 3.H. Enable kgdb over console support | ||
| 157 | To add the kdbg over console (kgdboc) parameter to the kernel command line, set this variable in local.conf: | ||
| 158 | `ENABLE_KGDB = "1"` | ||
| 159 | |||
| 160 | #### 3.I. Boot to U-Boot | ||
| 161 | To have u-boot load kernel image, set in your local.conf: | ||
| 162 | `KERNEL_IMAGETYPE = "uImage"` | ||
| 163 | |||
| 164 | This will make kernel.img be u-boot image which will load uImage. By default, kernel.img is the actual kernel image (ex. Image). | ||
| 165 | |||
| 166 | #### 3.J. Image with Initramfs | ||
| 167 | To build an initramfs image : | ||
| 168 | * Set this 3 kernel variables (in linux-raspberrypi.inc for example) | ||
| 169 | - kernel_configure_variable BLK_DEV_INITRD y | ||
| 170 | - kernel_configure_variable INITRAMFS_SOURCE "" | ||
| 171 | - kernel_configure_variable RD_GZIP y | ||
| 172 | * Set the yocto variables (in linux-raspberrypi.inc for example) | ||
| 173 | - `INITRAMFS_IMAGE = "<a name for your initramfs image>"` | ||
| 174 | - `INITRAMFS_IMAGE_BUNDLE = "1"` | ||
| 175 | * Set the meta-rasberrypi variable (in raspberrypi.conf for example) | ||
| 176 | - `KERNEL_INITRAMFS = "-initramfs"` | ||
| 177 | |||
| 178 | #### 3.K. Device tree support | ||
| 179 | Device tree for RPi is only supported when using linux-raspberrypi 3.18+ kernels. | ||
| 180 | * Set `KERNEL_DEVICETREE` (in conf/machine/raspberrypi.conf) | ||
| 181 | - the trailer is added to the kernel image before kernel install task. While creating the SDCard image, this modified kernel is put on boot partition (as kernel.img) as well as DeviceTree blobs (.dtb files). | ||
| 182 | |||
| 183 | NOTE: `KERNEL_DEVICETREE` is default enabled for kernel >= 3.18 and always disabled for | ||
| 184 | older kernel versions. | ||
| 185 | |||
| 186 | #### 3.L. Enable SPI bus | ||
| 187 | When using device tree kernels, set this variable to enable the SPI bus: | ||
| 188 | `ENABLE_SPI_BUS = "1"` | ||
| 189 | |||
| 190 | #### 3.M. Enable I2C | ||
| 191 | When using device tree kernels, set this variable to enable I2C: | ||
| 192 | `ENABLE_I2C = "1"` | ||
| 193 | |||
| 194 | #### 3.N. Enable PiTFT support | ||
| 195 | Basic support for using PiTFT screens can be enabled by adding below in local.conf: | ||
| 196 | |||
| 197 | * `MACHINE_FEATURES += "pitft"` | ||
| 198 | - This will enable SPI bus and i2c device-trees, it will also setup framebuffer for console and x server on PiTFT. | ||
| 199 | |||
| 200 | NOTE: To get this working the overlay for the PiTFT model must be build, added and specified as well (dtoverlay=<driver> in config.txt). | ||
| 201 | |||
| 202 | Below is a list of currently supported PiTFT models in meta-raspberrypi, the modelname should be added as a MACHINE_FEATURES in local.conf like below: | ||
| 203 | `MACHINE_FEATURES += "pitft <modelname>"` | ||
| 204 | |||
| 205 | List of currently supported models: | ||
| 206 | * pitft22 | ||
| 207 | * pitft28r | ||
| 208 | * pitft35r | ||
| 209 | |||
| 210 | #### 3.O. Misc. display | ||
| 211 | If you would like to use the Waveshare "C" 1024×600, 7 inch Capacitive Touch Screen LCD, HDMI interface (http://www.waveshare.com/7inch-HDMI-LCD-C.htm) Rev 2.1, please set the following in your local.conf: | ||
| 212 | `WAVESHARE_1024X600_C_2_1 = "1"` | ||
| 213 | |||
| 214 | #### 3.P. Enable UART | ||
| 215 | RaspberryPi 0, 1, 2 and CM will have UART console enabled by default. | ||
| 216 | |||
| 217 | RaspberryPi 0 WiFi and 3 does not have the UART enabled by default because this needs a fixed core frequency and enable_uart wil set it to the minimum. Certain operations - 60fps h264 decode, high quality deinterlace - which aren't performed on the ARM may be affected, and we wouldn't want to do that to users | ||
| 218 | who don't want to use the serial port. Users who want serial console support on RaspberryPi3 will have to explicitely set in local.conf: `ENABLE_UART = "1"`. | ||
| 219 | |||
| 220 | Ref.: | ||
| 221 | * https://github.com/raspberrypi/firmware/issues/553 | ||
| 222 | * https://github.com/RPi-Distro/repo/issues/22 | ||
| 223 | |||
| 224 | ### 4. Extra apps | ||
| 225 | |||
| 226 | #### 4.A. omxplayer | ||
| 227 | omxplayer depends on libav which has a commercial license. So in order to be able to compile omxplayer you will need to whiteflag the commercial licenseadding to you local.conf: | ||
| 228 | `LICENSE_FLAGS_WHITELIST = "commercial"` | ||
| 229 | |||
| 230 | ### 5. Board Configuration | ||
| 231 | |||
| 232 | #### 5.A. Audio Routing | ||
| 233 | To load audio driver | ||
| 234 | `modprobe snd-bcm2835` | ||
| 235 | To test audio playback | ||
| 236 | `aplay test.wav` | ||
| 237 | |||
| 238 | Note that without HDMI connected this emits audio from the 3.5in jack connector as expected. However With an HDMI display connected there is no audio output from the jack connector. | ||
| 239 | |||
| 240 | To force the audio routing via the 3.5in jack connector use | ||
| 241 | `amixer cset numid=3 1` | ||
| 242 | |||
| 243 | Options to amixer cset are: | ||
| 244 | ``` | ||
| 245 | 0=auto | ||
| 246 | 1=headphones | ||
| 247 | 2=hdmi | ||
| 248 | ``` | ||
| 249 | |||
| 250 | ### 6. Source code and mirrors | ||
| 251 | |||
| 252 | Main repo: | ||
| 253 | * git://git.yoctoproject.org/meta-raspberrypi | ||
| 254 | * http://git.yoctoproject.org/git/meta-raspberrypi | ||
| 255 | |||
| 256 | Github mirror: | ||
| 257 | * https://github.com/agherzan/meta-raspberrypi | ||
| 258 | |||
| 259 | Bitbucket mirror: | ||
| 260 | * https://bitbucket.org/agherzan/meta-raspberrypi | ||
| 261 | |||
| 262 | |||
| 263 | ### 7. Contributing | ||
| 264 | |||
| 265 | #### 7.A. Mailing list | ||
| 266 | The main communication tool we use is a mailing list: | ||
| 267 | * yocto@yoctoproject.org | ||
| 268 | * https://lists.yoctoproject.org/listinfo/yocto | ||
| 269 | |||
| 270 | Feel free to ask any kind of questions but always prepend your email subject with "[meta-raspberrypi]". This is because we use the 'yocto' mailing list and not a perticular 'meta-raspberrypi' mailing list. | ||
| 271 | |||
| 272 | #### 7.B. Patches and pull requests | ||
| 273 | All the contributions should be compliant with the openembedded patch guidelines: http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines | ||
| 274 | |||
| 275 | To contribute to this project you should send pull requests to the github mirror (https://github.com/agherzan/meta-raspberrypi). **Additionally** you can send the patches for review to the above specified mailing list. | ||
| 276 | |||
| 277 | When creating patches for the mailing list, please use something like: | ||
| 278 | `git format-patch -s --subject-prefix='meta-raspberrypi][PATCH' origin` | ||
| 279 | |||
| 280 | When sending patches to the mailing list, please use something like: | ||
| 281 | `git send-email --to yocto@yoctoproject.org <generated patch>` | ||
| 282 | |||
| 283 | #### 7.B. Github issues | ||
| 284 | In order to manage and trace the meta-raspberrypi issues, we use github issues: https://github.com/agherzan/meta-raspberrypi/issues | ||
| 285 | |||
| 286 | If you push patches which have a github issue associated, please provide the issue number in the commit log just before "Signed-off-by" line(s). Example line for a bug: | ||
| 287 | `[Issue #13]` | ||
| 288 | 54 | ||
| 289 | ### 8. Maintainers | ||
| 290 | * Andrei Gherzan `<andrei at gherzan.ro>` | 55 | * Andrei Gherzan `<andrei at gherzan.ro>` |
diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0de87f --- /dev/null +++ b/docs/Makefile | |||
| @@ -0,0 +1,225 @@ | |||
| 1 | # Makefile for Sphinx documentation | ||
| 2 | # | ||
| 3 | |||
| 4 | # You can set these variables from the command line. | ||
| 5 | SPHINXOPTS = | ||
| 6 | SPHINXBUILD = sphinx-build | ||
| 7 | PAPER = | ||
| 8 | BUILDDIR = _build | ||
| 9 | |||
| 10 | # Internal variables. | ||
| 11 | PAPEROPT_a4 = -D latex_paper_size=a4 | ||
| 12 | PAPEROPT_letter = -D latex_paper_size=letter | ||
| 13 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
| 14 | # the i18n builder cannot share the environment and doctrees with the others | ||
| 15 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . | ||
| 16 | |||
| 17 | .PHONY: help | ||
| 18 | help: | ||
| 19 | @echo "Please use \`make <target>' where <target> is one of" | ||
| 20 | @echo " html to make standalone HTML files" | ||
| 21 | @echo " dirhtml to make HTML files named index.html in directories" | ||
| 22 | @echo " singlehtml to make a single large HTML file" | ||
| 23 | @echo " pickle to make pickle files" | ||
| 24 | @echo " json to make JSON files" | ||
| 25 | @echo " htmlhelp to make HTML files and a HTML help project" | ||
| 26 | @echo " qthelp to make HTML files and a qthelp project" | ||
| 27 | @echo " applehelp to make an Apple Help Book" | ||
| 28 | @echo " devhelp to make HTML files and a Devhelp project" | ||
| 29 | @echo " epub to make an epub" | ||
| 30 | @echo " epub3 to make an epub3" | ||
| 31 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | ||
| 32 | @echo " latexpdf to make LaTeX files and run them through pdflatex" | ||
| 33 | @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" | ||
| 34 | @echo " text to make text files" | ||
| 35 | @echo " man to make manual pages" | ||
| 36 | @echo " texinfo to make Texinfo files" | ||
| 37 | @echo " info to make Texinfo files and run them through makeinfo" | ||
| 38 | @echo " gettext to make PO message catalogs" | ||
| 39 | @echo " changes to make an overview of all changed/added/deprecated items" | ||
| 40 | @echo " xml to make Docutils-native XML files" | ||
| 41 | @echo " pseudoxml to make pseudoxml-XML files for display purposes" | ||
| 42 | @echo " linkcheck to check all external links for integrity" | ||
| 43 | @echo " doctest to run all doctests embedded in the documentation (if enabled)" | ||
| 44 | @echo " coverage to run coverage check of the documentation (if enabled)" | ||
| 45 | @echo " dummy to check syntax errors of document sources" | ||
| 46 | |||
| 47 | .PHONY: clean | ||
| 48 | clean: | ||
| 49 | rm -rf $(BUILDDIR)/* | ||
| 50 | |||
| 51 | .PHONY: html | ||
| 52 | html: | ||
| 53 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | ||
| 54 | @echo | ||
| 55 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | ||
| 56 | |||
| 57 | .PHONY: dirhtml | ||
| 58 | dirhtml: | ||
| 59 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml | ||
| 60 | @echo | ||
| 61 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." | ||
| 62 | |||
| 63 | .PHONY: singlehtml | ||
| 64 | singlehtml: | ||
| 65 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml | ||
| 66 | @echo | ||
| 67 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." | ||
| 68 | |||
| 69 | .PHONY: pickle | ||
| 70 | pickle: | ||
| 71 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle | ||
| 72 | @echo | ||
| 73 | @echo "Build finished; now you can process the pickle files." | ||
| 74 | |||
| 75 | .PHONY: json | ||
| 76 | json: | ||
| 77 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json | ||
| 78 | @echo | ||
| 79 | @echo "Build finished; now you can process the JSON files." | ||
| 80 | |||
| 81 | .PHONY: htmlhelp | ||
| 82 | htmlhelp: | ||
| 83 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp | ||
| 84 | @echo | ||
| 85 | @echo "Build finished; now you can run HTML Help Workshop with the" \ | ||
| 86 | ".hhp project file in $(BUILDDIR)/htmlhelp." | ||
| 87 | |||
| 88 | .PHONY: qthelp | ||
| 89 | qthelp: | ||
| 90 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp | ||
| 91 | @echo | ||
| 92 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ | ||
| 93 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" | ||
| 94 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/meta-raspberrypi.qhcp" | ||
| 95 | @echo "To view the help file:" | ||
| 96 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/meta-raspberrypi.qhc" | ||
| 97 | |||
| 98 | .PHONY: applehelp | ||
| 99 | applehelp: | ||
| 100 | $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp | ||
| 101 | @echo | ||
| 102 | @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." | ||
| 103 | @echo "N.B. You won't be able to view it unless you put it in" \ | ||
| 104 | "~/Library/Documentation/Help or install it in your application" \ | ||
| 105 | "bundle." | ||
| 106 | |||
| 107 | .PHONY: devhelp | ||
| 108 | devhelp: | ||
| 109 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | ||
| 110 | @echo | ||
| 111 | @echo "Build finished." | ||
| 112 | @echo "To view the help file:" | ||
| 113 | @echo "# mkdir -p $$HOME/.local/share/devhelp/meta-raspberrypi" | ||
| 114 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/meta-raspberrypi" | ||
| 115 | @echo "# devhelp" | ||
| 116 | |||
| 117 | .PHONY: epub | ||
| 118 | epub: | ||
| 119 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub | ||
| 120 | @echo | ||
| 121 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub." | ||
| 122 | |||
| 123 | .PHONY: epub3 | ||
| 124 | epub3: | ||
| 125 | $(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 | ||
| 126 | @echo | ||
| 127 | @echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." | ||
| 128 | |||
| 129 | .PHONY: latex | ||
| 130 | latex: | ||
| 131 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
| 132 | @echo | ||
| 133 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." | ||
| 134 | @echo "Run \`make' in that directory to run these through (pdf)latex" \ | ||
| 135 | "(use \`make latexpdf' here to do that automatically)." | ||
| 136 | |||
| 137 | .PHONY: latexpdf | ||
| 138 | latexpdf: | ||
| 139 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
| 140 | @echo "Running LaTeX files through pdflatex..." | ||
| 141 | $(MAKE) -C $(BUILDDIR)/latex all-pdf | ||
| 142 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | ||
| 143 | |||
| 144 | .PHONY: latexpdfja | ||
| 145 | latexpdfja: | ||
| 146 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | ||
| 147 | @echo "Running LaTeX files through platex and dvipdfmx..." | ||
| 148 | $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja | ||
| 149 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | ||
| 150 | |||
| 151 | .PHONY: text | ||
| 152 | text: | ||
| 153 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text | ||
| 154 | @echo | ||
| 155 | @echo "Build finished. The text files are in $(BUILDDIR)/text." | ||
| 156 | |||
| 157 | .PHONY: man | ||
| 158 | man: | ||
| 159 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man | ||
| 160 | @echo | ||
| 161 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man." | ||
| 162 | |||
| 163 | .PHONY: texinfo | ||
| 164 | texinfo: | ||
| 165 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | ||
| 166 | @echo | ||
| 167 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." | ||
| 168 | @echo "Run \`make' in that directory to run these through makeinfo" \ | ||
| 169 | "(use \`make info' here to do that automatically)." | ||
| 170 | |||
| 171 | .PHONY: info | ||
| 172 | info: | ||
| 173 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | ||
| 174 | @echo "Running Texinfo files through makeinfo..." | ||
| 175 | make -C $(BUILDDIR)/texinfo info | ||
| 176 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." | ||
| 177 | |||
| 178 | .PHONY: gettext | ||
| 179 | gettext: | ||
| 180 | $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale | ||
| 181 | @echo | ||
| 182 | @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." | ||
| 183 | |||
| 184 | .PHONY: changes | ||
| 185 | changes: | ||
| 186 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | ||
| 187 | @echo | ||
| 188 | @echo "The overview file is in $(BUILDDIR)/changes." | ||
| 189 | |||
| 190 | .PHONY: linkcheck | ||
| 191 | linkcheck: | ||
| 192 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | ||
| 193 | @echo | ||
| 194 | @echo "Link check complete; look for any errors in the above output " \ | ||
| 195 | "or in $(BUILDDIR)/linkcheck/output.txt." | ||
| 196 | |||
| 197 | .PHONY: doctest | ||
| 198 | doctest: | ||
| 199 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | ||
| 200 | @echo "Testing of doctests in the sources finished, look at the " \ | ||
| 201 | "results in $(BUILDDIR)/doctest/output.txt." | ||
| 202 | |||
| 203 | .PHONY: coverage | ||
| 204 | coverage: | ||
| 205 | $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage | ||
| 206 | @echo "Testing of coverage in the sources finished, look at the " \ | ||
| 207 | "results in $(BUILDDIR)/coverage/python.txt." | ||
| 208 | |||
| 209 | .PHONY: xml | ||
| 210 | xml: | ||
| 211 | $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml | ||
| 212 | @echo | ||
| 213 | @echo "Build finished. The XML files are in $(BUILDDIR)/xml." | ||
| 214 | |||
| 215 | .PHONY: pseudoxml | ||
| 216 | pseudoxml: | ||
| 217 | $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml | ||
| 218 | @echo | ||
| 219 | @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." | ||
| 220 | |||
| 221 | .PHONY: dummy | ||
| 222 | dummy: | ||
| 223 | $(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy | ||
| 224 | @echo | ||
| 225 | @echo "Build finished. Dummy builder generates no files." | ||
diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..013c8a7 --- /dev/null +++ b/docs/conf.py | |||
| @@ -0,0 +1,343 @@ | |||
| 1 | #!/usr/bin/env python3 | ||
| 2 | # -*- coding: utf-8 -*- | ||
| 3 | # | ||
| 4 | # meta-raspberrypi documentation build configuration file, created by | ||
| 5 | # sphinx-quickstart on Tue May 23 09:51:24 2017. | ||
| 6 | # | ||
| 7 | # This file is execfile()d with the current directory set to its | ||
| 8 | # containing dir. | ||
| 9 | # | ||
| 10 | # Note that not all possible configuration values are present in this | ||
| 11 | # autogenerated file. | ||
| 12 | # | ||
| 13 | # All configuration values have a default; values that are commented out | ||
| 14 | # serve to show the default. | ||
| 15 | |||
| 16 | # If extensions (or modules to document with autodoc) are in another directory, | ||
| 17 | # add these directories to sys.path here. If the directory is relative to the | ||
| 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
| 19 | # | ||
| 20 | # import os | ||
| 21 | # import sys | ||
| 22 | # sys.path.insert(0, os.path.abspath('.')) | ||
| 23 | |||
| 24 | # -- General configuration ------------------------------------------------ | ||
| 25 | |||
| 26 | # If your documentation needs a minimal Sphinx version, state it here. | ||
| 27 | # | ||
| 28 | # needs_sphinx = '1.0' | ||
| 29 | |||
| 30 | # Add any Sphinx extension module names here, as strings. They can be | ||
| 31 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom | ||
| 32 | # ones. | ||
| 33 | extensions = [] | ||
| 34 | |||
| 35 | # Add any paths that contain templates here, relative to this directory. | ||
| 36 | templates_path = ['_templates'] | ||
| 37 | |||
| 38 | # The suffix(es) of source filenames. | ||
| 39 | # You can specify multiple suffix as a list of string: | ||
| 40 | # | ||
| 41 | # source_suffix = ['.rst', '.md'] | ||
| 42 | source_suffix = ['.rst', '.md'] | ||
| 43 | |||
| 44 | # The encoding of source files. | ||
| 45 | # | ||
| 46 | # source_encoding = 'utf-8-sig' | ||
| 47 | |||
| 48 | # The master toctree document. | ||
| 49 | master_doc = 'index' | ||
| 50 | |||
| 51 | # General information about the project. | ||
| 52 | project = 'meta-raspberrypi' | ||
| 53 | copyright = '2017, meta-raspberrypi contributors' | ||
| 54 | author = 'meta-raspberrypi contributors' | ||
| 55 | |||
| 56 | # The version info for the project you're documenting, acts as replacement for | ||
| 57 | # |version| and |release|, also used in various other places throughout the | ||
| 58 | # built documents. | ||
| 59 | # | ||
| 60 | # The short X.Y version. | ||
| 61 | version = 'master' | ||
| 62 | # The full version, including alpha/beta/rc tags. | ||
| 63 | release = 'master' | ||
| 64 | |||
| 65 | # The language for content autogenerated by Sphinx. Refer to documentation | ||
| 66 | # for a list of supported languages. | ||
| 67 | # | ||
| 68 | # This is also used if you do content translation via gettext catalogs. | ||
| 69 | # Usually you set "language" from the command line for these cases. | ||
| 70 | language = None | ||
| 71 | |||
| 72 | # There are two options for replacing |today|: either, you set today to some | ||
| 73 | # non-false value, then it is used: | ||
| 74 | # | ||
| 75 | # today = '' | ||
| 76 | # | ||
| 77 | # Else, today_fmt is used as the format for a strftime call. | ||
| 78 | # | ||
| 79 | # today_fmt = '%B %d, %Y' | ||
| 80 | |||
| 81 | # List of patterns, relative to source directory, that match files and | ||
| 82 | # directories to ignore when looking for source files. | ||
| 83 | # This patterns also effect to html_static_path and html_extra_path | ||
| 84 | exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||
| 85 | |||
| 86 | # The reST default role (used for this markup: `text`) to use for all | ||
| 87 | # documents. | ||
| 88 | # | ||
| 89 | # default_role = None | ||
| 90 | |||
| 91 | # If true, '()' will be appended to :func: etc. cross-reference text. | ||
| 92 | # | ||
| 93 | # add_function_parentheses = True | ||
| 94 | |||
| 95 | # If true, the current module name will be prepended to all description | ||
| 96 | # unit titles (such as .. function::). | ||
| 97 | # | ||
| 98 | # add_module_names = True | ||
| 99 | |||
| 100 | # If true, sectionauthor and moduleauthor directives will be shown in the | ||
| 101 | # output. They are ignored by default. | ||
| 102 | # | ||
| 103 | # show_authors = False | ||
| 104 | |||
| 105 | # The name of the Pygments (syntax highlighting) style to use. | ||
| 106 | pygments_style = 'sphinx' | ||
| 107 | |||
| 108 | # A list of ignored prefixes for module index sorting. | ||
| 109 | # modindex_common_prefix = [] | ||
| 110 | |||
| 111 | # If true, keep warnings as "system message" paragraphs in the built documents. | ||
| 112 | # keep_warnings = False | ||
| 113 | |||
| 114 | # If true, `todo` and `todoList` produce output, else they produce nothing. | ||
| 115 | todo_include_todos = False | ||
| 116 | |||
| 117 | |||
| 118 | # -- Options for HTML output ---------------------------------------------- | ||
| 119 | |||
| 120 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
| 121 | # a list of builtin themes. | ||
| 122 | # | ||
| 123 | html_theme = 'alabaster' | ||
| 124 | |||
| 125 | # Theme options are theme-specific and customize the look and feel of a theme | ||
| 126 | # further. For a list of options available for each theme, see the | ||
| 127 | # documentation. | ||
| 128 | # | ||
| 129 | # html_theme_options = {} | ||
| 130 | |||
| 131 | # Add any paths that contain custom themes here, relative to this directory. | ||
| 132 | # html_theme_path = [] | ||
| 133 | |||
| 134 | # The name for this set of Sphinx documents. | ||
| 135 | # "<project> v<release> documentation" by default. | ||
| 136 | # | ||
| 137 | # html_title = 'meta-raspberrypi vmaster' | ||
| 138 | |||
| 139 | # A shorter title for the navigation bar. Default is the same as html_title. | ||
| 140 | # | ||
| 141 | # html_short_title = None | ||
| 142 | |||
| 143 | # The name of an image file (relative to this directory) to place at the top | ||
| 144 | # of the sidebar. | ||
| 145 | # | ||
| 146 | # html_logo = None | ||
| 147 | |||
| 148 | # The name of an image file (relative to this directory) to use as a favicon of | ||
| 149 | # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
| 150 | # pixels large. | ||
| 151 | # | ||
| 152 | # html_favicon = None | ||
| 153 | |||
| 154 | # Add any paths that contain custom static files (such as style sheets) here, | ||
| 155 | # relative to this directory. They are copied after the builtin static files, | ||
| 156 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
| 157 | html_static_path = ['_static'] | ||
| 158 | |||
| 159 | # Add any extra paths that contain custom files (such as robots.txt or | ||
| 160 | # .htaccess) here, relative to this directory. These files are copied | ||
| 161 | # directly to the root of the documentation. | ||
| 162 | # | ||
| 163 | # html_extra_path = [] | ||
| 164 | |||
| 165 | # If not None, a 'Last updated on:' timestamp is inserted at every page | ||
| 166 | # bottom, using the given strftime format. | ||
| 167 | # The empty string is equivalent to '%b %d, %Y'. | ||
| 168 | # | ||
| 169 | # html_last_updated_fmt = None | ||
| 170 | |||
| 171 | # If true, SmartyPants will be used to convert quotes and dashes to | ||
| 172 | # typographically correct entities. | ||
| 173 | # | ||
| 174 | # html_use_smartypants = True | ||
| 175 | |||
| 176 | # Custom sidebar templates, maps document names to template names. | ||
| 177 | # | ||
| 178 | # html_sidebars = {} | ||
| 179 | |||
| 180 | # Additional templates that should be rendered to pages, maps page names to | ||
| 181 | # template names. | ||
| 182 | # | ||
| 183 | # html_additional_pages = {} | ||
| 184 | |||
| 185 | # If false, no module index is generated. | ||
| 186 | # | ||
| 187 | # html_domain_indices = True | ||
| 188 | |||
| 189 | # If false, no index is generated. | ||
| 190 | # | ||
| 191 | # html_use_index = True | ||
| 192 | |||
| 193 | # If true, the index is split into individual pages for each letter. | ||
| 194 | # | ||
| 195 | # html_split_index = False | ||
| 196 | |||
| 197 | # If true, links to the reST sources are added to the pages. | ||
| 198 | # | ||
| 199 | # html_show_sourcelink = True | ||
| 200 | |||
| 201 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | ||
| 202 | # | ||
| 203 | # html_show_sphinx = True | ||
| 204 | |||
| 205 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | ||
| 206 | # | ||
| 207 | # html_show_copyright = True | ||
| 208 | |||
| 209 | # If true, an OpenSearch description file will be output, and all pages will | ||
| 210 | # contain a <link> tag referring to it. The value of this option must be the | ||
| 211 | # base URL from which the finished HTML is served. | ||
| 212 | # | ||
| 213 | # html_use_opensearch = '' | ||
| 214 | |||
| 215 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | ||
| 216 | # html_file_suffix = None | ||
| 217 | |||
| 218 | # Language to be used for generating the HTML full-text search index. | ||
| 219 | # Sphinx supports the following languages: | ||
| 220 | # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' | ||
| 221 | # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' | ||
| 222 | # | ||
| 223 | # html_search_language = 'en' | ||
| 224 | |||
| 225 | # A dictionary with options for the search language support, empty by default. | ||
| 226 | # 'ja' uses this config value. | ||
| 227 | # 'zh' user can custom change `jieba` dictionary path. | ||
| 228 | # | ||
| 229 | # html_search_options = {'type': 'default'} | ||
| 230 | |||
| 231 | # The name of a javascript file (relative to the configuration directory) that | ||
| 232 | # implements a search results scorer. If empty, the default will be used. | ||
| 233 | # | ||
| 234 | # html_search_scorer = 'scorer.js' | ||
| 235 | |||
| 236 | # Output file base name for HTML help builder. | ||
| 237 | htmlhelp_basename = 'meta-raspberrypidoc' | ||
| 238 | |||
| 239 | # -- Options for LaTeX output --------------------------------------------- | ||
| 240 | |||
| 241 | latex_elements = { | ||
| 242 | # The paper size ('letterpaper' or 'a4paper'). | ||
| 243 | # | ||
| 244 | # 'papersize': 'letterpaper', | ||
| 245 | |||
| 246 | # The font size ('10pt', '11pt' or '12pt'). | ||
| 247 | # | ||
| 248 | # 'pointsize': '10pt', | ||
| 249 | |||
| 250 | # Additional stuff for the LaTeX preamble. | ||
| 251 | # | ||
| 252 | # 'preamble': '', | ||
| 253 | |||
| 254 | # Latex figure (float) alignment | ||
| 255 | # | ||
| 256 | # 'figure_align': 'htbp', | ||
| 257 | } | ||
| 258 | |||
| 259 | # Grouping the document tree into LaTeX files. List of tuples | ||
| 260 | # (source start file, target name, title, | ||
| 261 | # author, documentclass [howto, manual, or own class]). | ||
| 262 | latex_documents = [ | ||
| 263 | (master_doc, 'meta-raspberrypi.tex', 'meta-raspberrypi Documentation', | ||
| 264 | 'meta-raspberrypi contributors', 'manual'), | ||
| 265 | ] | ||
| 266 | |||
| 267 | # The name of an image file (relative to this directory) to place at the top of | ||
| 268 | # the title page. | ||
| 269 | # | ||
| 270 | # latex_logo = None | ||
| 271 | |||
| 272 | # For "manual" documents, if this is true, then toplevel headings are parts, | ||
| 273 | # not chapters. | ||
| 274 | # | ||
| 275 | # latex_use_parts = False | ||
| 276 | |||
| 277 | # If true, show page references after internal links. | ||
| 278 | # | ||
| 279 | # latex_show_pagerefs = False | ||
| 280 | |||
| 281 | # If true, show URL addresses after external links. | ||
| 282 | # | ||
| 283 | # latex_show_urls = False | ||
| 284 | |||
| 285 | # Documents to append as an appendix to all manuals. | ||
| 286 | # | ||
| 287 | # latex_appendices = [] | ||
| 288 | |||
| 289 | # It false, will not define \strong, \code, itleref, \crossref ... but only | ||
| 290 | # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added | ||
| 291 | # packages. | ||
| 292 | # | ||
| 293 | # latex_keep_old_macro_names = True | ||
| 294 | |||
| 295 | # If false, no module index is generated. | ||
| 296 | # | ||
| 297 | # latex_domain_indices = True | ||
| 298 | |||
| 299 | |||
| 300 | # -- Options for manual page output --------------------------------------- | ||
| 301 | |||
| 302 | # One entry per manual page. List of tuples | ||
| 303 | # (source start file, name, description, authors, manual section). | ||
| 304 | man_pages = [ | ||
| 305 | (master_doc, 'meta-raspberrypi', 'meta-raspberrypi Documentation', | ||
| 306 | [author], 1) | ||
| 307 | ] | ||
| 308 | |||
| 309 | # If true, show URL addresses after external links. | ||
| 310 | # | ||
| 311 | # man_show_urls = False | ||
| 312 | |||
| 313 | |||
| 314 | # -- Options for Texinfo output ------------------------------------------- | ||
| 315 | |||
| 316 | # Grouping the document tree into Texinfo files. List of tuples | ||
| 317 | # (source start file, target name, title, author, | ||
| 318 | # dir menu entry, description, category) | ||
| 319 | texinfo_documents = [ | ||
| 320 | (master_doc, 'meta-raspberrypi', 'meta-raspberrypi Documentation', | ||
| 321 | author, 'meta-raspberrypi', 'One line description of project.', | ||
| 322 | 'Miscellaneous'), | ||
| 323 | ] | ||
| 324 | |||
| 325 | # Documents to append as an appendix to all manuals. | ||
| 326 | # | ||
| 327 | # texinfo_appendices = [] | ||
| 328 | |||
| 329 | # If false, no module index is generated. | ||
| 330 | # | ||
| 331 | # texinfo_domain_indices = True | ||
| 332 | |||
| 333 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | ||
| 334 | # | ||
| 335 | # texinfo_show_urls = 'footnote' | ||
| 336 | |||
| 337 | # If true, do not generate a @detailmenu in the "Top" node's menu. | ||
| 338 | # | ||
| 339 | # texinfo_no_detailmenu = False | ||
| 340 | |||
| 341 | source_parsers = { | ||
| 342 | '.md': 'recommonmark.parser.CommonMarkParser', | ||
| 343 | } | ||
diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 0000000..94dbf49 --- /dev/null +++ b/docs/contributing.md | |||
| @@ -0,0 +1,38 @@ | |||
| 1 | # Contributing | ||
| 2 | |||
| 3 | ## Mailing list | ||
| 4 | |||
| 5 | The main communication tool we use is a mailing list: | ||
| 6 | * <yocto@yoctoproject.org> | ||
| 7 | * <https://lists.yoctoproject.org/listinfo/yocto> | ||
| 8 | |||
| 9 | Feel free to ask any kind of questions but always prepend your email subject | ||
| 10 | with "[meta-raspberrypi]". This is because we use the 'yocto' mailing list and | ||
| 11 | not a perticular 'meta-raspberrypi' mailing list. | ||
| 12 | |||
| 13 | ## Patches and pull requests | ||
| 14 | |||
| 15 | All the contributions should be compliant with the openembedded patch | ||
| 16 | guidelines: <http://www.openembedded.org/wiki/Commit_Patch_Message_Guidelines> | ||
| 17 | |||
| 18 | To contribute to this project you should send pull requests to the github mirror | ||
| 19 | (<https://github.com/agherzan/meta-raspberrypi>). **Additionally** you can send | ||
| 20 | the patches for review to the above specified mailing list. | ||
| 21 | |||
| 22 | When creating patches for the mailing list, please use something like: | ||
| 23 | |||
| 24 | git format-patch -s --subject-prefix='meta-raspberrypi][PATCH' origin | ||
| 25 | |||
| 26 | When sending patches to the mailing list, please use something like: | ||
| 27 | |||
| 28 | git send-email --to yocto@yoctoproject.org <generated patch> | ||
| 29 | |||
| 30 | ## Github issues | ||
| 31 | |||
| 32 | In order to manage and trace the meta-raspberrypi issues, we use github issues: | ||
| 33 | <https://github.com/agherzan/meta-raspberrypi/issues> | ||
| 34 | |||
| 35 | If you push patches which have a github issue associated, please provide the | ||
| 36 | issue number in the commit log just before "Signed-off-by" line(s). Example line | ||
| 37 | for a bug: | ||
| 38 | `[Issue #13]` | ||
diff --git a/docs/extra-apps.md b/docs/extra-apps.md new file mode 100644 index 0000000..53007dc --- /dev/null +++ b/docs/extra-apps.md | |||
| @@ -0,0 +1,9 @@ | |||
| 1 | # Extra apps | ||
| 2 | |||
| 3 | ## omxplayer | ||
| 4 | |||
| 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 | ||
| 7 | license in your local.conf: | ||
| 8 | |||
| 9 | LICENSE_FLAGS_WHITELIST = "commercial" | ||
diff --git a/docs/extra-build-config.md b/docs/extra-build-config.md new file mode 100644 index 0000000..365c490 --- /dev/null +++ b/docs/extra-build-config.md | |||
| @@ -0,0 +1,180 @@ | |||
| 1 | # Optional build configuration | ||
| 2 | |||
| 3 | There are a set of ways in which a user can influence different paramenters of | ||
| 4 | the build. We list here the ones that are closely related to this BSP or | ||
| 5 | specific to it. For the rest please check: | ||
| 6 | <http://www.yoctoproject.org/docs/latest/ref-manual/ref-manual.html> | ||
| 7 | |||
| 8 | ## Compressed deployed files | ||
| 9 | |||
| 10 | 1. Overwrite IMAGE_FSTYPES in local.conf | ||
| 11 | * `IMAGE_FSTYPES = "tar.bz2 ext3.xz"` | ||
| 12 | |||
| 13 | 2. Overwrite SDIMG_ROOTFS_TYPE in local.conf | ||
| 14 | * `SDIMG_ROOTFS_TYPE = "ext3.xz"` | ||
| 15 | |||
| 16 | 3. Overwrite SDIMG_COMPRESSION in local.conf | ||
| 17 | * `SDIMG_COMPRESSION = "xz"` | ||
| 18 | |||
| 19 | Accommodate the values above to your own needs (ex: ext3 / ext4). | ||
| 20 | |||
| 21 | ## GPU memory | ||
| 22 | |||
| 23 | * `GPU_MEM`: GPU memory in megabyte. Sets the memory split between the ARM and | ||
| 24 | GPU. ARM gets the remaining memory. Min 16. Default 64. | ||
| 25 | |||
| 26 | * `GPU_MEM_256`: GPU memory in megabyte for the 256MB Raspberry Pi. Ignored by | ||
| 27 | the 512MB RP. Overrides gpu_mem. Max 192. Default not set. | ||
| 28 | |||
| 29 | * `GPU_MEM_512`: GPU memory in megabyte for the 512MB Raspberry Pi. Ignored by | ||
| 30 | the 256MB RP. Overrides gpu_mem. Max 448. Default not set. | ||
| 31 | |||
| 32 | * `GPU_MEM_1024`: GPU memory in megabyte for the 1024MB Raspberry Pi. Ignored by | ||
| 33 | the 256MB/512MB RP. Overrides gpu_mem. Max 944. Default not set. | ||
| 34 | |||
| 35 | ## Add purchased license codecs | ||
| 36 | |||
| 37 | To add you own licenses use variables `KEY_DECODE_MPG2` and `KEY_DECODE_WVC1` in | ||
| 38 | local.conf. Example: | ||
| 39 | |||
| 40 | KEY_DECODE_MPG2 = "12345678" | ||
| 41 | KEY_DECODE_WVC1 = "12345678" | ||
| 42 | |||
| 43 | You can supply more licenses separated by comma. Example: | ||
| 44 | |||
| 45 | KEY_DECODE_WVC1 = "0x12345678,0xabcdabcd,0x87654321" | ||
| 46 | |||
| 47 | |||
| 48 | ## Disable overscan | ||
| 49 | |||
| 50 | By default the GPU adds a black border around the video output to compensate for | ||
| 51 | TVs which cut off part of the image. To disable this set this variable in | ||
| 52 | local.conf: | ||
| 53 | |||
| 54 | DISABLE_OVERSCAN = "1" | ||
| 55 | |||
| 56 | ## Set overclocking options | ||
| 57 | |||
| 58 | 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 | ||
| 60 | the config.txt for a detailed description of options and modes. Example turbo | ||
| 61 | mode: | ||
| 62 | |||
| 63 | ARM_FREQ = "1000" | ||
| 64 | CORE_FREQ = "500" | ||
| 65 | SDRAM_FREQ = "500" | ||
| 66 | OVER_VOLTAGE = "6" | ||
| 67 | |||
| 68 | ## Video camera support with V4L2 drivers | ||
| 69 | |||
| 70 | Set this variable to enable support for the video camera (Linux 3.12.4+ | ||
| 71 | required): | ||
| 72 | |||
| 73 | VIDEO_CAMERA = "1" | ||
| 74 | |||
| 75 | ## Enable offline compositing support | ||
| 76 | |||
| 77 | Set this variable to enable support for dispmanx offline compositing: | ||
| 78 | |||
| 79 | DISPMANX_OFFLINE = "1" | ||
| 80 | |||
| 81 | This will enable the firmware to fall back to off-line compositing of Dispmanx | ||
| 82 | elements. Normally the compositing is done on-line, during scanout, but cannot | ||
| 83 | handle too many elements. With off-line enabled, an off-screen buffer is | ||
| 84 | allocated for compositing. When scene complexity (number and sizes | ||
| 85 | of elements) is high, compositing will happen off-line into the buffer. | ||
| 86 | |||
| 87 | Heavily recommended for Wayland/Weston. | ||
| 88 | |||
| 89 | See: <http://wayland.freedesktop.org/raspberrypi.html> | ||
| 90 | |||
| 91 | ## Enable kgdb over console support | ||
| 92 | |||
| 93 | To add the kdbg over console (kgdboc) parameter to the kernel command line, set | ||
| 94 | this variable in local.conf: | ||
| 95 | |||
| 96 | ENABLE_KGDB = "1" | ||
| 97 | |||
| 98 | ## Boot to U-Boot | ||
| 99 | |||
| 100 | To have u-boot load kernel image, set in your local.conf: | ||
| 101 | |||
| 102 | KERNEL_IMAGETYPE = "uImage" | ||
| 103 | |||
| 104 | This will make kernel.img be u-boot image which will load uImage. By default, | ||
| 105 | kernel.img is the actual kernel image (ex. Image). | ||
| 106 | |||
| 107 | ## Image with Initramfs | ||
| 108 | |||
| 109 | To build an initramfs image: | ||
| 110 | |||
| 111 | * Set this 3 kernel variables (in linux-raspberrypi.inc for example) | ||
| 112 | - kernel_configure_variable BLK_DEV_INITRD y | ||
| 113 | - kernel_configure_variable INITRAMFS_SOURCE "" | ||
| 114 | - kernel_configure_variable RD_GZIP y | ||
| 115 | |||
| 116 | * Set the yocto variables (in linux-raspberrypi.inc for example) | ||
| 117 | - `INITRAMFS_IMAGE = "<a name for your initramfs image>"` | ||
| 118 | - `INITRAMFS_IMAGE_BUNDLE = "1"` | ||
| 119 | |||
| 120 | * Set the meta-rasberrypi variable (in raspberrypi.conf for example) | ||
| 121 | - `KERNEL_INITRAMFS = "-initramfs"` | ||
| 122 | |||
| 123 | ## Enable SPI bus | ||
| 124 | |||
| 125 | When using device tree kernels, set this variable to enable the SPI bus: | ||
| 126 | |||
| 127 | ENABLE_SPI_BUS = "1" | ||
| 128 | |||
| 129 | ## Enable I2C | ||
| 130 | |||
| 131 | When using device tree kernels, set this variable to enable I2C: | ||
| 132 | |||
| 133 | ENABLE_I2C = "1" | ||
| 134 | |||
| 135 | ## Enable PiTFT support | ||
| 136 | |||
| 137 | Basic support for using PiTFT screens can be enabled by adding below in | ||
| 138 | local.conf: | ||
| 139 | |||
| 140 | * `MACHINE_FEATURES += "pitft"` | ||
| 141 | - This will enable SPI bus and i2c device-trees, it will also setup | ||
| 142 | framebuffer for console and x server on PiTFT. | ||
| 143 | |||
| 144 | NOTE: To get this working the overlay for the PiTFT model must be build, added | ||
| 145 | and specified as well (dtoverlay=<driver> in config.txt). | ||
| 146 | |||
| 147 | Below is a list of currently supported PiTFT models in meta-raspberrypi, the | ||
| 148 | modelname should be added as a MACHINE_FEATURES in local.conf like below: | ||
| 149 | |||
| 150 | MACHINE_FEATURES += "pitft <modelname>" | ||
| 151 | |||
| 152 | List of currently supported models: | ||
| 153 | * pitft22 | ||
| 154 | * pitft28r | ||
| 155 | * pitft35r | ||
| 156 | |||
| 157 | ## Misc. display | ||
| 158 | |||
| 159 | If you would like to use the Waveshare "C" 1024×600, 7 inch Capacitive Touch | ||
| 160 | Screen LCD, HDMI interface (<http://www.waveshare.com/7inch-HDMI-LCD-C.htm>) Rev | ||
| 161 | 2.1, please set the following in your local.conf: | ||
| 162 | |||
| 163 | WAVESHARE_1024X600_C_2_1 = "1" | ||
| 164 | |||
| 165 | ## Enable UART | ||
| 166 | |||
| 167 | RaspberryPi 0, 1, 2 and CM will have UART console enabled by default. | ||
| 168 | |||
| 169 | RaspberryPi 0 WiFi and 3 does not have the UART enabled by default because this | ||
| 170 | needs a fixed core frequency and enable_uart wil set it to the minimum. Certain | ||
| 171 | operations - 60fps h264 decode, high quality deinterlace - which aren't | ||
| 172 | performed on the ARM may be affected, and we wouldn't want to do that to users | ||
| 173 | who don't want to use the serial port. Users who want serial console support on | ||
| 174 | RaspberryPi3 will have to explicitely set in local.conf: | ||
| 175 | |||
| 176 | ENABLE_UART = "1" | ||
| 177 | |||
| 178 | Ref.: | ||
| 179 | * <https://github.com/raspberrypi/firmware/issues/553> | ||
| 180 | * <https://github.com/RPi-Distro/repo/issues/22> | ||
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..0d7ee07 --- /dev/null +++ b/docs/index.rst | |||
| @@ -0,0 +1,26 @@ | |||
| 1 | .. meta-raspberrypi documentation master file, created by | ||
| 2 | sphinx-quickstart on Tue May 23 09:51:24 2017. | ||
| 3 | You can adapt this file completely to your liking, but it should at least | ||
| 4 | contain the root `toctree` directive. | ||
| 5 | |||
| 6 | Welcome to meta-raspberrypi's documentation! | ||
| 7 | ============================================ | ||
| 8 | |||
| 9 | Contents: | ||
| 10 | |||
| 11 | .. toctree:: | ||
| 12 | :maxdepth: 2 | ||
| 13 | |||
| 14 | readme | ||
| 15 | layer-contents | ||
| 16 | extra-build-config | ||
| 17 | extra-apps | ||
| 18 | contributing | ||
| 19 | |||
| 20 | Indices and tables | ||
| 21 | ================== | ||
| 22 | |||
| 23 | * :ref:`genindex` | ||
| 24 | * :ref:`modindex` | ||
| 25 | * :ref:`search` | ||
| 26 | |||
diff --git a/docs/layer-contents.md b/docs/layer-contents.md new file mode 100644 index 0000000..29cfa35 --- /dev/null +++ b/docs/layer-contents.md | |||
| @@ -0,0 +1,24 @@ | |||
| 1 | # Layer Contents | ||
| 2 | |||
| 3 | ## Supported Machines | ||
| 4 | |||
| 5 | * raspberrypi | ||
| 6 | * raspberrypi0 | ||
| 7 | * raspberrypi0-wifi | ||
| 8 | * raspberrypi2 | ||
| 9 | * raspberrypi3 | ||
| 10 | * raspberrypi3-64 (64 bit kernel & userspace) | ||
| 11 | * raspberrypi-cm (dummy alias for raspberrypi) | ||
| 12 | * raspberrypi-cm3 (dummy alias for raspberrypi2) | ||
| 13 | |||
| 14 | ## Images | ||
| 15 | |||
| 16 | * rpi-hwup-image | ||
| 17 | * Hardware up image | ||
| 18 | |||
| 19 | * rpi-basic-image | ||
| 20 | * Based on rpi-hwup-image with some added features (ex: splash) | ||
| 21 | |||
| 22 | * rpi-test-image | ||
| 23 | * Image based on rpi-basic-image which includes most of the packages in this | ||
| 24 | layer and some media samples. | ||
diff --git a/docs/readme.md b/docs/readme.md new file mode 120000 index 0000000..32d46ee --- /dev/null +++ b/docs/readme.md | |||
| @@ -0,0 +1 @@ | |||
| ../README.md \ No newline at end of file | |||
diff --git a/recipes-devtools/bcm2835/bcm2835_1.52.bb b/recipes-devtools/bcm2835/bcm2835_1.52.bb index c0334fe..8e41c61 100644 --- a/recipes-devtools/bcm2835/bcm2835_1.52.bb +++ b/recipes-devtools/bcm2835/bcm2835_1.52.bb | |||
| @@ -35,6 +35,8 @@ do_install_append() { | |||
| 35 | 35 | ||
| 36 | PACKAGES += "${PN}-tests" | 36 | PACKAGES += "${PN}-tests" |
| 37 | 37 | ||
| 38 | RDEPENDS_${PN}-dev = "" | ||
| 39 | |||
| 38 | FILES_${PN} = "" | 40 | FILES_${PN} = "" |
| 39 | FILES_${PN}-tests = "${libdir}/${BPN}" | 41 | FILES_${PN}-tests = "${libdir}/${BPN}" |
| 40 | FILES_${PN}-dbg += "${libdir}/${BPN}/.debug" | 42 | FILES_${PN}-dbg += "${libdir}/${BPN}/.debug" |
diff --git a/recipes-kernel/linux/linux-raspberrypi_dev.bb b/recipes-kernel/linux/linux-raspberrypi-dev.bb index 239d630..0879bcb 100644 --- a/recipes-kernel/linux/linux-raspberrypi_dev.bb +++ b/recipes-kernel/linux/linux-raspberrypi-dev.bb | |||
| @@ -1,4 +1,11 @@ | |||
| 1 | FILESEXTRAPATHS_prepend := "${THISDIR}/${PN}-dev:" | 1 | python __anonymous() { |
| 2 | if "linux-raspberrypi-dev" not in d.getVar("PREFERRED_PROVIDER_virtual/kernel"): | ||
| 3 | msg = "Skipping linux-raspberrypi-dev as it is not the preferred " + \ | ||
| 4 | "provider of virtual/kernel." | ||
| 5 | raise bb.parse.SkipRecipe(msg) | ||
| 6 | } | ||
| 7 | |||
| 8 | FILESEXTRAPATHS_prepend := "${THISDIR}/linux-raspberrypi:" | ||
| 2 | 9 | ||
| 3 | LINUX_VERSION ?= "4.11" | 10 | LINUX_VERSION ?= "4.11" |
| 4 | LINUX_RPI_DEV_BRANCH ?= "rpi-4.11.y" | 11 | LINUX_RPI_DEV_BRANCH ?= "rpi-4.11.y" |
