From 34113350f4a4a49c9e1c665042e58396acfd358f Mon Sep 17 00:00:00 2001 From: Mirza Krak Date: Tue, 23 May 2017 15:14:12 +0200 Subject: 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 --- docs/contributing.md | 6 +++-- docs/extra-apps.md | 3 ++- docs/extra-build-config.md | 63 ++++++++++++++++++++++++++-------------------- 3 files changed, 42 insertions(+), 30 deletions(-) (limited to 'docs') 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 the patches for review to the above specified mailing list. When creating patches for the mailing list, please use something like: -`git format-patch -s --subject-prefix='meta-raspberrypi][PATCH' origin` + + git format-patch -s --subject-prefix='meta-raspberrypi][PATCH' origin When sending patches to the mailing list, please use something like: -`git send-email --to yocto@yoctoproject.org ` + + git send-email --to yocto@yoctoproject.org ## Github issues 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 @@ 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: -`LICENSE_FLAGS_WHITELIST = "commercial"` + + 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: ## Compressed deployed files 1. Overwrite IMAGE_FSTYPES in local.conf - * `IMAGE_FSTYPES = "tar.bz2 ext3.xz"` + * `IMAGE_FSTYPES = "tar.bz2 ext3.xz"` 2. Overwrite SDIMG_ROOTFS_TYPE in local.conf - * `SDIMG_ROOTFS_TYPE = "ext3.xz"` + * `SDIMG_ROOTFS_TYPE = "ext3.xz"` 3. Overwrite SDIMG_COMPRESSION in local.conf - * `SDIMG_COMPRESSION = "xz"` + * `SDIMG_COMPRESSION = "xz"` Accommodate the values above to your own needs (ex: ext3 / ext4). @@ -36,22 +36,22 @@ Accommodate the values above to your own needs (ex: ext3 / ext4). To add you own licenses use variables `KEY_DECODE_MPG2` and `KEY_DECODE_WVC1` in local.conf. Example: -``` -KEY_DECODE_MPG2 = "12345678" -KEY_DECODE_WVC1 = "12345678" -``` + + KEY_DECODE_MPG2 = "12345678" + KEY_DECODE_WVC1 = "12345678" You can supply more licenses separated by comma. Example: -``` -KEY_DECODE_WVC1 = "0x12345678,0xabcdabcd,0x87654321" -``` + + KEY_DECODE_WVC1 = "0x12345678,0xabcdabcd,0x87654321" + ## Disable overscan 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: -`DISABLE_OVERSCAN = "1"` + + DISABLE_OVERSCAN = "1" ## Set overclocking options @@ -59,23 +59,24 @@ 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: -``` -ARM_FREQ = "1000" -CORE_FREQ = "500" -SDRAM_FREQ = "500" -OVER_VOLTAGE = "6" -``` + + ARM_FREQ = "1000" + CORE_FREQ = "500" + SDRAM_FREQ = "500" + OVER_VOLTAGE = "6" ## Video camera support with V4L2 drivers Set this variable to enable support for the video camera (Linux 3.12.4+ -required) -`VIDEO_CAMERA = "1"` +required): + + VIDEO_CAMERA = "1" ## Enable offline compositing support Set this variable to enable support for dispmanx offline compositing: -`DISPMANX_OFFLINE = "1"` + + DISPMANX_OFFLINE = "1" 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 @@ -91,12 +92,14 @@ See: To add the kdbg over console (kgdboc) parameter to the kernel command line, set this variable in local.conf: -`ENABLE_KGDB = "1"` + + ENABLE_KGDB = "1" ## Boot to U-Boot To have u-boot load kernel image, set in your local.conf: -`KERNEL_IMAGETYPE = "uImage"` + + KERNEL_IMAGETYPE = "uImage" This will make kernel.img be u-boot image which will load uImage. By default, kernel.img is the actual kernel image (ex. Image). @@ -133,12 +136,14 @@ disabled for older kernel versions. ## Enable SPI bus When using device tree kernels, set this variable to enable the SPI bus: -`ENABLE_SPI_BUS = "1"` + + ENABLE_SPI_BUS = "1" ## Enable I2C When using device tree kernels, set this variable to enable I2C: -`ENABLE_I2C = "1"` + + ENABLE_I2C = "1" ## Enable PiTFT support @@ -154,7 +159,8 @@ and specified as well (dtoverlay= in config.txt). 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: -`MACHINE_FEATURES += "pitft "` + + MACHINE_FEATURES += "pitft " List of currently supported models: * pitft22 @@ -166,7 +172,8 @@ List of currently supported models: If you would like to use the Waveshare "C" 1024×600, 7 inch Capacitive Touch Screen LCD, HDMI interface () Rev 2.1, please set the following in your local.conf: -`WAVESHARE_1024X600_C_2_1 = "1"` + + WAVESHARE_1024X600_C_2_1 = "1" ## Enable UART @@ -177,7 +184,9 @@ 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 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"`. +RaspberryPi3 will have to explicitely set in local.conf: + + ENABLE_UART = "1" Ref.: * -- cgit v1.2.3-54-g00ecf