| commit | f451586b26eadc8a7189e81e8f33e6d4fc045dc2 | [log] [tgz] |
|---|---|---|
| author | android-build-team Robot <android-build-team-robot@google.com> | Tue Dec 08 02:56:30 2020 +0000 |
| committer | Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com> | Tue Dec 08 02:56:30 2020 +0000 |
| tree | 78d04f8a5ef6a414b67dba731e2f4a6af9d0b4f0 | |
| parent | 304bf06a6111431cd2cfc7fde82a353e2267a9ca [diff] | |
| parent | 2e662079d2a2aeb6bc4d8487ce921bafbc8a136d [diff] |
Snap for 6948038 from 9a56affabd600098b1a15adecc5bd38ef2e6156c to rvc-platform-release am: 2e662079d2 Original change: https://googleplex-android-review.googlesource.com/c/platform/system/tools/xsdc/+/12979183 MUST ONLY BE SUBMITTED BY AUTOMERGER Change-Id: Ia7afdfd97b97424a0c7fa0f465b9bb02dc90ab04
The ConfigFile as API is a formal Treble interface describing schemas of configuration files used across system and vendor partitions. The Java APIs in the current.txt file are not Java APIs for apps. It's a proxy for the schema of a xml file used between the system and vendor partition. The xml files are only ever parsed by apps on the system partition.
Add the schema (attribute, element or new complexType …) you want to add to the xsd file.
<xs:element name="class"> <xs:complexType> <xs:sequence> <xs:element name="student" type="xs:string"/> </xs:sequence> <xs:attribute name="name" type=”xs:string”/> </xs:complexType> </xs:element>
<xs:element name="class"> <xs:complexType> <xs:sequence> <xs:element name="student" type="xs:string"/> </xs:sequence> <xs:attribute name="name" type=”xs:string”/> <xs:attribute name="number" type="xs:int"/> </xs:complexType> </xs:element>
Then run “make {xsd_config module_name} .docs-update-current-api” or “make update-api” to update all the xsd_config modules.
In the above example, two functions are added as below.
To remove a tag, add an annotation tag with the name of “Deprecated” into the tag to be deleted. Partners are not allowed to create new vendor images using deprecated tags
<xs:element name="class"> <xs:complexType> <xs:sequence> <xs:element name="student" type="xs:string"/> </xs:sequence> <xs:attribute name="name" type=”xs:string”/> </xs:complexType> </xs:element>
<xs:element name="class"> <xs:complexType> <xs:sequence> <xs:element name="student" type="xs:string"> <annotation name=”Deprecated”/> </xs:element> </xs:sequence> <xs:attribute name="name" type=”xs:string”/> </xs:complexType> </xs:element>
After adding “Deprecated” annotation, we need to update the api or schema just like when adding a tag. In the above example, a @Deprecate annotation is added.
If there are any changes, we update last_current.txt and last_removed.txt before release by copying current.txt and removed.txt to last_current.txt and last_removed.txt.
Only the follow tags and attributes are allowed:
"xsd:schema" [ ] "xsd:element" [ "xsd:name" { values: any valid java name } "xsd:type" { values: built-in data type, simpleType or complexType }, "xsd:ref" { values: another element }, "xsd:minOccurs" { values: [ 0, maxOccurs ] }, "xsd:maxOccurs" { values: [ 1, unbounded ] }, ] "xsd:attribute" [ "xsd:name" { values: any valid java name } "xsd:type" { values: built-in data type, simpleType or complexType }, "xsd:ref" { values: another element }, ] "xsd:complexType" [ "xsd:name" { values: any valid java name } ] "xsd:complexContent" [ ] "xsd:simpleContent" [ ] "xsd:restriction": [ "xsd:base" { values: built-in data type } ] "xsd:extension": [ "xsd:base" { values: built-in data type, simpleType or complexType } ] "xsd:simpleType": [ "xsd:name" { values: any valid java name } ] "xsd:list": [ "xsd:itemType" { values: built-in data type, or simpleType } ] "xsd:union": [ "xsd:memberTypes" { values: built-in data type, or simpleType } ] "xsd:sequence": [ ] "xsd:choice": [ ] "xsd:all": [ ] "xsd:enumeration": [ "xsd:value" { values: built-in data type } ]