xref: /aosp_15_r20/prebuilts/sdk/opt/README.txt (revision 344a7f5ef16c479e7a7f54ee6567a9d112f9e72b)
1*344a7f5eSAndroid Build Coastguard WorkerOptional Platform Prebuilt APIs
2*344a7f5eSAndroid Build Coastguard Worker
3*344a7f5eSAndroid Build Coastguard WorkerThese prebuilt APIs refer to those *not* included in the core platform
4*344a7f5eSAndroid Build Coastguard Worker(i.e. android.jar) but which may be present, for example, on specific
5*344a7f5eSAndroid Build Coastguard Workerdevices and/or form-factors (e.g. Wear specific APIs provided by the
6*344a7f5eSAndroid Build Coastguard Workerwear-sdk.jar).
7*344a7f5eSAndroid Build Coastguard Worker
8*344a7f5eSAndroid Build Coastguard WorkerThe convention used for optional platform prebuilt APIs located here is:
9*344a7f5eSAndroid Build Coastguard Worker
10*344a7f5eSAndroid Build Coastguard Worker<module>/<version>
11*344a7f5eSAndroid Build Coastguard Worker
12*344a7f5eSAndroid Build Coastguard WorkerWhere *module* represents the device or form-factor proving the API and
13*344a7f5eSAndroid Build Coastguard Worker*version* represents the release version qualifier associated with the
14*344a7f5eSAndroid Build Coastguard Workergiven APIs - for example:
15*344a7f5eSAndroid Build Coastguard Worker
16*344a7f5eSAndroid Build Coastguard Worker`prebuilts/sdk/opt/wear/33.4` - corresponds to the wear-sdk API provided via
17*344a7f5eSAndroid Build Coastguard Workerthe 4th Wear QPR released on top of the platform API level 33.
18*344a7f5eSAndroid Build Coastguard Worker
19*344a7f5eSAndroid Build Coastguard WorkerNote that all APIs added here should use the `prebuilt_apis` module so
20*344a7f5eSAndroid Build Coastguard Workeras to ensure that the prebuilt APIs conform to established standards w.r.t
21*344a7f5eSAndroid Build Coastguard Workercompatibility and change control. As such, it is expected that every module
22*344a7f5eSAndroid Build Coastguard Workerwill include a `module/Android.bp` file containing their `prebuilt_apis`
23*344a7f5eSAndroid Build Coastguard Workerdefinition. Corresponingly, the <version> directories should match the
24*344a7f5eSAndroid Build Coastguard Workerrespective defintions for `api_dirs` and the contents/structure of each
25*344a7f5eSAndroid Build Coastguard Workerversion dir should match the structure expected by the `prebuilt_api` module.
26*344a7f5eSAndroid Build Coastguard Worker
27*344a7f5eSAndroid Build Coastguard Workerhttps://source.android.com/docs/setup/build/java-library#maintaining-backward-compatibility
28