From 0ae41f2e79ceaa1416f73a1006c7e8e98b1105b4 Mon Sep 17 00:00:00 2001 From: Dan Willemsen Date: Sat, 14 Jul 2018 09:32:13 -0700 Subject: [PATCH] Remove showcommands from docs Test: none Change-Id: Ia0be98049710175a0f3276841ef0c0bd2ccb60b6 --- Usage.txt | 17 +++++++++++++---- core/build-system.html | 19 ------------------- 2 files changed, 13 insertions(+), 23 deletions(-) diff --git a/Usage.txt b/Usage.txt index 004210b47..558329bda 100644 --- a/Usage.txt +++ b/Usage.txt @@ -29,7 +29,7 @@ Ways to specify what to build: An alternative to setting $TARGET_PRODUCT and $TARGET_BUILD_VARIANT, which you may see in build servers, is to execute: - make PRODUCT-- + m PRODUCT-- A target may be a file path. For example, out/host/linux-x86/bin/adb . @@ -46,6 +46,17 @@ Ways to specify what to build: files named Android.bp these files are defined in Blueprint syntax + During a build, a few log files are generated in ${OUT} (or ${DIST_DIR}/logs + for dist builds): + + verbose.log.gz + every command run, along with its outputs. This is similar to the + previous `m showcommands` option. + error.log + list of actions that failed during the build, and their outputs. + soong.log + verbose debug information from soong_ui + For now, the full (extremely large) compiled list of targets can be found (after running the build once), split among these two files: @@ -57,8 +68,6 @@ Ways to specify what to build: tool here. Targets that adjust an existing build: - showcommands Display the individual commands run to implement - the build dist Copy into ${DIST_DIR} the portion of the build that must be distributed @@ -71,7 +80,7 @@ Variables Variables can either be set in the surrounding shell environment or can be passed as command-line arguments. For example: export I_AM_A_SHELL_VAR=1 - I_AM_ANOTHER_SHELL_VAR=2 make droid I_AM_A_MAKE_VAR=3 + I_AM_ANOTHER_SHELL_VAR=2 m droid I_AM_A_MAKE_VAR=3 Here are some common variables and their meanings: TARGET_PRODUCT The to build # as described above TARGET_BUILD_VARIANT The to build # as described above diff --git a/core/build-system.html b/core/build-system.html index 3d86e24a9..3a11a477d 100644 --- a/core/build-system.html +++ b/core/build-system.html @@ -147,12 +147,6 @@ figure out exactly how this will work.

.c, .cpp, .h, .java, java libraries, etc., should all work without intervention in the Android.mk file.

-

Hiding command lines

-

The default of the build system will be to hide the command lines being -executed for make steps. It will be possible to override this by specifying -the showcommands pseudo-target, and possibly by setting an environment -variable.

-

Wildcard source files

Wildcarding source file will be discouraged. It may be useful in some scenarios. The default $(wildcard *) will not work due to the @@ -326,19 +320,6 @@ and intermediate files for all configurations. This is the same as directory inside the current combo directory. This is especially useful on the simulator and emulator, where the persistent data remains present between builds. -

  • showcommands - showcommands is a modifier target -which causes the build system to show the actual command lines for the build -steps, instead of the brief descriptions. Most people don't like seeing the -actual commands, because they're quite long and hard to read, but if you need -to for debugging purposes, you can add showcommands to the list -of targets you build. For example make showcommands will build -the default android configuration, and make runtime showcommands -will build just the runtime, and targets that it depends on, while displaying -the full command lines. Please note that there are a couple places where the -commands aren't shown here. These are considered bugs, and should be fixed, -but they're often hard to track down. Please let -android-build-team know if you find -any.
  • LOCAL_MODULE - Anything you specify as a LOCAL_MODULE in an Android.mk is made into a pseudotarget. For example, make runtime might be shorthand for make