FAQs and Common Error while building Custom ROMs.
Disclaimer: All these FAQs and Solutions are taken from my knowledge and experience if anything wrong please point out so I can correct it.And feel free to add more FAQs and Errors from your side
FAQ #1 : Easiest way to setup build environment ?
Their is a script will will make all the work easy by Akhil Narang XDA senior Member and great dev Steps to be followed:
git clone https://github.com/akhilnarang/scripts cd scripts bash setup
FAQ #2: Which is the best distro to build custom rom?
I will always recommend to use Ubuntu 14.04 Download Link : DOWNLOAD NOW
FAQ #3: If I have low internet speed how to sync sources that too 60Gb and all?
Use Google cloud Platform which is the best because internet speed syncs source within half an hour build speed max 2hour first build then less than 30mins
FAQ #4: Is any programming language required to study while building ROMs?
Absolutely No since for making roms from source you just require BASIC English thats it and few logic how does fuctions work etc.
FAQ #5: I have MacBook can I built on it since it is having BASH terminal?
Sure you don't need to install another distro inbuilt Mac OS is enough.
FAQ #6: While building it stopped what to do ?
Simplest way is copy whole data and paste in any IDE and search for "FAILED:" line and read it understand what made wrong then google how to fix it,Few common errors and their fixed are their below just bookmark if you need.
FAQ #7:I Googled still not found a solution how to fix it ?
Their are many ways ask on XDA else you get contact with developer of that rom message him and resolve it.
FAQ #8: Is there any full tutorial for NOOB users ?
- 1 [GUIDE][COMPLETE] Android ROM Development From Source To End 2 [GUIDE]A Noob Guide On Building Your Own Custom Kernel (ARM & MTK) (ARM64 coming) 3 [GUIDE][COMPLETE]How to build ROM with Google Cloud
FAQ #9: What is Cherry-picking is please explain?
It is actually taking a feature of one rom and then add to your rom by giving proper credits to author etc.There is a good tutorial for doing this refer to this How to apply patches to the source ?.This will surely help you a lot.
FAQ #10: Is there any place where I can get full details of rom files folders etc ?
Yes there is an awesome post explaining everything. [GUIDE] Understanding the Android Source Code
FAQ #11: I have one commit which is commit but I need to add proper author to it what to do?
git commit --amend --author="NAME"
This will add author to last commit
FAQ #12: I have done changes I need to overwrite the commit its not allowing asking for pull and retry like that.
Do same git push command just add
-f tag so it overwrites the git.
git push GitHub 7x -f instead of
git push GitHub 7x.
FAQ #13: Any Simple way to resolve conflicts while cherry-picking ?
The best way is to use search tool and search for ">>>","<<<","===" remove, add keep both depending on code.Second Method is by using GitHub as search.
FAQ #14: Is there any simpler way to check cherry-picked correctly or not since building whole ROM takes time.
Build only the required package to check if it worked correctly then build Rom as whole .For e.g. you made changes to kernel and device tree in that case just use time mka boot image rather than time mka bacon.
FAQ #15:How to remove snap camera from building?
Answer:Remove Snap from BoardConfig and use zip contents and manifest to see what permissions to do, use PRODUCTCOPYFILES command
FAQ #16: How is flashable ZIP of kernels made ?
Android zips have
updater-script which is programmed in edifier,You basically need to make a flashable zip which would write
FAQ #17: Should I dexpreopt my builds?
Not necessary it is just first boot speeding up and take extra size around 100mb more.
FAQ #18: What does boot.img contain?
It has kernel and ramdisk
FAQ #19 What are BLOBS?
Blobs are vendor files and prebuilt libs which are found in system, importing them is copy paste + the mk file, It's usually found in /system/vendor and /system/lib.
All these errors I mention are faced by me and solution which I did is written along.
Common Error 1: Compile time error
libwpa_qmi_eap_proxy_ intermediates/export_includes', needed by $user/$rom/out/target/product/oneplus2/obj/EXECUTABLES/wpa_supplicant_intermediates/import_includes', missing and no known rule to make it make: *** [ninja_wrapper] Error 1
First check wheather your vendor repo is broken or not or is it included or not if not clone it from correct source. Clone wpa supplicant ,wpa_supplicant8 from lineageos and retry it
Common Error 2: Build is successful but its not booting what to do?
Make another build with permissive by adding
BoardConfig.mk it should work.
Common Error 3: I have synced device tree but device is not showing in breakfast nor lunch menu
- First change romname.mk file to your rom name ,for e.g. you synced Du tree and trying to make nitrogen rom so
mv du.mk nitrogen.mk.
vendorsetup.shmake appropriate name of device name with ROM.
.dependenciesname to rom name for e.g..
du.dependenciesmake it nitrogen.dependencies
- Make AndroidProducts.mk and call device.mk from it.
Will show you how things are done.
Oneplus2 device tree modded for supporting VertexOS: 163acc80fc7969bfdac823a30d6c9bd31b6060b1.
Oneplus2 device tree modded for supporting Candy Rom: f0f95d2d3a03a43da91668f17f284a4b994d5f5f.
There will be so much commits like this just git search then your good to go. This must be general case for most of the rom and devices just refer this.
Common Error 4: Missing library and no rule to make it (
ninja: error: '/home/vibhoothiiaanand/nitrogen/out/target/product/oneplus2/obj/SHARED_LIBRARIES/libqdutils_intermediates/export_includes', needed by '/home/vibhoothiiaanand/nitrogen/out/target/product/oneplus2/obj/SHARED_LIBRARIES/libsurfaceflinger_intermediates/import_includes', missing and no known rule to make it make: *** [ninja_wrapper] Error 1
This is common error and its due to missing hardware BLOBs so to fix this there are few things to clone these files are to cross checked if not clone from lineage
hardware/qcom/display hardware/qcom/display-caf hardware/qcom/audio hardware/qcom/audio-caf hardware/qcom/media hardware/qcom/media-caf hardware/qcom/bootctrl hardware/qcom/bt hardware/qcom/bt-caf hardware/qcom/camera hardware/qcom/gps hardware/qcom/wlan hardware/qcom/wlan-caf hardware/qcom/keymaster
and for cloning I will show you how its done for Oneplus2
git clone https://github.com/LineageOS/android_hardware_qcom_display.git -b cm-14.1 hardware/qcom/display/msm8994 git clone https://github.com/LineageOS/android_hardware_qcom_audio.git -b cm-14.1 hardware/qcom/audio/msm8994 git clone https://github.com/LineageOS/android_hardware_qcom_media.git -b cm-14.1 hardware/qcom/media/msm8994 git clone https://github.com/LineageOS/android_hardware_qcom_display.git -b cm-14.1-caf-8994 hardware/qcom/display-caf/msm8994 git clone https://github.com/LineageOS/android_hardware_qcom_audio.git -b cm-14.1-caf-8994 hardware/qcom/audio-caf/msm8994 git clone https://github.com/LineageOS/android_hardware_qcom_media.git -b cm-14.1-caf-8994 hardware/qcom/media-caf/msm8994
Common Error 5:
generic/goldfish missing and its needed by
device/generic/goldfish/data/etc/apns-conf.xml', needed by '$user/$rom/out/target/product/oneplus2/system/etc/apns-conf.xml', missing and no known rule to make it.
generic/goldfish from google
This is due to the source is old in Lineage Source.
git clone https://android.googlesource.com/device/generic/goldfish device/generic/goldfish
6 Common Error 6:
frameworks/native/build/phone-xxxhdpi-4096-dalvik-heap.mk does not exist.
Cherry-pick this commit
Done it must be fixed
Common Error 7: Missing
ERROR: couldn't find ro.product.model in build.prop
This is not that common but this happens while compiling
fix is cherry-pick this commit
git cherry-pick https://github.com/AICP/build/commit/df574f3e6ae115425b2c25e5b5e6772503ca0f65
Common Error 8: Model number unknown.
Go to device tree and open
init/init*.cpp make device name and instead of
std::string device = property_get("ro..device"); ->
std::string device = property_get("ro.product.device");
Common Error 9: Deleting obsolete path
Deleting obsolete path /home/vibhoothiiaanand/vertex/device/oneplus/oneplus2 Deleting obsolete path /home/vibhoothiiaanand/vertex/device/oppo/common Deleting obsolete path /home/vibhoothiiaanand/vertex/kernel/oneplus/msm8894 Deleting obsolete path /home/vibhoothiiaanand/vertex/vendor/oneplus
This is due to not declaring repos in local manifest
Common Error 10: Broken gestures
For this two things must be noted
- Device common
Both must match the node names.
In case of
configpanel/src/com/cyanogenmod/settings/device/utils/Constants.java should match node declaration values
Common Error 11: Dex2oated errors
For this easy fix is disabling dexpreopt
Common error 12: JAVA `boot.art is missing
ninja: error: '/home/vibhoothiiaanand/vertex/out/target/common/obj/JAVA_LIBRARIES/rcscommon_intermediates/javalib.jar', needed by '/home/vibhoothiiaanand/vertex/out/target/product/oneplus2/dex_bootjars/system/framework/arm64/boot.art', missing and no known rule to make it make: *** [ninja_wrapper] Error 1 make: Leaving directory `/home/vibhoothiiaanand/vertex'
For me this happened while building vertex for that I removed telephony entry from androidvendorvertex/config/common.mk
Common Error 13: SHARED_LIBRARIES is needed by target.
/out/target/product/oneplus2/obj/SHARED_LIBRARIES/libdhcpcd_intermediates/export_includes', needed by '/home/coolmohammad98/cr/out/target/product/oneplus2/obj/EXECUTABLES/ipacm_intermediates/
For this clone
git clone https://github.com/lineageos/android_external_libnfnetlink
and then your good to go
MZO for helping out.