Skip to content

Commit 327a709

Browse files
committed
Update make help
1 parent 8bf38bb commit 327a709

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

Makefile

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -38,63 +38,63 @@ help:
3838
@echo ''
3939
@echo '$(GREEN)Build/Config:$(NC)'
4040
@echo ' Targets:'
41-
@echo ' linux (default) - builds the Linux kernel'
42-
@echo ' linux_defconfig - builds the Linux kernel'
43-
@echo ' linux_modules - builds the Linux kernel modules'
44-
@echo ' ack - builds the Android Common Kernel'
45-
@echo ' tools-vm - builds linux/tools/vm'
41+
@echo ' linux (default) - Builds the Linux kernel'
42+
@echo ' linux_defconfig - Builds the Linux kernel'
43+
@echo ' linux_modules - Builds the Linux kernel modules'
44+
@echo ' ack - Builds the Android Common Kernel'
45+
@echo ' tools-vm - Builds linux/tools/vm'
4646
@echo ''
4747
@echo ' Environment Variables:'
48-
@echo ' LINUX_DEFCONFIG - TODO'
49-
@echo ' LINUX_SRC - TODO'
50-
@echo ' LINUX_OUT - TODO'
51-
@echo ' LINUX_CONFIG_FRAGMENT - TODO'
48+
@echo ' LINUX_DEFCONFIG - The defconfig to use when building the kernel (default: defconfig, ACK default: gki_defconfig)'
49+
@echo ' LINUX_SRC - The path to the kernel source directory (default: linux, ACK default: ack/common)'
50+
@echo ' LINUX_OUT - The path where the kernel build output should be stored (default: out/linux/$$ARCH, ACK default: out/ack/common/$$ARCH)'
51+
@echo ' LINUX_CONFIG_FRAGMENT - A kernel config fragment to merge with the defconfig (default: config/config.fragment, ACK default: config/config.fragment)'
5252
@echo ''
5353
@echo '$(GREEN)Clean:$(NC)'
5454
@echo ' Targets:'
55-
@echo ' clean - cleans output from default build targets'
56-
@echo ' <target>_clean - cleans output for <target>'
55+
@echo ' clean - Cleans output from default build targets'
56+
@echo ' <target>_clean - Cleans output for <target>'
5757
@echo ''
5858
@echo '$(GREEN)Run/Debug:$(NC)'
5959
@echo ' Targets:'
60-
@echo ' run - run QEMU with the built kernel, bootloader, and rootfs image'
61-
@echo ' run-ack - same as `run` but runs ACK instead'
60+
@echo ' run - Run QEMU with the built kernel, bootloader, and rootfs image'
61+
@echo ' run-ack - Same as `run` but runs ACK instead'
6262
@echo ''
6363
@echo ' Environment Variables:'
6464
@echo ' GDB - Set to 1 to start a gdbserver and wait for GDB when running QEMU (default: 0)'
6565
@echo ' CPU - Specify the number of CPUs to use when running QEMU (default: 4)'
6666
@echo ' MEM - Specify the memory size in MB to use when running QEMU (default: 1024)'
6767
@echo ' QEMU_EXTRA_ARGS - Specify additional arguments to pass to QEMU (default: "")'
6868
@echo ' QEMU_EXTRA_KERNEL_CMDLINE - Specify additional arguments to pass to the kernel (default: "")'
69-
@echo ' KERNEL_IMAGE - TODO'
70-
@echo ' ROOTFS - TODO'
71-
@echo ' ROOTFS_FORMAT - TODO'
72-
@echo ' RDINIT - TODO'
73-
@echo ' INITRD - TODO'
69+
@echo ' KERNEL_IMAGE - The path to the kernel image to run (x86_64 default: $$LINUX_OUT/arch/$$ARCH/boot/bzImage, arm64 default: $$LINUX_OUT/arch/$$ARCH/boot/Image)'
70+
@echo ' ROOTFS - The path to the rootfs image file (default: rootfs/rootfs-$$ARCH.img)'
71+
@echo ' ROOTFS_FORMAT - The format of the rootfs image file (default: qcow2)'
72+
@echo ' INITRD - The path to a gziped initramfs CPIO file to use instead of a rootfs image (default: "")'
73+
@echo ' RDINIT - The value of the `rdinit` kernel command line paramter (default: "", default if INITRD is set: /sbin/init)'
7474
@echo ''
7575
@echo '$(GREEN)rootfs:$(NC)'
7676
@echo ' Targets:'
77-
@echo ' rootfs-init - TODO'
78-
@echo ' rootfs - TODO'
79-
@echo ' ext4 - TODO'
80-
@echo ' cpio - TODO'
81-
@echo ' rootfs-mount - TODO'
82-
@echo ' rootfs-unmount - TODO'
77+
@echo ' rootfs-init - Extracts the Alpine Linux rootfs to rootfs/alpine-$$ARCH, makes arch-specific changes, and builds a rootfs image at rootfs/alpine-$$ARCH.img'
78+
@echo ' rootfs - An alias for the `ext4` target'
79+
@echo ' ext4 - Builds a QCOW2 rootfs image at rootfs/alpine-$$ARCH.img with an ext4 filesystem'
80+
@echo ' cpio - Builds a gziped initramfs CPIO file from the $$INITRAMFS_DIR directory'
81+
@echo ' rootfs-mount - Mount rootfs image at /tmp/rootfs'
82+
@echo ' rootfs-unmount - Unmount rootfs image'
8383
@echo ''
8484
@echo ' Environment Variables:'
85-
@echo ' EXT4_SIZE - TODO'
86-
@echo ' INITRAMFS_DIR - TODO'
87-
@echo ' ROOTFS - TODO'
88-
@echo ' ROOTFS_DIR - TODO'
89-
@echo ' ROOTFS_FORMAT - TODO'
85+
@echo ' EXT4_SIZE - The disk size of the rootfs image to build'
86+
@echo ' INITRAMFS_DIR - The directory to create the initramfs from (default: rootfs/alpine-$$ARCH)'
87+
@echo ' ROOTFS_DIR - The directory to create the ext4/rootfs image from (default: rootfs/alpine-$$ARCH)'
88+
@echo ' ROOTFS - The path to the rootfs image file (default: rootfs/rootfs-$$ARCH.img)'
89+
@echo ' ROOTFS_FORMAT - The format of the rootfs image file (default: qcow2)'
9090
@echo ''
9191
@echo '$(GREEN)Miscellaneous:$(NC)'
9292
@echo ' Targets:'
93-
@echo ' linux_download - TODO'
94-
@echo ' linux_checkout - TODO'
93+
@echo ' linux_download - Downloads an archive of the Linux kernel source for the version specified in $$VERSION'
94+
@echo ' linux_checkout - Checks out the version specified by $$VERSION of the linux kernel in $$LINUX_SRC'
9595
@echo ''
9696
@echo ' Environment Variables:'
97-
@echo ' VERSION - TODO'
97+
@echo " VERSION - The version to download or checkout. For checkout only, if the third number in the version string is a 'y', the latest version of the kernel with that major and minor version is used. Examples: 5.10, 5.10.107, v5.10, 5.10.y, linux-5.10.y"
9898

9999
$(SHARED_DIR):
100100
mkdir -p $(SHARED_DIR)
@@ -115,9 +115,9 @@ endif
115115

116116
# If we're building ACK instead of Linux, set the appropriate variables
117117
ifeq ($(ACK),1)
118-
LINUX_SRC := $(ACK_SRC)
119-
LINUX_OUT := $(ACK_OUT)
120-
LINUX_DEFCONFIG := gki_defconfig
118+
LINUX_SRC ?= $(ACK_SRC)
119+
LINUX_OUT ?= $(ACK_OUT)
120+
LINUX_DEFCONFIG ?= gki_defconfig
121121
else
122122
LINUX_SRC ?= $(ROOT_DIR)/linux
123123
LINUX_OUT ?= $(OUT_DIR)/linux/$(ARCH)

0 commit comments

Comments
 (0)