Skip to content

Commit e6d0c4f

Browse files
authored
docs: clarify build cache direct file transfer experiment
1 parent 585f972 commit e6d0c4f

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

libraries/rush-lib/src/api/ExperimentsConfiguration.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,8 +148,9 @@ export interface IExperimentsJson {
148148
/**
149149
* If true, the build cache will use file-based APIs to transfer cache entries to and from cloud
150150
* storage. This avoids loading the entire cache entry into memory, which can prevent out-of-memory
151-
* errors for large build outputs. The cloud cache provider plugin must implement the optional
152-
* file-based methods for this to take effect; otherwise it falls back to the buffer-based approach.
151+
* errors for large build outputs and allow cache entries to exceed the limit of a single Buffer.
152+
* The cloud cache provider plugin must implement the optional file-based methods for this to take
153+
* effect; otherwise it falls back to the buffer-based approach.
153154
*/
154155
useDirectFileTransfersForBuildCache?: boolean;
155156
}

libraries/rush-lib/src/schemas/experiments.schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@
9191
"type": "boolean"
9292
},
9393
"useDirectFileTransfersForBuildCache": {
94-
"description": "If true, the build cache will use file-based APIs to transfer cache entries to and from cloud storage. This avoids loading the entire cache entry into memory, which can prevent out-of-memory errors for large build outputs. The cloud cache provider plugin must implement the optional file-based methods for this to take effect; otherwise it falls back to the buffer-based approach.",
94+
"description": "If true, the build cache will use file-based APIs to transfer cache entries to and from cloud storage. This avoids loading the entire cache entry into memory, which can prevent out-of-memory errors for large build outputs and allow cache entries to exceed the limit of a single Buffer. The cloud cache provider plugin must implement the optional file-based methods for this to take effect; otherwise it falls back to the buffer-based approach.",
9595
"type": "boolean"
9696
}
9797
},

0 commit comments

Comments
 (0)