From 37253ffa17c63ea3fd0c201fa4e62ee36e5ce2ff Mon Sep 17 00:00:00 2001 From: smdyv <88971341+smdyv@users.noreply.github.com> Date: Thu, 25 Aug 2022 15:05:41 +0200 Subject: [PATCH] Add highlighting style for placeholders This is in accordance with Google's developer documentation style guide. --- static/build.html | 50 ++++++++++++++++++++--------------------- static/faq.html | 10 ++++----- static/install/cli.html | 14 ++++++------ static/main.css | 4 ++++ 4 files changed, 41 insertions(+), 37 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 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.

- 
mkdir grapheneos-TAG_NAME
-cd grapheneos-TAG_NAME
-repo init -u https://github.com/GrapheneOS/platform_manifest.git -b refs/tags/TAG_NAME
+ 
mkdir grapheneos-TAG_NAME
+cd grapheneos-TAG_NAME
+repo init -u https://github.com/GrapheneOS/platform_manifest.git -b refs/tags/TAG_NAME

Verify the manifest:

@@ -489,13 +489,13 @@ source script/envsetup.sh m aapt2

Extract the vendor files corresponding to the matching release with - DEVICE and BUILD_ID replaced with the + DEVICE and BUILD_ID replaced with the appropriate values:

-
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
+
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
 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

+vendor/adevtool/bin/run ota-firmware vendor/adevtool/config/DEVICE.yml -f vendor/adevtool/dl/DEVICE-ota-BUILD_ID-*.zip
@@ -716,7 +716,7 @@ cd ../.. 
script/release.sh raven

The factory images and update package will be in - out/release-raven-$BUILD_NUMBER. The update zip performs a full OS + out/release-raven-BUILD_NUMBER. 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 target_files zips and generating @@ -732,9 +732,9 @@ cd ../.. it (see the information on OFFICIAL_BUILD 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 $DEVICE-beta and - $DEVICE-stable metadata provide the Beta and Stable release channels used - by the update client. The $DEVICE-testing metadata provides + pushed out to the update client. The DEVICE-beta and + DEVICE-stable metadata provide the Beta and Stable release channels used + by the update client. The DEVICE-testing metadata provides an internal testing channel for the OS developers, which can be temporarily enabled using adb shell setprop sys.update.channel testing. The name is arbitrary and you can also use any other name for internal testing channels.

@@ -804,7 +804,7 @@ cd ../.. 
git clone https://github.com/GrapheneOS/Vanadium.git
 cd Vanadium
-git checkout $CORRECT_BRANCH_OR_TAG
+git checkout CORRECT_BRANCH_OR_TAG

Generate a signing key for Vanadium if this is the initial build:

@@ -818,12 +818,12 @@ git checkout $CORRECT_BRANCH_OR_TAG 
fetch --nohooks android
-

Sync to the latest stable release for Android (replace $VERSION with +

Sync to the latest stable release for Android (replace VERSION with the correct value):

cd src
 git fetch --tags
-git checkout $VERSION
+git checkout VERSION

Apply the GrapheneOS patches on top of the tagged release:

@@ -889,12 +889,12 @@ git checkout $VERSION packages/apps/Updater/res/values/config.xml. See above for details on including the Updater app in a release. These are the relevant files:

- 
$DEVICE-ota_update-$BUILD_NUMBER.zip
-$DEVICE-factory-BUILD_NUMBER.zip
-$DEVICE-factory-BUILD_NUMBER.zip.sig
-$DEVICE-testing
-$DEVICE-beta
-$DEVICE-stable
+ 
DEVICE-ota_update-BUILD_NUMBER.zip
+DEVICE-factory-BUILD_NUMBER.zip
+DEVICE-factory-BUILD_NUMBER.zip.sig
+DEVICE-testing
+DEVICE-beta
+DEVICE-stable

Generally, you should start by uploading the ota_update, factory images and testing channel metadata.

@@ -904,9 +904,9 @@ $DEVICE-stable arbitrary names. You can override the release channel configured in the update client via ADB with the following command:

- 
adb shell setprop sys.update.channel channel_name
+ 
adb shell setprop sys.update.channel CHANNEL_NAME
-

Replace channel_name with the name of the release channel, such as +

Replace CHANNEL_NAME with the name of the release channel, such as testing.

After pushing out and testing the new release via the internal release channel, @@ -1136,9 +1136,9 @@ rm android-cts-media-1.5.zip

To obtain a list of CTS modules:

list modules

To run a specific module and avoid wasting time capturing device information:

- 
run cts --skip-device-info --module CtsModuleName
+ 
run cts --skip-device-info --module CTS_MODULE_NAME

To speed up initialization after running some initial tests:

- 
run cts --skip-device-info --skip-preconditions --module CtsModuleName
+ 
run cts --skip-device-info --skip-preconditions --module CTS_MODULE_NAME

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.

@@ -1165,7 +1165,7 @@ rm android-cts-media-1.5.zip 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 adb version or fastboot version. Their version output uses the format - $VERSION-$BUILD_NUMBER such as 30.0.3-6597393 for the + VERSION-BUILD_NUMBER such as 30.0.3-6597393 for the version 30.0.3 where the official release had the build number 6597393. You can obtain the manifest properties with the appropriate repository revisions from ci.android.com with a URL like this: diff --git a/static/faq.html b/static/faq.html index 65e72191..e58ce351 100644 --- a/static/faq.html +++ b/static/faq.html @@ -643,7 +643,7 @@ enabled, and it has the option to automatically restore app data when an app is reinstalled, so it wouldn't lose track of it being the same profile.

-

The ANDROID_ID string is a 64-bit random number, unique to each +

The ANDROID_ID string is a 64-bit random number, unique to each combination of profile and app signing key. The 64-bit limitation means it isn't particularly useful due to the possibility of collisions. It's tied to the lifetime of profiles and does not persist through profile deletion or a factory reset. This is @@ -655,13 +655,13 @@

The advertising ID is a Google Play services feature not included in the baseline Android API, so it isn't an API included in GrapheneOS. The advertising ID is unique - to each profile. It isn't unique to each app signing key like ANDROID_ID, + to each profile. It isn't unique to each app signing key like ANDROID_ID, but that makes little difference since apps within the same profile can communicate - with each other with mutual consent. It's comparable to ANDROID_ID but + with each other with mutual consent. It's comparable to ANDROID_ID but provides an 128-bit value so it provides a strong cryptographic guarantee against collisions, although a device messing with apps could set it to the same value used in another profile. The advertising ID is exposed via the Settings app and can be reset - to a new random value, unlike ANDROID_ID which remains the same for the + to a new random value, unlike ANDROID_ID which remains the same for the lifetime of the profile, but apps can tie it to the previous ID since they can detect that it changed via their own ID in their app data. The advertising ID can also now be disabled (zeroed).

@@ -673,7 +673,7 @@ track of the profile. Apps previously had little reason to do things like this because they were able to persist data through an uninstall and reinstallation by default. The modern storage model means they need to request access to user data to do this. The - existence of ANDROID_ID means they don't yet need to bother with that but + existence of ANDROID_ID means they don't yet need to bother with that but that will change on GrapheneOS and will likely change for baseline Android too. However, profiles are the only way to provide a strong assurance of separate identities since the application model of the OS is designed to support communication diff --git a/static/install/cli.html b/static/install/cli.html index 6f985175..8473d057 100644 --- a/static/install/cli.html +++ b/static/install/cli.html @@ -410,16 +410,16 @@ RWQZW9NItOuQYJ86EooQBxScfclrWiieJtAO9GpnfEjKbCO/3FriLGX3

Download the factory images for the device from the releases page. For example, to download the 2021110122 release for a device with the - codename DEVICE_NAME:

+ codename DEVICE_NAME:

- 
curl -O https://releases.grapheneos.org/DEVICE_NAME-factory-2021110122.zip
-curl -O https://releases.grapheneos.org/DEVICE_NAME-factory-2021110122.zip.sig
+ 
curl -O https://releases.grapheneos.org/DEVICE_NAME-factory-2021110122.zip
+curl -O https://releases.grapheneos.org/DEVICE_NAME-factory-2021110122.zip.sig

Verify the factory images using the signature if you were able to obtain signify from trusted package repositories (see above), otherwise continue on to the next section without this:

- 
signify -Cqp factory.pub -x DEVICE_NAME-factory-2021110122.zip.sig && echo verified
+ 
signify -Cqp factory.pub -x DEVICE_NAME-factory-2021110122.zip.sig && echo verified

This will output verified if verification is successful. If something goes wrong, it will output an error message rather than verified.

@@ -435,15 +435,15 @@ curl -O https://releases.grapheneos.org/DEVICE_NAME-factory-2021110122.zip.sigOn Linux:

- 
bsdtar xvf DEVICE_NAME-factory-2021110122.zip
+ 
bsdtar xvf DEVICE_NAME-factory-2021110122.zip

On macOS and Windows:

- 
tar xvf DEVICE_NAME-factory-2021110122.zip
+ 
tar xvf DEVICE_NAME-factory-2021110122.zip

Move into the directory:

- 
cd DEVICE_NAME-factory-2021110122
+ 
cd DEVICE_NAME-factory-2021110122

Flash the images with the flash-all script in the directory.

diff --git a/static/main.css b/static/main.css index 16659888..9ae7df0f 100644 --- a/static/main.css +++ b/static/main.css @@ -52,6 +52,10 @@ code { border-radius: 2.5px; } +var { + color: #ba1a1a; +} + #site-menu ul { display: flex; flex-wrap: nowrap;