Merge branch 'main' into next-release before starting 1.24.0 document…

…ation
canonical · Oct 29, 2024 · 61c5445 · 61c5445
2 parents ae8691d + c6dc9e6
commit 61c5445
Show file tree

Hide file tree

Showing 12 changed files with 396 additions and 370 deletions.
diff --git a/.custom_wordlist.txt b/.custom_wordlist.txt
@@ -1,21 +1,20 @@
-AAM
-AAOS
+aam
+aaos
 AAPT
-AAR
+aar
 AArch
 ABI
 ABIs
 ACLs
-ADB
+adb
 addon
 addons
 allocator
 Altra
-AMC
+amc
 amd
 AMI
-AMS
-Anbox
+ams
 anbox
 anonymization
 ANR
@@ -130,12 +129,13 @@ HIDL
 HMAC
 Honkai
 hotfix
-HTTPS
+https
 HW
 HWE
 HVAC
 IAM
 idmapped
+io
 IDR
 IME
 impactful
@@ -326,7 +326,7 @@ VNC
 VNDK
 VPC
 VPN
-VPU
+vpu
 VPUs
 vsync
 Vulkan

diff --git a/.github/workflows/generate-command-reference.yml b/.github/workflows/generate-command-reference.yml
@@ -18,11 +18,11 @@ jobs:
       run: |
         echo "value=$(cat .base_version)" >> "$GITHUB_OUTPUT"
     - name: Set up Anbox Cloud
-      uses: canonical/anbox-cloud-github-action@39490d442cc0921fe614f7044b9f3dc8bd89725c
+      uses: canonical/anbox-cloud-github-action@1313af204abc19f4ba5f655d3d0717eba2516c6f
       with:
         channel: ${{ steps.base_version.outputs.value }}/stable
     - name: Checkout repo
-      uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
       # Remove existing files, generate AMC command reference
     - name: Generate AMC command reference documentation
       run: |

diff --git a/.github/workflows/update-api-specs.yaml b/.github/workflows/update-api-specs.yaml
@@ -10,13 +10,13 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
     - name: Check out repository
-      uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
+      uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
     - name: Determine base version
       id: base_version
       run: |
         echo "value=$(cat .base_version)" >> "$GITHUB_OUTPUT"
     - name: Set up Anbox Cloud
-      uses: canonical/anbox-cloud-github-action@39490d442cc0921fe614f7044b9f3dc8bd89725c
+      uses: canonical/anbox-cloud-github-action@1313af204abc19f4ba5f655d3d0717eba2516c6f
       with:
         channel: ${{ steps.base_version.outputs.value }}/stable
     - name: Determine appliance version

diff --git a/custom_conf.py b/custom_conf.py
@@ -224,13 +224,18 @@
 # Inject AMS configuration valuues and Node configuration values from the swagger
 # specification hosted on Github.
 def generate_ams_configuration():
-    from scripts.ams_configuration import get_swagger_from_url, parse_swagger
+    from scripts.ams_configuration import parse_swagger
 
     with open("scripts/requirements.txt", "r") as f:
         for req in f.readlines():
             custom_required_modules.append(req)
     ams_configuration_file = "reference/ams-configuration.md"
-    parse_swagger(get_swagger_from_url(), ams_configuration_file)
+    import yaml
+
+    with open("reference/api-reference/ams-api.yaml", "r") as f:
+        swagger = yaml.safe_load(f)
+    parse_swagger(swagger, ams_configuration_file)
+
 
 ## The following code is to automatically load the API from swagger into documentation.
 

diff --git a/reference/anbox-features.md b/reference/anbox-features.md
@@ -10,6 +10,9 @@ The following table lists some Anbox features and whether they are supported for
 | boot-package and boot-activity in {ref}`ref-application-manifest` | ✓    |   -   |
 | {ref}`howto-install-apk-system-app`             | ✓    |   -   |
 | [Custom Android ID](#custom-android-id)                    | ✓    |   -   |
+| [System UI](#system-ui)                    | ✓    |   -   |
+| [Virtual Keyboard](#virtual-keyboard)                    | ✓    |   -   |
+| [Client-Side Virtual Keyboard](#client-side-virtual-keyboard)                    | ✓    |   -   |
 | {ref}`VHAL HTTP API <sec-anbox-https-api-vhal>`                                   | -    |   ✓   |
 | [VhalConnector](https://canonical.github.io/anbox-cloud.github.com/latest/anbox-platform-sdk/classanbox_1_1VhalConnector.html) in Platform SDK API                                                    | -    |   ✓   |
 | {ref}`exp-custom-images`     | -    |   ✓   | 
@@ -33,23 +36,27 @@ To configure a feature for one application in the manifest, use a syntax similar
 
 ### System UI
 
-*since 1.10.2*
+*since 1.10.2, supported on AOSP images only*
 
 By default, Anbox hides the Android system UI when an application is running in foreground mode. In some use cases, however, it's required to have the system UI available for navigation purposes. This can be enabled with the `enable_system_ui` feature flag.
 
 The feature flag will be considered by all new launched instances once set.
 
+On AAOS, the Android Car system UI is always enabled and cannot be disabled.
+
 ### Virtual Keyboard
 
-*since 1.9.0*
+*since 1.9.0, supported on AOSP images only*
 
 The Android virtual keyboard is disabled by default but can be enabled with the `enable_virtual_keyboard` feature flag.
 
 For the feature to be considered, applications must be manually updated, because changes to allow the feature to work are only applied during the application {ref}`bootstrap process <sec-application-bootstrap>`.
 
+On AAOS, the Android virtual keyboard is always enabled and cannot be disabled.
+
 ### Client-Side Virtual Keyboard
 
-*since 1.11.0*
+*since 1.11.0, supported on AOSP images only*
 
 The client-side virtual keyboard is disabled by default but can be enabled with the `enable_anbox_ime` feature flag. It requires the client application to embed {ref}`Anbox WebView <sec-application-bootstrap>` which interacts with the client-side virtual keyboard for text editing and sends the text to the Android container.