[WIP] How to Write an Updater-Script with Edify Code

[Karadorde]

First and foremost I take no credit for the majority of this thread. I am merely posting this here as a reference for you all. I had to dig around a lot for this information and piece it together from several different threads as well as pull examples from updater-scripts in several different roms/theme/etc. Everyone else put in the work, I am just trying to make it easier for the rest of us .

Mounting Partitions:
MTD:

mount("MTD", "system", "/system");
mount("MTD", "userdata", "/data");
mount("MTD", "cache", "/cache");
mount("MTD", "sdcard", "/sdcard");

EMMC with EXT3 and EXT4 file systems:

mount("ext4", "EMMC", "/dev/block/mountpoint", "/system");
mount("ext4", "EMMC", "/dev/block/mountpoint", "/data");
mount("ext4", "EMMC", "/dev/block/mountpoint", "/cache");

mount("ext3", "EMMC", "/dev/block/mountpoint", "/system");
mount("ext3", "EMMC", "/dev/block/mountpoint", "/data");
mount("ext3", "EMMC", "/dev/block/mountpoint", "/cache");

“mountpoint” will vary from device to device. Decide what partition you want to mount, find where it mounts (there will be resources in the second post, and paste it in place of “mountpoint” in your script.

Mounting system, data, and cache on the EVO 3D

mount("ext4", "EMMC", "/dev/block/mmcblk0p23", "/system");
mount("ext4", "EMMC", "/dev/block/mmcblk0p24", "/data");
mount("ext4", "EMMC", "/dev/block/mmcblk0p25", "/cache");

Amend

[I][COLOR="Gray"]none[/COLOR][/I]

Unmounting Partitions:
MTD and EMMC:

unmount("/system");
unmount("/data"); [COLOR="Red"]OR[/COLOR] unmount("/userdata");
unmount("/cache");
unmount("/sdcard");

Amend

[I][COLOR="Gray"]none[/COLOR][/I]

Format Partitions:
MTD:

format("MTD", "system");
format("MTD", "cache");
format("MTD", "data");
format("MTD", "boot");

EMMC EXT3/4:

format("ext4", "EMMC", "/dev/block/mountpoint");

format("ext3", "EMMC", "/dev/block/mountpoint");

Formatting system, data, cache, and boot on EVO 3D.

format("ext4", "EMMC", "/dev/block/mmcblk0p23");
format("ext4", "EMMC", "/dev/block/mmcblk0p24");
format("ext4", "EMMC", "/dev/block/mmcblk0p25");
format("ext4", "EMMC", "/dev/block/mmcblk0p22");

Amend:

[I][COLOR="Gray"]format SYSTEM:
format DATA:
format BOOT:
format CACHE:[/COLOR][/I]

Copy files from .zip file to phone partition or sd card:

package_extract_dir("Source", "Destination");

“Source” = folder in .zip file. "Destination" = partition to copy to,

package_extract_dir("system", "/system");
package_extract_dir("data", "/data");
package_extract_dir("sdcard", "/sdcard");

Amend:

[I][COLOR="Gray"]copy_dir PACKAGE:system SYSTEM:
copy_dir PACKAGE:data DATA:
copy_dir PACKAGE:sdcard SDCARD:
[/COLOR][/I]

Write an .img file:
MTD:

assert(package_extract_file("boot.img", "/tmp/boot.img"),
write_raw_image("/tmp/boot.img", "boot"),
delete("/tmp/boot.img"));

EMMC:

package_extract_file("boot.img", "/dev/block/mountpoint");

Amend

[I][COLOR="Gray"]write_raw_image PACKAGE:boot.img BOOT:[/COLOR][/I]

Output a line of text:
MTD/EMMC:

ui_print("Text Here");

Amend

[I][COLOR="Gray"]none[/COLOR][/I]

Delete a file:

Use delete for a single file. Use delete recursive for an entire folder.

delete_recursive("file/path");

delete("/path/to/file");

Amend

[I][COLOR="Gray"]delete_recursive PARTITION:path/to/file[/COLOR][/I]

[I][COLOR="Gray"]delete PARTITION:path/to/file[/COLOR][/I]

Set ownership and permissions for folder:

set_perm_recursive(uid, gid, dmode, fmode, “/path/to/folder”);

Amend

[COLOR="Gray"]set_perm_recursive uid gid dmode fmode PARTITION:path[/COLOR]

Set ownership and permissions for a file:

set_perm(uid, gid, mode, “/path/to/file”);

Amend

[COLOR="Gray"]set_perm uid gid mode PARTITION:file[/COLOR]

Run a program:

run_program("programtorun");

Amend

[I][COLOR="gray"]run_program PACKAGE:programtorun[/COLOR][/I]

Creating symlinks:

symlink("/path/to/file", "/path/tofile");

Amend

[COLOR="gray"][I]symlink /path/to/file PARTITION:path/to/file[/I][/COLOR]

Progress bar:

show_progress(fraction, duration);

Amend

[COLOR="gray"][I]show_progress fraction, duration[/I][/COLOR]

 

[Karadorde]

Mount points for selected devices:

Evo 3D

mmcblk0p21          /boot
mmcblk0p23          /system
mmcblk0p24          /data
mmcblk0p25          /cache

Evo Shift 4G

mmcblk0p22          /boot
mmcblk0p26          /system
mmcblk0p27          /data
mmcblk0p28          /cache

Nexus S

mtdblock4				/cache
platform/s3c-sdhci.0/by-name		/system
platform/s3c-sdhci.0/by-name		/userdata

 

[Karadorde]

reserved for more info at a later date

 

[dkelle4]

excellent tutorial. answered a lot of questions i had

 

[-shift-]

w00t w00t! thanks for this, dude!

 

[DrRyder]

http://forum.xda-developers.com/showthread.php?t=936175

A lot of information in there that I have bookmarked and used without problems.

 

[Karadorde]

http://forum.xda-developers.com/showthread.php?t=936175

A lot of information in there that I have bookmarked and used without problems.

Thanks. Will update. Just wanted to post something for the EVO users so we have our own thread to reference.

EDIT: Also, looks like he might be missing a few commands. Not a big deal. Any and all help is appreciated.

 

[DrRyder]

Oh yeah. Of course. I know some stuff is missing, but I also like the color coding of it and showing what the Amend syntax is compared to the Edify. So, I thought I would post it. It's been useful to me.

 

[dkdude36]

thank you so much for making this. now people will stop bothering me and tiffany about our fantastic zips not working in cwm 3.+

 

[nubecoder]

Some more resources for you all...

Here and here (source code is included if you would like to see the conversions being done).

=]

 

