• 70-android.rules
    • android.conf (for display scaling, see below)

    Perhaps add a full path for them, for the context (the name is pretty confusing when appear on their own).

    • touch.pa (for pulseaudio sound configuration/initialization, see below)

    touch.pa shouldn't need to be overridden except for special circumstance. Probably better to leave out of this page.

    You can extract this file from the device using adb pull or scp and copy it to the 'ubuntu' directory of your device source tree...

    This assumes that the device is already running Ubuntu Touch, which is not the case for porters. The method of creating a (basic) udev rules file is documented here:

    https://docs.ubports.com/en/latest/porting/configure_test_fix/Lomiri.html#create-and-add-udev-rules

    (Side note: you'll notice that the method is pretty generic. I once proposed to move this into rootfs so that porters doesn't have to do this, but it's not well accepted. Maybe I'll revisit this when we bring up Halium 12, with the arrival of "Generic Kernel Image")

    Ubuntu Touch 16.04 only allows replacing or introducing individual files on the Ubuntu Touch root filesystem.

    Perhaps this sentence should be removed. The "extracting over rootfs" method can already create a new folder or merge an existing one (e.g. by placing new files in an existing directory).

    Overlay files and directories need to be placed in the repository under overlay/system

    Now, this is an unfortunate side effect of the bad naming. See, because the device tarballs are not really built differently, overlay/system will still be extracted directly onto the rootfs -- that's now device tarballs work. The difference in the new method is that, instead of placing the files directly to where it is, we place it in the "shadow folder" that is /opt/halium-overlay/ on rootfs. This means the final path in the repo becomes overlay/system/opt/halium-overlay (unless the build script is changed).


    Another thing is that, actually .halium-{override,overlay}-dir will also work on 20.04 with Halium 7 or full-system.img devices too -- in the exact same way. However, I have to admit that it's a little bit confusing to incorporate this into this page now. Maybe, if you really want to, you may need to arrange them by the 16.04 methods followed by 20.04 method.

    You'll notice that the way the newest system, on the surface, looks very similar the old Halium 7.1 way. I would like you to think of the newest system as the old system + .halium-{override,overlay}-dir, with an alternative overlay source.

    Edited by Ratchanan Srirattanamet
  • Perhaps add a full path for them, for the context (the name is pretty confusing when appear on their own).

    I actually only rewrote the subsection "Overlay method for Gitlab CI script-based builds" (snippets suck for reviews), but I'll fix that.

    touch.pa shouldn't need to be overridden except for special circumstance. Probably better to leave out of this page.

    Will fix that as well.

    This assumes that the device is already running Ubuntu Touch, which is not the case for porters. The method of creating a (basic) udev rules file is documented here:

    Will remove that.

    Perhaps this sentence should be removed. The "extracting over rootfs" method can already create a new folder or merge an existing one (e.g. by placing new files in an existing directory).

    Another thing is that, actually .halium-{override,overlay}-dir will also work on 20.04 with Halium 7 or full-system.img devices too -- in the exact same way. However, I have to admit that it's a little bit confusing to incorporate this into this page now. Maybe, if you really want to, you may need to arrange them by the 16.04 methods followed by 20.04 method.

    You'll notice that the way the newest system, on the surface, looks very similar the old Halium 7.1 way. I would like you to think of the newest system as the old system + .halium-{override,overlay}-dir, with an alternative overlay source.

    I believe it's best to rewrite the whole page and reorganize first by Ubuntu Touch version and then by build method, so

    • Ubuntu 16.04
      • system.img build
      • GitLab CI build
    • Ubuntu 20.04
      • system.img build
      • GitLab CI build

    mentioning the recommended method for each case.

    I will continue in https://github.com/gber/docs.ubports.com/tree/overlay-files-focal.

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment