chore: centralize user agent documentation in README

mozilla · Nov 21, 2024 · 1df6a5e · 1df6a5e
1 parent 34781e0
commit 1df6a5e
Show file tree

Hide file tree

Showing 7 changed files with 4 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -291,6 +291,10 @@ Known Caveats
 
 * Symbolic links to sccache won't work. Use hardlinks: `ln sccache /usr/local/bin/cc`
 
+### User Agent
+
+* Requests sent to your WebDAV service will have a user agent header indicating the current sccache version, e.g. `sccache/0.8.2`.
+
 Storage Options
 ---------------
 

diff --git a/docs/Azure.md b/docs/Azure.md
@@ -6,6 +6,4 @@ the container for you - you'll need to do that yourself.
 
 You can also define a prefix that will be prepended to the keys of all cache objects created and read within the container, effectively creating a scope. To do that use the `SCCACHE_AZURE_KEY_PREFIX` environment variable. This can be useful when sharing a bucket with another application.
 
-Requests sent to Azure Blob Storage will have a user agent header indicating the current sccache version, e.g. `sccache/0.8.2`.
-
 **Important:** The environment variables are only taken into account when the server starts, i.e. only on the first run.
diff --git a/docs/GHA.md b/docs/GHA.md
@@ -15,8 +15,6 @@ This cache type will need tokens like `ACTIONS_CACHE_URL` and `ACTIONS_RUNTIME_T
       core.exportVariable('ACTIONS_RUNTIME_TOKEN', process.env.ACTIONS_RUNTIME_TOKEN || '');
 ```
 
-Requests sent to the GHA cache service will have a user agent header indicating the current sccache version, e.g. `sccache/0.8.2`.
-
 ## Behavior
 
 In case sccache reaches the rate limit of the service, the build will continue, but the storage might not be performed.
diff --git a/docs/Gcs.md b/docs/Gcs.md
@@ -11,8 +11,6 @@ created and read within the GCS bucket, effectively creating a scope. To do that
 use the `SCCACHE_GCS_KEY_PREFIX` environment variable. This can be useful when
 sharing a bucket with another application.
 
-Requests sent to GCS will have a user agent header indicating the current sccache version, e.g. `sccache/0.8.2`.
-
 ## Credentials
 
 Sccache is able to load credentials from various sources. Including:

diff --git a/docs/OSS.md b/docs/OSS.md
@@ -6,8 +6,6 @@ You **must** specify the endpoint URL using the `SCCACHE_OSS_ENDPOINT` environme
 
 You can also define a prefix that will be prepended to the keys of all cache objects created and read within the OSS bucket, effectively creating a scope. To do that use the `SCCACHE_OSS_KEY_PREFIX` environment variable. This can be useful when sharing a bucket with another application.
 
-Requests sent to OSS will have a user agent header indicating the current sccache version, e.g. `sccache/0.8.2`.
-
 ## Credentials
 
 Sccache is able to load credentials from environment variables: `ALIBABA_CLOUD_ACCESS_KEY_ID` and `ALIBABA_CLOUD_ACCESS_KEY_SECRET`.

diff --git a/docs/S3.md b/docs/S3.md
@@ -13,8 +13,6 @@ More details about encryption [here](https://opendal.apache.org/docs/services/s3
 
 You can also define a prefix that will be prepended to the keys of all cache objects created and read within the S3 bucket, effectively creating a scope. To do that use the `SCCACHE_S3_KEY_PREFIX` environment variable. This can be useful when sharing a bucket with another application.
 
-Requests sent to S3 will have a user agent header indicating the current sccache version, e.g. `sccache/0.8.2`.
-
 # R2
 
 Cloudflare R2 is an S3-compatible object storage and works with the same configuration options as above. To use R2, you **must** define `SCCACHE_ENDPOINT`, otherwise sccache will default to AWS as the endpoint to hit. R2 also requires endpoint connections to be secure, therefore `https://` either needs to be included in `SCCACHE_ENDPOINT` or `SCCACHE_S3_USE_SSL=true` can be used, if the protocol is omitted. There are no regions in R2, so `SCCACHE_REGION` must point to `auto`. The below environment variables are recommended.

diff --git a/docs/Webdav.md b/docs/Webdav.md
@@ -9,7 +9,6 @@ The following services all expose a WebDAV interface and can be used as a backen
 
 Set `SCCACHE_WEBDAV_ENDPOINT` to an appropriate webdav service endpoint to enable remote caching.
 Set `SCCACHE_WEBDAV_KEY_PREFIX` to specify the key prefix of cache.
-Requests sent to your WebDAV service will have a user agent header indicating the current sccache version, e.g. `sccache/0.8.2`.
 
 ## Credentials
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,6 +6,4 @@ the container for you - you'll need to do that yourself.

		You can also define a prefix that will be prepended to the keys of all cache objects created and read within the container, effectively creating a scope. To do that use the `SCCACHE_AZURE_KEY_PREFIX` environment variable. This can be useful when sharing a bucket with another application.

		Requests sent to Azure Blob Storage will have a user agent header indicating the current sccache version, e.g. `sccache/0.8.2`.

		Important: The environment variables are only taken into account when the server starts, i.e. only on the first run.
-Original file line number
+Diff line change
@@ Expand Up @@
     You can also define a prefix that will be prepended to the keys of all cache objects created and read within the S3 bucket, effectively creating a scope. To do that use the `SCCACHE_S3_KEY_PREFIX` environment variable. This can be useful when sharing a bucket with another application.
-    Requests sent to S3 will have a user agent header indicating the current sccache version, e.g. `sccache/0.8.2`.
     # R2
     Cloudflare R2 is an S3-compatible object storage and works with the same configuration options as above. To use R2, you **must** define `SCCACHE_ENDPOINT`, otherwise sccache will default to AWS as the endpoint to hit. R2 also requires endpoint connections to be secure, therefore `https://` either needs to be included in `SCCACHE_ENDPOINT` or `SCCACHE_S3_USE_SSL=true` can be used, if the protocol is omitted. There are no regions in R2, so `SCCACHE_REGION` must point to `auto`. The below environment variables are recommended.
@@ Expand Down @@