summaryrefslogtreecommitdiff
path: root/static/build.html
diff options
context:
space:
mode:
Diffstat (limited to 'static/build.html')
-rw-r--r--static/build.html50
1 files changed, 25 insertions, 25 deletions
diff --git a/static/build.html b/static/build.html
index 44942767..3fbe60c6 100644
--- a/static/build.html
+++ b/static/build.html
@@ -354,9 +354,9 @@ repo sync -j16</pre>
tag for a device. For devices without official support, use the latest tag marked as
being appropriate for generic / other devices in the release notes.</p>
- <pre>mkdir grapheneos-TAG_NAME
-cd grapheneos-TAG_NAME
-repo init -u https://github.com/GrapheneOS/platform_manifest.git -b refs/tags/TAG_NAME</pre>
+ <pre>mkdir grapheneos-<var>TAG_NAME</var>
+cd grapheneos-<var>TAG_NAME</var>
+repo init -u https://github.com/GrapheneOS/platform_manifest.git -b refs/tags/<var>TAG_NAME</var></pre>
<p>Verify the manifest:</p>
@@ -489,13 +489,13 @@ source script/envsetup.sh
m aapt2</pre>
<p>Extract the vendor files corresponding to the matching release with
- <code>DEVICE</code> and <code>BUILD_ID</code> replaced with the
+ <code><var>DEVICE</var></code> and <code><var>BUILD_ID</var></code> replaced with the
appropriate values:</p>
-<pre>vendor/adevtool/bin/run download vendor/adevtool/dl/ -d DEVICE -b BUILD_ID -t factory ota
-sudo vendor/adevtool/bin/run generate-all vendor/adevtool/config/DEVICE.yml -c vendor/state/DEVICE.json -s vendor/adevtool/dl/DEVICE-BUILD_ID-*.zip
+<pre>vendor/adevtool/bin/run download vendor/adevtool/dl/ -d <var>DEVICE</var> -b <var>BUILD_ID</var> -t factory ota
+sudo vendor/adevtool/bin/run generate-all vendor/adevtool/config/<var>DEVICE</var>.yml -c vendor/state/<var>DEVICE</var>.json -s vendor/adevtool/dl/<var>DEVICE</var>-<var>BUILD_ID</var>-*.zip
sudo chown -R $(logname):$(logname) vendor/google_devices
-vendor/adevtool/bin/run ota-firmware vendor/adevtool/config/DEVICE.yml -f vendor/adevtool/dl/DEVICE-ota-BUILD_ID-*.zip</pre>
+vendor/adevtool/bin/run ota-firmware vendor/adevtool/config/<var>DEVICE</var>.yml -f vendor/adevtool/dl/<var>DEVICE</var>-ota-<var>BUILD_ID</var>-*.zip</pre>
</section>
<section id="setting-up-the-os-build-environment">
@@ -716,7 +716,7 @@ cd ../..</pre>
<pre>script/release.sh raven</pre>
<p>The factory images and update package will be in
- <code>out/release-raven-$BUILD_NUMBER</code>. The update zip performs a full OS
+ <code>out/release-raven-<var>BUILD_NUMBER</var></code>. The update zip performs a full OS
installation so it can be used to update from any previous version. More efficient
incremental updates are used for official over-the-air GrapheneOS updates and can be
generated by keeping around past signed <code>target_files</code> zips and generating
@@ -732,9 +732,9 @@ cd ../..</pre>
it (see the information on <code>OFFICIAL_BUILD</code> above), you can push signed
over-the-air updates via the update system. Simply upload the update package to the
update server along with the channel metadata for the release channel, and it will be
- pushed out to the update client. The <code>$DEVICE-beta</code> and
- <code>$DEVICE-stable</code> metadata provide the Beta and Stable release channels used
- by the update client. The <code>$DEVICE-testing</code> metadata provides
+ pushed out to the update client. The <code><var>DEVICE</var>-beta</code> and
+ <code><var>DEVICE</var>-stable</code> metadata provide the Beta and Stable release channels used
+ by the update client. The <code><var>DEVICE</var>-testing</code> metadata provides
an internal testing channel for the OS developers, which can be temporarily
enabled using <code>adb shell setprop sys.update.channel testing</code>. The name is
arbitrary and you can also use any other name for internal testing channels.</p>
@@ -804,7 +804,7 @@ cd ../..</pre>
<pre>git clone https://github.com/GrapheneOS/Vanadium.git
cd Vanadium
-git checkout $CORRECT_BRANCH_OR_TAG</pre>
+git checkout <var>CORRECT_BRANCH_OR_TAG</var></pre>
<p>Generate a signing key for Vanadium if this is the initial build:</p>
@@ -818,12 +818,12 @@ git checkout $CORRECT_BRANCH_OR_TAG</pre>
<pre>fetch --nohooks android</pre>
- <p>Sync to the latest stable release for Android (replace <code>$VERSION</code> with
+ <p>Sync to the latest stable release for Android (replace <code><var>VERSION</var></code> with
the correct value):</p>
<pre>cd src
git fetch --tags
-git checkout $VERSION</pre>
+git checkout <var>VERSION</var></pre>
<p>Apply the GrapheneOS patches on top of the tagged release:</p>
@@ -889,12 +889,12 @@ git checkout $VERSION</pre>
<code>packages/apps/Updater/res/values/config.xml</code>. See above for details on
including the Updater app in a release. These are the relevant files:</p>
- <pre>$DEVICE-ota_update-$BUILD_NUMBER.zip
-$DEVICE-factory-BUILD_NUMBER.zip
-$DEVICE-factory-BUILD_NUMBER.zip.sig
-$DEVICE-testing
-$DEVICE-beta
-$DEVICE-stable</pre>
+ <pre><var>DEVICE</var>-ota_update-<var>BUILD_NUMBER</var>.zip
+<var>DEVICE</var>-factory-<var>BUILD_NUMBER</var>.zip
+<var>DEVICE</var>-factory-<var>BUILD_NUMBER</var>.zip.sig
+<var>DEVICE</var>-testing
+<var>DEVICE</var>-beta
+<var>DEVICE</var>-stable</pre>
<p>Generally, you should start by uploading the ota_update, factory images and testing
channel metadata.</p>
@@ -904,9 +904,9 @@ $DEVICE-stable</pre>
arbitrary names. You can override the release channel configured in the update client
via ADB with the following command:</p>
- <pre>adb shell setprop sys.update.channel channel_name</pre>
+ <pre>adb shell setprop sys.update.channel <var>CHANNEL_NAME</var></pre>
- <p>Replace <code>channel_name</code> with the name of the release channel, such as
+ <p>Replace <code><var>CHANNEL_NAME</var></code> with the name of the release channel, such as
<code>testing</code>.</p>
<p>After pushing out and testing the new release via the internal release channel,
@@ -1136,9 +1136,9 @@ rm android-cts-media-1.5.zip</pre>
<p>To obtain a list of CTS modules:</p>
<pre>list modules</pre>
<p>To run a specific module and avoid wasting time capturing device information:</p>
- <pre>run cts --skip-device-info --module CtsModuleName</pre>
+ <pre>run cts --skip-device-info --module <var>CTS_MODULE_NAME</var></pre>
<p>To speed up initialization after running some initial tests:</p>
- <pre>run cts --skip-device-info --skip-preconditions --module CtsModuleName</pre>
+ <pre>run cts --skip-device-info --skip-preconditions --module <var>CTS_MODULE_NAME</var></pre>
<p>It's possible to run the whole standard CTS plan with a single command, but running
specific modules is recommended, especially if you don't have everything set up for
the entire test suite.</p>
@@ -1165,7 +1165,7 @@ rm android-cts-media-1.5.zip</pre>
the build number, which is generally incorporated into the build. For example, even
without a platform-tools tag, you can obtain the build number from <code>adb
version</code> or <code>fastboot version</code>. Their version output uses the format
- <code>$VERSION-$BUILD_NUMBER</code> such as <code>30.0.3-6597393</code> for the
+ <code><var>VERSION</var>-<var>BUILD_NUMBER</var></code> such as <code>30.0.3-6597393</code> for the
version <code>30.0.3</code> where the official release had the build number
<code>6597393</code>. You can obtain the manifest properties with the appropriate
repository revisions from ci.android.com with a URL like this: