Skip to content

Commit b05ad3f

Browse files
committed
fix tip 3
1 parent fd41c1c commit b05ad3f

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,24 +30,24 @@ The AWS-C-S3 library is an asynchronous AWS S3 client focused on maximizing thro
3030
export AWS_CRT_S3_MEMORY_LIMIT_IN_GIB=4 # 4 GiB limit
3131
```
3232

33-
> [!TIP]
34-
> You can also control memory limit *in bytes* using client config. The client config takes precedence over the environment variable (memory_limit_in_bytes needs to be set to a non-zero value).
35-
> ```c
36-
> struct aws_s3_client_config config = {
37-
> .memory_limit_in_bytes = GB_TO_BYTES(4), // 4 GiB limit
38-
> // ... other configuration
39-
> };
40-
> ```
41-
4233
**Default Behavior**:
43-
If neither is set (config is 0 and environment variable is not set), the client sets a default memory limit based on the target throughput.
34+
When nothing is set, the client sets a default memory limit based on the target throughput.
4435

4536
**Notes**:
4637
* The limit applies per client. If multiple clients created, limit will apply to each separately.
4738
* The environment variable value must be a valid positive integer representing gigabytes (GiB).
4839
* The value is converted from GiB to bytes internally (1 GiB = 1024³ bytes).
4940
* Invalid values or overflow conditions will cause client creation to fail with `AWS_ERROR_INVALID_ARGUMENT`.
5041

42+
> [!TIP]
43+
> You can also control memory limit *in bytes* using client config. The client config takes precedence over the environment variable (memory_limit_in_bytes needs to be set to a non-zero value).
44+
> ```c
45+
> struct aws_s3_client_config config = {
46+
> .memory_limit_in_bytes = GB_TO_BYTES(4), // 4 GiB limit
47+
> // ... other configuration
48+
> };
49+
> ```
50+
5151
2. **Maximum Parts Pending Read - `AWS_CRT_S3_MAX_PARTS_PENDING_READ`**
5252
5353
Controls the maximum number of parts that can be pending read from the input stream during a multipart upload. Higher values may improve upload throughput for large files by allowing more parts to be read in parallel, at the cost of higher memory usage.

0 commit comments

Comments
 (0)