Fix warnings (#164)

* Fix warnings

and some minor reformulations

* try again, maybe travis ci likes this better

Author: doniks

porting/common-kernel-build-errors.rst

@@ -6,53 +6,63 @@ These are the ``hybris-boot`` build errors most commonly seen in the Halium comm
 Implicit declaration of 'kvfree'
 --------------------------------
 
-If you receive something similar to the following error::
+If you receive something similar to the following error:
 
-   ../../../../../../kernel/[...]/[...]/security/apparmor/apparmorfs.c: In function 'aa_simple_write_to_buffer':
-   ../../../../../../kernel/[...]/[...]/security/apparmor/apparmorfs.c:110:3: error: implicit declaration of function 'kvfree' [-Werror=implicit-function-declaration]
+.. code-block:: text
+
+   kernel/[...]/[...]/security/apparmor/apparmorfs.c: In function 'aa_simple_write_to_buffer':
+   kernel/[...]/[...]/security/apparmor/apparmorfs.c:110:3: error: implicit declaration of function 'kvfree' [-Werror=implicit-function-declaration]
    kvfree(data);
 
 Apply the patch `nick kvfree() from apparmor`_.
 
 'kuid_t' (sdcardfs, cgroup) error
 ---------------------------------
 
-Example of the error::
+Example of the error:
+
+.. code-block:: text
 
-   ../../../../../../kernel/lenovo/msm8916/kernel/cgroup.c:2138:37: error: invalid operands to binary != (have 'kuid_t' and 'kuid_t')
+   kernel/lenovo/msm8916/kernel/cgroup.c:2138:37: error: invalid operands to binary != (have 'kuid_t' and 'kuid_t')
    if (current != task && cred->euid != tcred->uid &&
 
-   ../../../../../../kernel/lenovo/msm8916/kernel/cgroup.c:2139:18: error: invalid operands to binary != (have 'kuid_t' and 'kuid_t')
+   kernel/lenovo/msm8916/kernel/cgroup.c:2139:18: error: invalid operands to binary != (have 'kuid_t' and 'kuid_t')
        cred->euid != tcred->suid)
 
 Set ``CONFIG_USER_NS`` to ``n`` in your defconfig.
 
 Firmware class error
 --------------------
 
-Example of the error::
+Example of the error:
 
-   ../../../../../../kernel/lenovo/msm8916/drivers/base/firmware_class.c: In function '_request_firmware':
-   ../../../../../../kernel/lenovo/msm8916/drivers/base/firmware_class.c:1226:38: warning: passing argument 2 of 'fw_load_from_user_helper' from incompatible pointer type
+.. code-block:: text
+
+   kernel/lenovo/msm8916/drivers/base/firmware_class.c: In function '_request_firmware':
+   kernel/lenovo/msm8916/drivers/base/firmware_class.c:1226:38: warning: passing argument 2 of 'fw_load_from_user_helper' from incompatible pointer type
    error, forbidden warning: firmware_class.c:1226
 
 Set ``CONFIG_FW_LOADER_USER_HELPER`` to ``y`` in your defconfig.
 
 ECRYPTFS error
 --------------
 
-Example of the error::
+Example of the error:
+
+.. code-block:: text
 
-   ../../../../../../kernel/lenovo/msm8916/fs/ecryptfs/file.c: In function 'ecryptfs_readdir':
-   ../../../../../../kernel/lenovo/msm8916/fs/ecryptfs/file.c:130:16: error: assignment of read-only member 'actor'
-  buf.ctx.actor = ecryptfs_filldir;
+   kernel/lenovo/msm8916/fs/ecryptfs/file.c: In function 'ecryptfs_readdir':
+   kernel/lenovo/msm8916/fs/ecryptfs/file.c:130:16: error: assignment of read-only member 'actor'
+   buf.ctx.actor = ecryptfs_filldir;
 
 Apply `'patch ecryptfs to fix a build error' from bullhead`_.
 
 'Undefined reference to pidns_operations' on Linux 3.4
 ------------------------------------------------------
 
-The implementation of PID Namespacing was incomplete in the Android kernel 3.4, causing the following error::
+The implementation of PID Namespacing was incomplete in the Android kernel 3.4, causing the following error:
+
+.. code-block:: text
 
    fs/built-in.o:namespaces.c:ns_entries: error: undefined reference to 'pidns_operations'
 
@@ -61,20 +71,24 @@ To fix this issue, apply the patch `Finish implementation of PID namespace`_
 'struct perf_cpu_context' has no member named 'unique_pmu'
 ----------------------------------------------------------
 
-This is caused by an incomplete merge of a few changes in some 3.4 kernels::
+This is caused by an incomplete merge of a few changes in some 3.4 kernels:
+
+.. code-block:: text
 
-   /../../../../kernel/fairphone/msm8974/kernel/events/core.c: In function 'perf_cgroup_switch':
-   /../../../../kernel/fairphone/msm8974/kernel/events/core.c:379:13: error: 'struct perf_cpu_context' has no member named 'unique_pmu'
+   kernel/fairphone/msm8974/kernel/events/core.c: In function 'perf_cgroup_switch':
+   kernel/fairphone/msm8974/kernel/events/core.c:379:13: error: 'struct perf_cpu_context' has no member named 'unique_pmu'
    if (cpuctx->unique_pmu != pmu)
 
 To fix this issue, apply `perf: Clarify perf_cpu_context::active_pmu usage by renaming it to ::unique_pmu`_
 
 'PROC_PID_INIT_INO' undeclared here (not in a function)
 -------------------------------------------------------
 
-Somehow, the implementation of the ``/proc`` filesystem is incomplete in some 3.4 kernels::
+Somehow, the implementation of the ``/proc`` filesystem is incomplete in some 3.4 kernels:
 
-   /../../../../kernel/fairphone/msm8974/kernel/pid.c:81:15: error: 'PROC_PID_INIT_INO' undeclared here (not in a function)
+.. code-block:: text
+
+   kernel/fairphone/msm8974/kernel/pid.c:81:15: error: 'PROC_PID_INIT_INO' undeclared here (not in a function)
      .proc_inum = PROC_PID_INIT_INO,
 
 Add the following line after all of the other ``#include`` lines in the file kernel/user_namespace.c similar to https://github.com/Halium/android_kernel_lge_hammerhead/commit/5754614eb43dea44a99e54898e3b83d4d96d8b83 ::
@@ -84,11 +98,12 @@ Add the following line after all of the other ``#include`` lines in the file ker
 POSIX_ACL not supported in 3.18 backport
 ----------------------------------------
 
-Example of the error::
+Example of the error:
+
+.. code-block:: text
 
-   /home/florian/halium-7.1/kernel/huawei/angler/fs/ext4/inode.c: In function 'ext4_setattr':
-   /home/florian/halium-7.1/kernel/huawei/angler/fs/ext4/inode.c:4717:2: error: #error POSIX_ACL not supported in 3.18 backport
-    #error POSIX_ACL not supported in 3.18 backport
+   kernel/huawei/angler/fs/ext4/inode.c: In function 'ext4_setattr':
+   kernel/huawei/angler/fs/ext4/inode.c:4717:2: error: #error POSIX_ACL not supported in 3.18 backport
 
 Set ``CONFIG_EXT4_FS_POSIX_ACL`` to ``n`` in your defconfig.
 

porting/common-system-build-errors.rst

@@ -17,20 +17,20 @@ Also check the vendor folders of your dependencies.
 Undefined or missing bluetooth headers
 --------------------------------------
 
-.. code-block:: guess
+.. todo::
 
-    *TODO: example*
+    add example of error message
 
-Some devices requires bluetooth when compiling, which aren't synced for default by Halium. This can be fixed adding LineageOS's repo to the device manifest:
+Some devices require bluetooth headers which aren't synced by default. This can be fixed by adding the following repository to the device manifest:
 
-... to the device manifest::
+.. code-block:: xml
 
     <project path="system/bt" name="android_system_bt" remote="los" revision="cm-14.1" />
 
 HYBRIS_BOOT_PART and HYBRIS_DATA_PART
 -------------------------------------
 
-.. code-block:: guess
+.. code-block:: text
 
    find: ‘device/*/generic’: No such file or directory
    find: ‘device/unknown’: No such file or directory
@@ -39,30 +39,32 @@ HYBRIS_BOOT_PART and HYBRIS_DATA_PART
    halium/hybris-boot/Android.mk:68: ********************* /data appears to live on ERROR: *fstab* not found
    halium/hybris-boot/Android.mk:71: *** There should be a one and only one device entry for HYBRIS_BOOT_PART and HYBRIS_DATA_PART.
 
-Make sure you run the commands :ref:`here <breakfast-and-lunch>` before trying to build. The Makefile depends on the environment set up immediately before by envsetup.sh; so if running in a build environment such as Emacs, be sure to set your compile command to something like "source build/envsetup.sh && breakfast [codename] && make [target]"
+Make sure you rerun the :ref:`initialization commands <breakfast-and-lunch>` before trying to build. The Makefile depends on the environment set up immediately before by ``envsetup.sh``. So if running in a build environment such as Emacs, be sure to set your compile command to something like ``source build/envsetup.sh && breakfast [codename] && make [target]``.
 
 
 .. _remove apks on lyudmila17/android_device_motorola_athene: https://github.com/Lyudmila17/android_device_motorola_athene/commit/a752422012165d937c058c1b671497bad44a4962
 
 Flex locale error
 -----------------
 
-.. code-block:: guess
+.. code-block:: text
 
    [ 19% 2365/12156] Lex: checkpolicy <= external/selinux/libsepol/cil/src/cil_lexer.l
    FAILED: /bin/bash -c "prebuilts/misc/linux-x86/flex/flex-2.5.39 -o/home/peter/docs/devel/halium.amami/out/host/linux-x86/obj/STATIC_LIBRARIES/libsepol_intermediates/cil/src/cil_lexer.c external/selinux/libsepol/cil/src/cil_lexer.l"
    flex-2.5.39: loadlocale.c:130: _nl_intern_locale_data: Assertion `cnt < (sizeof (_nl_value_type_LC_TIME) / sizeof (_nl_value_type_LC_TIME[0]))' failed.
    Aborted (core dumped)
 
-This seems to be a problem with locales and the prebuilt ``flex``. You can avoid this by using the flex installed on your host::
+This seems to be a problem with locales and the prebuilt ``flex``. You can avoid this by using the flex installed on your host:
+
+.. code-block:: bash
 
     export USE_HOST_LEX=yes
     make systemimage
 
 Missing bison error
 -------------------
 
-.. code-block:: guess
+.. code-block:: text
 
     [  1% 322/20069] Yacc: checkpolicy <= external/selinux/checkpolicy/policy_parse.y
     FAILED: /bin/bash -c "prebuilts/misc/linux-x86/bison/bison -d -v --defines=/home/builder/workdir/out/host/linux-x86/obj/EXECUTABLES/checkpolicy_intermediates/policy_parse.h -o /home/builder/workdir/out/host/linux-x86/obj/EXECUTABLES/checkpolicy_intermediates/policy_parse.c external/selinux/checkpolicy/policy_parse.y"
@@ -72,7 +74,7 @@ The error message is very misleading here. The issue stems from the bison shippe
 
 The fix is to install 32-bit support for Ubuntu via:
 
-.. code-block:: guess
+.. code-block:: bash
 
     sudo dpkg --add-architecture i386
     sudo apt-get update