Skip to content

Commit c0f092d

Browse files
authored
docs: Sync README and messages.xml (aws#7)
1 parent 223a26f commit c0f092d

File tree

2 files changed

+8
-11
lines changed

2 files changed

+8
-11
lines changed

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,7 @@ when it uses SnapStart. Lambda functions that use SnapStart are snapshotted at
7575
environments created afterwards share the same initial state. This means that if the Lambda function relies on state that
7676
is not resilient to snapshot and restore operations, it might manifest an unexpected behavior by using SnapStart.
7777

78-
Note that there are countless ways of initializing a Lambda function handler such that it’s not compatible
79-
with SnapStart. This tool helps provide an insight on possible cases where your code may not be fully compatible with
78+
This tool helps provide an insight on possible cases where your code may not be fully compatible with
8079
snapstart enabled. Please verify that your code maintains uniqueness with SnapStart. For best practices, follow the
8180
guidelines outlined in the SnapStart [documentation](https://github.com/aws/aws-lambda-snapstart-java-rules/wiki).
8281

src/main/resources/messages.xml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,14 @@
2424
<LongDescription>Detected handler state that is potentially not resilient to VM snapshot and restore operations in Lambda function {0}.</LongDescription>
2525
<Details>
2626
<![CDATA[
27-
<p>Our analysis shows that AWS Lambda handler class initialization creates state that might have adverse effects
28-
on the output of the function when it uses SnapStart. Lambda functions that use SnapStart are
29-
snapshotted at their initialized state and all execution environments created afterwards share the same initial
30-
state. This means that if the Lambda function relies on state that is not resilient to snapshot and restore
31-
operations, it might manifest an unexpected behavior by using SnapStart.</p>
27+
<p>Our analysis shows that AWS Lambda handler class initialization creates state that may not remain unique for the function
28+
when it uses SnapStart. Lambda functions that use SnapStart are snapshotted at their initialized state and all execution
29+
environments created afterwards share the same initial state. This means that if the Lambda function relies on state that
30+
is not resilient to snapshot and restore operations, it might manifest an unexpected behavior by using SnapStart.</p>
3231
33-
<p>Note that there are countless ways of initializing a Lambda function handler such that it’s not compatible
34-
with SnapStart. This tool helps you as much as possible but please use your own judgement to and refer
35-
to <a href="https://github.com/aws/aws-lambda-snapstart-java-rules/README.md">the documentation</a> for
36-
understanding how to avoid making your Lambda function SnapStart incompatible.</p>
32+
<p>This tool helps provide an insight on possible cases where your code may not be fully compatible with
33+
snapstart enabled. Please verify that your code maintains uniqueness with SnapStart. For best practices, follow the
34+
guidelines outlined in the SnapStart <a href="https://github.com/aws/aws-lambda-snapstart-java-rules/wiki">documentation</a>.</p>
3735
]]>
3836
</Details>
3937
</BugPattern>

0 commit comments

Comments
 (0)