Skip to content

Commit 1ab59b0

Browse files
tnorbyetnorbye
authored
Merge pull request #102 from googlesamples/updatedocs
Update issue documentation: include test resources
2 parents 99523ca + 65850ee commit 1ab59b0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

52 files changed

+815
-74
lines changed

Diff for: ‎docs/checks/Aligned16KB.md.html

+138
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
<meta charset="utf-8">
2+
(#) Native library dependency not 16 KB aligned
3+
4+
!!! WARNING: Native library dependency not 16 KB aligned
5+
This is a warning.
6+
7+
Id
8+
: `Aligned16KB`
9+
Summary
10+
: Native library dependency not 16 KB aligned
11+
Severity
12+
: Warning
13+
Category
14+
: Correctness
15+
Platform
16+
: Android
17+
Vendor
18+
: Android Open Source Project
19+
Feedback
20+
: https://issuetracker.google.com/issues/new?component=192708
21+
Affects
22+
: Gradle build files and TOML files
23+
Editing
24+
: This check can *not* run live in the IDE editor
25+
See
26+
: https://developer.android.com/guide/practices/page-sizes
27+
Implementation
28+
: [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/PageAlignmentDetector.kt)
29+
Tests
30+
: [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/PageAlignmentDetectorTest.kt)
31+
Copyright Year
32+
: 2025
33+
34+
Historically, Android has aligned memory using 4 KB memory page sizes,
35+
which optimized system memory performance for the average amount of
36+
total memory that Android devices have typically had.
37+
38+
To support devices that only support 16 KB aligned libraries in the
39+
future, the Google Play Store will soon require all apps to be compiled
40+
with 16 KB aligned libraries.
41+
42+
An app compiled with 4 KB aligned libraries will not work correctly on
43+
these devices. To ensure compatibility with these devices and to
44+
future-proof your app, the Play Store will require native libraries to
45+
be aligned to 16 KB boundaries.
46+
47+
If your app uses any NDK libraries, either directly or indirectly
48+
through an SDK, you'll need to rebuild your app to meet this new
49+
requirement. This means ensuring that all native libraries within your
50+
app, including those from any dependencies, are built with 16 KB page
51+
alignment.
52+
53+
This lint check helps identify potential issues by inspecting all
54+
transitive libraries your app depends on. If any nested native libraries
55+
are found to be aligned only to 4 KB, you'll need to take action.
56+
57+
If lint flags a library, try updating to a newer version that supports
58+
16 KB alignment. If no updated version is available, reach out to the
59+
library vendor for assistance.
60+
61+
(##) Example
62+
63+
Here is an example of lint warnings produced by this check:
64+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
65+
build.gradle:2:Warning: The native library
66+
arm64-v8a/libtensorflowlite_jni.so (from
67+
org.tensorflow:tensorflow-lite:2.16.1) is not 16 KB aligned
68+
[Aligned16KB]
69+
implementation("org.tensorflow:tensorflow-lite:2.16.1")
70+
---------------------------------------
71+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
72+
73+
Here are the relevant test files:
74+
75+
`build.gradle`:
76+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~groovy linenumbers
77+
dependencies {
78+
implementation("org.tensorflow:tensorflow-lite:2.16.1")
79+
}
80+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
81+
82+
[build/intermediates/exploded-aar/org.tensorflow/tensorflow-lite/2.16.1/jni/arm64-v8a/libtensorflowlite_jni.so](examples/arm64-v8a/libtensorflowlite_jni.so)
83+
84+
[build/intermediates/exploded-aar/org.tensorflow/tensorflow-lite/2.16.1/jni/x86_64/libtensorflowlite_jni.so](examples/x86_64/libtensorflowlite_jni.so)
85+
86+
[build/intermediates/exploded-aar/org.tensorflow/tensorflow-lite/2.16.1/jni/armeabi-v7a/libtensorflowlite_jni.so](examples/armeabi-v7a/libtensorflowlite_jni.so)
87+
88+
[build/intermediates/exploded-aar/org.tensorflow/tensorflow-lite/2.16.1/jni/x86/libtensorflowlite_jni.so](examples/x86/libtensorflowlite_jni.so)
89+
90+
You can also visit the
91+
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/PageAlignmentDetectorTest.kt)
92+
for the unit tests for this check to see additional scenarios.
93+
94+
(##) Suppressing
95+
96+
You can suppress false positives using one of the following mechanisms:
97+
98+
* Using a suppression comment like this on the line above:
99+
100+
```kt
101+
//noinspection Aligned16KB
102+
problematicStatement()
103+
```
104+
105+
* Using a special `lint.xml` file in the source tree which turns off
106+
the check in that folder and any sub folder. A simple file might look
107+
like this:
108+
```xml
109+
&lt;?xml version="1.0" encoding="UTF-8"?&gt;
110+
&lt;lint&gt;
111+
&lt;issue id="Aligned16KB" severity="ignore" /&gt;
112+
&lt;/lint&gt;
113+
```
114+
Instead of `ignore` you can also change the severity here, for
115+
example from `error` to `warning`. You can find additional
116+
documentation on how to filter issues by path, regular expression and
117+
so on
118+
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).
119+
120+
* In Gradle projects, using the DSL syntax to configure lint. For
121+
example, you can use something like
122+
```gradle
123+
lintOptions {
124+
disable 'Aligned16KB'
125+
}
126+
```
127+
In Android projects this should be nested inside an `android { }`
128+
block.
129+
130+
* For manual invocations of `lint`, using the `--ignore` flag:
131+
```
132+
$ lint --ignore Aligned16KB ...`
133+
```
134+
135+
* Last, but not least, using baselines, as discussed
136+
[here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).
137+
138+
<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>

Diff for: ‎docs/checks/AppLinkSplitToWebAndCustom.md.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
Feedback
2020
: https://issuetracker.google.com/issues/new?component=192708
2121
Since
22-
: 8.8.0-alpha08 (October 2024)
22+
: 8.8.0 (January 2025)
2323
Affects
2424
: Manifest files
2525
Editing

Diff for: ‎docs/checks/AppLinkWarning.md.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
Feedback
2020
: https://issuetracker.google.com/issues/new?component=192708
2121
Since
22-
: 8.8.0-alpha06 (October 2024)
22+
: 8.8.0 (January 2025)
2323
Affects
2424
: Manifest files
2525
Editing

Diff for: ‎docs/checks/ArcAnimationSpecTypeIssue.md.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
(#) ArcAnimationSpec is designed for 2D values. Particularly, for positional values such as Offset.
33

44
!!! Tip: ArcAnimationSpec is designed for 2D values. Particularly, for positional values such as Offset.
5-
Advice from this check is just a tip.
5+
Advice from this check is just a hint; it's "weak" warning.
66

77
Id
88
: `ArcAnimationSpecTypeIssue`
99
Summary
1010
: ArcAnimationSpec is designed for 2D values. Particularly, for positional values such as Offset.
1111
Severity
12-
: Information
12+
: Hint
1313
Category
1414
: Correctness
1515
Platform

Diff for: ‎docs/checks/AutoboxingStateCreation.md.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
(#) `State<T>` will autobox values assigned to this state. Use a specialized state type instead.
33

44
!!! Tip: `State<T>` will autobox values assigned to this state. Use a specialized state type instead.
5-
Advice from this check is just a tip.
5+
Advice from this check is just a hint; it's "weak" warning.
66

77
Id
88
: `AutoboxingStateCreation`
99
Summary
1010
: `State<T>` will autobox values assigned to this state. Use a specialized state type instead.
1111
Severity
12-
: Information
12+
: Hint
1313
Category
1414
: Performance
1515
Platform

Diff for: ‎docs/checks/CredentialManagerMisuse.md.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
Feedback
2020
: https://issuetracker.google.com/issues/new?component=192708
2121
Since
22-
: 8.8.0-alpha02 (September 2024)
22+
: 8.8.0 (January 2025)
2323
Affects
2424
: Kotlin and Java files
2525
Editing

Diff for: ‎docs/checks/FieldSiteTargetOnQualifierAnnotation.md.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -185,17 +185,17 @@
185185

186186
```
187187
// build.gradle.kts
188-
implementation("com.google.dagger:dagger-lint:2.54")
188+
implementation("com.google.dagger:dagger-lint:2.55")
189189

190190
// build.gradle
191-
implementation 'com.google.dagger:dagger-lint:2.54'
191+
implementation 'com.google.dagger:dagger-lint:2.55'
192192

193193
// build.gradle.kts with version catalogs:
194194
implementation(libs.dagger.lint)
195195

196196
# libs.versions.toml
197197
[versions]
198-
dagger-lint = "2.54"
198+
dagger-lint = "2.55"
199199
[libraries]
200200
# For clarity and text wrapping purposes the following declaration is
201201
# shown split up across lines, but in TOML it needs to be on a single
@@ -207,7 +207,7 @@
207207
}
208208
```
209209

210-
2.54 is the version this documentation was generated from;
210+
2.55 is the version this documentation was generated from;
211211
there may be newer versions available.
212212

213213
[Additional details about com.google.dagger:dagger-lint](com_google_dagger_dagger-lint.md.html).

Diff for: ‎docs/checks/IconDipSize.md.html

+28
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,34 @@
3636
catches errors where images are either placed in the wrong folder, or
3737
icons are changed to new sizes but some folders are forgotten.
3838

39+
(##) Example
40+
41+
Here is an example of lint warnings produced by this check:
42+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
43+
res/drawable-mdpi/my_lossy_72dp.webp:Warning: Suspicious file name
44+
my_lossy_72dp.webp: The implied 72 dp size does not match the actual dp
45+
size (pixel size 58×56 in a drawable-mdpi folder computes to 58×56 dp)
46+
[IconDipSize]
47+
0 errors, 3 warnings
48+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
49+
50+
Here are the relevant test files:
51+
52+
![res/drawable-mdpi/my_lossy_72dp.webp](examples/drawable-mdpi/my_lossy_72dp.webp)
53+
54+
![res/mipmap-mdpi/my_lossy2_72dp.webp](examples/mipmap-mdpi/my_lossy2_72dp.webp)
55+
56+
![res/drawable-mdpi/my_lossless_72dp.webp](examples/drawable-mdpi/my_lossless_72dp.webp)
57+
58+
You can also visit the
59+
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/IconDetectorTest.java)
60+
for the unit tests for this check to see additional scenarios.
61+
62+
The above example was automatically extracted from the first unit test
63+
found for this lint check, `IconDetector.testClaimedSizeWebp`.
64+
To report a problem with this extracted sample, visit
65+
https://issuetracker.google.com/issues/new?component=192708.
66+
3967
(##) Suppressing
4068

4169
You can suppress false positives using one of the following mechanisms:

Diff for: ‎docs/checks/IconExtension.md.html

+24
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,30 @@
3535
is really in the PNG format and not for example a GIF file named
3636
`.png`).
3737

38+
(##) Example
39+
40+
Here is an example of lint warnings produced by this check:
41+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
42+
res/drawable-mdpi/foo.png:Warning: Misleading file extension; named .png
43+
but the file format is webp [IconExtension]
44+
0 errors, 1 warnings
45+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46+
47+
Here are the relevant test files:
48+
49+
![res/drawable-mdpi/foo.png](examples/drawable-mdpi/foo.png)
50+
51+
![res/drawable-mdpi/ok.webp](examples/drawable-mdpi/ok.webp)
52+
53+
You can also visit the
54+
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/IconDetectorTest.java)
55+
for the unit tests for this check to see additional scenarios.
56+
57+
The above example was automatically extracted from the first unit test
58+
found for this lint check, `IconDetector.testMisleadingWebpFileName`.
59+
To report a problem with this extracted sample, visit
60+
https://issuetracker.google.com/issues/new?component=192708.
61+
3862
(##) Suppressing
3963

4064
You can suppress false positives using one of the following mechanisms:

Diff for: ‎docs/checks/InvalidPackage.md.html

+2-5
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@
5858
2 errors, 0 warnings
5959
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6060

61-
Here are the relevant source files:
61+
Here are the relevant test files:
6262

6363
`res/layout/layout.xml`:
6464
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
@@ -136,10 +136,7 @@
136136
&lt;/resources&gt;
137137
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
138138

139-
`libs/unsupported.jar`:
140-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text linenumbers
141-
H4sIAAAAAAAAAAvwZmYRYeAAwmMzkxwZkAAnAwuDr2uIo66nn5v+v1MMDMwMAd7sHCApJqiSAJyaRYAYrtnX0c/TzTU4RM/X7bPvmdM+3rp6F3m9dbXOnTm/OcjgivGDp0V6Xr46nr4XS1excM54KXlEerZ2hoWYyJMlWhXPVF9nfir6WMQItt1tYdofG6DZNlDbucC27UWznRWIS1KLS/RxK+GEKSnITtdH+GM6mjJpZGU+mUlFiUWVzjmJxcV6ySAyNyjaX9hR5N+y7bnXs/QDHC5yPVq69ITD0exefpMZGWEmKzOfFG67O+Xg3chNc7n+Kv/jr93Q6fuH8Z/G45u5jpk32i2Nn8/5qZf+7fv8+fsZrgSaCyRrZC5f//Pjc7ntS2Q7Em6UuO7PVzg4wV4onqW89dXH798mXr7Is3J6kOffLsW4ldskhXz3v57RoTzZVUizbY7q1M32H3LUf2jkXE/UiKpz35EreOKDja/al4VvjHWipk8ylzC6d2FuCs8TyWdOqsv31Ct5nr59t/HaPqOJzmrNllN4zsQL3Jb6tvVx6sYGV6FX/B7lJ7tOXXouz7SyxJu974OU2rrkmwd6NQ/6WHbP3nE0QaZdM1zQ4+isuR6Lb5kV/H6zz+LiHs2mdaptR7IW9fQ0WvN8Drwq/GvC+1P3pJfOnSe8pHD6wTvr7G9V/nnycvPzaLWwQnuZx82SakHO26Qf7gkuS/l75vwZl4y8Yyufv1vZeHyD2dsFLNuXvipaOGV967R9j+ar+V6ZX6S88jnzrhcNUo+2vTHUiZhuuWDTzU/sjscrdQ+H6/753zH7Ie8mFwGO/RJvX4gvvLpAePkJDbXr7h713afU1q7UmHlMNGrzZLaucE2jGOv9f6YqTBYxP3ZCtqfjm3XXVvmIpPcZmx1nG56aEn9TPvnrgh1mh/aKd9bLPOU43BNR1BKn8EfVKX5hMO/Pjur0Jvuny6Y7sYYm6SdIvr4iuvidzlX5SZOknpqfDGh6FHZk019xUFL9+WuOhgQwpyQzg5IqI5MIA2pWYYKnRBYGVICS69C1IucAERRttjjyHMgELgbcOQUBdiPyDW4tnCha7qHmI4RbQTkJOQikUbSxMuLNVwHerGwQ57EyGACVpjGDeADV4J9drAQAAA==
142-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
139+
[libs/unsupported.jar](examples/libs/unsupported.jar)
143140

144141
You can also visit the
145142
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/InvalidPackageDetectorTest.java)

Diff for: ‎docs/checks/JvmStaticProvidesInObjectDetector.md.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -194,17 +194,17 @@
194194

195195
```
196196
// build.gradle.kts
197-
implementation("com.google.dagger:dagger-lint:2.54")
197+
implementation("com.google.dagger:dagger-lint:2.55")
198198

199199
// build.gradle
200-
implementation 'com.google.dagger:dagger-lint:2.54'
200+
implementation 'com.google.dagger:dagger-lint:2.55'
201201

202202
// build.gradle.kts with version catalogs:
203203
implementation(libs.dagger.lint)
204204

205205
# libs.versions.toml
206206
[versions]
207-
dagger-lint = "2.54"
207+
dagger-lint = "2.55"
208208
[libraries]
209209
# For clarity and text wrapping purposes the following declaration is
210210
# shown split up across lines, but in TOML it needs to be on a single
@@ -216,7 +216,7 @@
216216
}
217217
```
218218

219-
2.54 is the version this documentation was generated from;
219+
2.55 is the version this documentation was generated from;
220220
there may be newer versions available.
221221

222222
[Additional details about com.google.dagger:dagger-lint](com_google_dagger_dagger-lint.md.html).

Diff for: ‎docs/checks/KtxExtensionAvailable.md.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
(#) KTX Extension Available
33

44
!!! Tip: KTX Extension Available
5-
Advice from this check is just a tip.
5+
Advice from this check is just a hint; it's "weak" warning.
66

77
Id
88
: `KtxExtensionAvailable`
99
Summary
1010
: KTX Extension Available
1111
Severity
12-
: Information
12+
: Hint
1313
Category
1414
: Productivity
1515
Platform
@@ -46,8 +46,8 @@
4646

4747
Here is an example of lint warnings produced by this check:
4848
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
49-
build.gradle:7:Information: Add suffix -ktx to enable the Kotlin
50-
extensions for this library [KtxExtensionAvailable]
49+
build.gradle:7:Hint: Add suffix -ktx to enable the Kotlin extensions for
50+
this library [KtxExtensionAvailable]
5151
implementation "androidx.core:core:1.2.0"
5252
--------------------------
5353
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Diff for: ‎docs/checks/MangledCRLF.md.html

+1-4
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,7 @@
5555

5656
Here is the source file referenced above:
5757

58-
`res/layout/crcrlf.xml`:
59-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~xml linenumbers
60-
H4sIAAAAAAAA/42Ry2rDMBBF9wb/g9EHWHtjB7LLItmEkK0Z5KEaKktGGtdxvz7yA5qE1o12uvdc5lWe0QDTFx5hdD1nt9bYUIBtvKOmEpq5K6QMSmMLIV/1XLlWQvcpPQa5aiJNsviWPDtnwmZ6JtbMqhdmbqEeqGFdiRZY6boDj5Z/BzXSh+YXMtulSbrg5QVvfCUclu/fpQYPXa2c5Z9SG+Xeo1V00R+cp++IgqkE+x7/46/omdQGzXGkShzQGPfgztss5p4mOz8B2b2KZyUeRSanlSSlfD51FO+BbabY/QEAAA==
61-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58+
[res/layout/crcrlf.xml](examples/layout/crcrlf.xml)
6259

6360
You can also visit the
6461
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/DosLineEndingDetectorTest.kt)

0 commit comments

Comments
 (0)