winget-cli

commit e979f4f5b62d18c06e0e1558c474ddb890ff6028
parent d25870a4aa739184ab635326e5d486af030e392a
Author: JohnMcPMS <johnmcp@microsoft.com>
Date:   Fri, 26 Mar 2021 11:13:15 -0700

Deferred update to settings docs for telemetry opt-out (#782)


Diffstat:
M
.github/actions/spelling/allow.txt
 | 
1
+
M
doc/Settings.md
 | 
16
++++++++++++++++
M
schemas/JSON/settings/settings.schema.0.2.json
 | 
26
+++++++++++++++++++++++---

3 files changed, 40 insertions(+), 3 deletions(-)
diff --git a/.github/actions/spelling/allow.txt b/.github/actions/spelling/allow.txt
@@ -67,6 +67,7 @@ csproj
 CStr
 CURSORPOSITON
 cwctype
+datatelemetry
 dbconn
 DBId
 declspec
diff --git a/doc/Settings.md b/doc/Settings.md
@@ -45,6 +45,22 @@ Color of the progress bar that WinGet displays when not specified by arguments.
 - retro
 - rainbow
 
+## Telemetry
+
+The `telemetry` settings control whether winget writes ETW events that may be sent to Microsoft on a default installation of Windows.
+
+See [details on telemetry](../README.md#datatelemetry), and our [primary privacy statement](../privacy.md).
+
+### disable
+
+```
+    "telemetry": {
+        "disable": true
+    },
+```
+
+If set to true, the `telemetry.disable` setting will prevent any event from being written by the program.
+
 ## Experimental Features
 
 To allow work to be done and distributed to early adopters for feedback, settings can be used to enable "experimental" features. 
diff --git a/schemas/JSON/settings/settings.schema.0.2.json b/schemas/JSON/settings/settings.schema.0.2.json
@@ -24,11 +24,25 @@
           "description": "Progress bar display style",
           "type": "string",
           "enum": [
-              "accent", "rainbow", "plain", "retro"
+            "accent",
+            "rainbow",
+            "plain",
+            "retro"
           ]
         }
       }
     },
+    "Telemetry": {
+      "description": "Telemetry settings",
+      "type": "object",
+      "properties": {
+        "disable": {
+          "description": "Controls whether telemetry events are written",
+          "type": "boolean",
+          "default": false
+        }
+      }
+    },
     "Experimental": {
       "description": "Experimental Features",
       "type": "object",
@@ -66,12 +80,12 @@
         "import": {
           "description": "Enable the import command while it is in development",
           "type": "boolean",
-          "default":  false
+          "default": false
         },
         "restSource": {
           "description": "Enable the rest source support while it is in development",
           "type": "boolean",
-          "default":  false
+          "default": false
         }
       }
     }
@@ -90,6 +104,12 @@
       "additionalItems": true
     },
     {
+      "properties": {
+        "telemetry": { "$ref": "#/definitions/Telemetry"}
+      },
+      "additionalItems": true
+    },
+    {
         "properties": {
           "experimentalFeatures": { "$ref": "#/definitions/Experimental"}
         },