[Droidzone]

Is there any way to change the color of text output in ui_print?

 

[Karadorde]

Is there any way to change the color of text output in ui_print?

I believe that is dependent on how your recovery is built.

Sent from my PC36100 using XDA Premium App

 

[nubecoder]

Is there any way to change the color of text output in ui_print?

I believe that is dependent on how your recovery is built.

If you rebuild the recovery it can be changed, but there are no options built in that will allow you to change the colors.
I'm of course referring to ClockworkMod recovery, since Amon_RA's github is outdated, I haven't really looked through his code.

=]

 

[MarylandCookie]

Anyone know the arguments/parameters to format boot to ext4?
The Desire S is Ext4 by default but i keep getting a status 1 error code when using Ext4, however Ext3 works fine.
Ive tried mounting and unmounting prior to format but no luck what so ever
You can find the partition information for the DS here:
http://forum.xda-developers.com/showthread.php?t=1057342

 

[XsMagical]

Thanks for the guide. This will help a lot in the future

Sent from my xEVO using XDA premium app

 

[-shift-]

ooh i see you've updated for the evo 3d

 

[drmacinyasha]

One trick I used in creating the superuser and gapps ZIPs:

run_program("/sbin/busybox", "mount", "/system");

It runs just fine on both eMMC and MTD devices, and the only prerequisites are that the recovery has busybox, and already knows the mount points (which any good recovery should). Been working on Amon_RA, ClockworkMod 2-4, and TWRP.

 

[splattx_x]

Great tutorial!

Just one question, the # symbol preceeding a line is used for comments, right?

Thanks!!

 

[nubecoder]

Just one question, the # symbol preceeding a line is used for comments, right?

Yes, if the 1st char in the line is '#' that line is a comment.

=]

 

[splattx_x]

Yes, if the 1st char in the line is '#' that line is a comment.

=]

Awesome! Thanks. Now I have to figure out why I can't flash any zip in my phone with CWM.

This guide is very helpful. Any chance anyone knows where to get the update-binary? I know I can get it from a ROM but I'd like to learn so I can cook my own ROM from scratch.