commit | e368cecf09f3fe5cb8579923c99b652e6e93cc0a | [log] [tgz] |
---|---|---|
author | Leland Richardson <lelandr@google.com> | Fri Jun 04 15:45:31 2021 -0700 |
committer | Leland Richardson <lelandr@google.com> | Tue Jun 08 22:58:17 2021 -0700 |
tree | fb14d0b5768fecf539df650cea1c43c0ceebb3ec | |
parent | 8d45608c16e8cb5b0d43bc4dbd77aa5e74674850 [diff] |
Introduce profile rules to compose modules Relnote:""" Adds profile rules to the following compose modules: androidx.compose.animation androidx.compose.animation-core androidx.compose.foundation androidx.compose.foundation-layout androidx.compose.material androidx.compose.material-ripple androidx.compose.runtime androidx.compose.ui androidx.compose.ui.geometry androidx.compose.ui.graphics androidx.compose.ui.text androidx.compose.ui.text androidx.compose.ui.unit androidx.compose.ui.util What are profile rules? === Profile rules for a library are specified in a text file `baseline-prof.txt` located in the `src/main` or equivalent directory. The file specifies a rule per line, where a rule in this case is a pattern for matching to methods or classes in the library. The syntax for these rules is a superset of the human-readable ART profile format that is used when using `adb shell profman --dump-classes-and-methods ...`. These rules take one of two forms to target either methods or classes. A method rule will have the following pattern: ``` <FLAGS><CLASS_DESCRIPTOR>-><METHOD_SIGNATURE> ``` And a class rule will have the following pattern: ``` <CLASS_DESCRIPTOR> ``` Here `<FLAGS>` is one or more of the characters `H`, `S`, and `P` to indicate whether or not this method should be flagged as “Hot”, “Startup”, or “Post Startup”. The `<CLASS_DESCRIPTOR>` is the descriptor for the class that the targeted method belongs to. For example, the class `androidx.compose.runtime.SlotTable` would have a descriptor of `Landroidx/compose/runtime/SlotTable;`. The `<METHOD_SIGNATURE>` is the signature of the method, and includes the name, parameter types, and return types of the method. For example, the method `fun isPlaced(): Boolean` on `LayoutNode` has the signature `isValid()Z`. These patterns can have wildcards (`**`, `*`, and `?`) in order to have a single rule encompass multiple methods or classes. What do the rules do? === A method that has the flag `H` indicates that this method is a "hot" method, and should be compiled ahead of time. A method that has the flag `S` indicates that it is a method which is called at startup, and should be compiled ahead of time to avoid the cost of compilation and interpreting the method at startup time. A method that has the flag `P` indicates that it is a method which is called after startup. A class that is present in this file indicates that it is used during startup and should be pre-allocated in the heap to avoid the cost of class loading. How does this work? === Libraries can define these rules which will be packaged in AAR artifacts. When an APK is then built which includes these artifacts, these rules are merged together and the merged rules are used to build a compact binary ART profile that is specific to the APK. ART can then leverage this profile when the APK is installed on devices in order to ahead-of-time compile a specific subset of the application to improve the performance of the application, especially the first run. Note that this will have no effect on debuggable applications. """ Change-Id: I14ed64578d535320a40ed8d486f75715641b2762
Jetpack is a suite of libraries, tools, and guidance to help developers write high-quality apps easier. These components help you follow best practices, free you from writing boilerplate code, and simplify complex tasks, so you can focus on the code you care about.
Jetpack comprises the androidx.*
package libraries, unbundled from the platform APIs. This means that it offers backward compatibility and is updated more frequently than the Android platform, making sure you always have access to the latest and greatest versions of the Jetpack components.
Our official AARs and JARs binaries are distributed through Google Maven.
You can learn more about using it from Android Jetpack landing page.
For contributions via GitHub, see the GitHub Contribution Guide.
Note: The contributions workflow via GitHub is currently experimental - only contributions to the following projects are being accepted at this time:
When contributing to Jetpack, follow the code review etiquette.
We are not currently accepting new modules.
NOTE: You will need to use Linux or Mac OS. Building under Windows is not currently supported.
repo
(Repo is a tool that makes it easier to work with Git in the context of Android. For more information about Repo, see the Repo Command Reference)mkdir ~/bin PATH=~/bin:$PATH curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo chmod a+x ~/bin/repo
git config --global user.name "Your Name" git config --global user.email "you@example.com"
mkdir androidx-main cd androidx-main
repo
command to initialize the repository.repo init -u https://android.googlesource.com/platform/manifest -b androidx-main --partial-clone --clone-filter=blob:limit=10M
repo sync -j8 -c
You will use this command to sync your checkout in the future - it’s similar to git fetch
To open the project with the specific version of Android Studio recommended for developing:
cd path/to/checkout/frameworks/support/ ANDROIDX_PROJECTS=MAIN ./gradlew studio
and accept the license agreement when prompted. Now you're ready to edit, run, and test!
You can also the following sets of projects: ALL
, MAIN
, COMPOSE
, or FLAN
If you get “Unregistered VCS root detected” click “Add root” to enable git integration for Android Studio.
If you see any warnings (red underlines) run Build > Clean Project
.
You can do most of your work from Android Studio, however you can also build the full AndroidX library from command line:
cd path/to/checkout/frameworks/support/ ./gradlew createArchive
You can build maven artifacts locally, and test them directly in your app:
./gradlew createArchive
And put the following at the top of your ‘repositories’ property in your project build.gradle
file:
maven { url '/path/to/checkout/out/androidx/build/support_repo/' }
Our continuous integration system builds all in progress (and potentially unstable) libraries as new changes are merged. You can manually download these AARs and JARs for your experimentation.
Run FooBarTest
Run androidx.foobar
The AndroidX repository has a set of Android applications that exercise AndroidX code. These applications can be useful when you want to debug a real running application, or reproduce a problem interactively, before writing test code.
These applications are named either <libraryname>-integration-tests-testapp
, or support-\*-demos
(e.g. support-v4-demos
or support-leanback-demos
). You can run them by clicking Run > Run ...
and choosing the desired application.
Before uploading your first contribution, you will need setup a password and agree to the contribution agreement:
Generate a HTTPS password: https://android-review.googlesource.com/new-password
Agree to the Google Contributor Licenses Agreement: https://android-review.googlesource.com/settings/new-agreement
cd path/to/checkout/frameworks/support/ repo start my_branch_name . # make needed modifications... git commit -a repo upload --current-branch .
If you see the following prompt, choose always
:
Run hook scripts from https://android.googlesource.com/platform/manifest (yes/always/NO)?
If the upload succeeds, you'll see output like:
remote: remote: New Changes: remote: https://android-review.googlesource.com/c/platform/frameworks/support/+/720062 Further README updates remote:
To edit your change, use git commit --amend
, and re-upload.
AndroidX uses git to store all the binary Gradle dependencies. They are stored in prebuilts/androidx/internal
and prebuilts/androidx/external
directories in your checkout. All the dependencies in these directories are also available from google()
, jcenter()
, or mavenCentral()
. We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.