From cbae0fb71cea55004f7066c0dfc870137b53ee8b Mon Sep 17 00:00:00 2001
From: Luke Karrys <luke@lukekarrys.com>
Date: Thu, 2 Dec 2021 14:17:38 -0700
Subject: [PATCH] docs: update description about where/when debug log is
 written

PR-URL: https://github.com/npm/cli/pull/4114
Credit: @lukekarrys
Close: #4114
Reviewed-by: @wraithgar
---
 docs/content/using-npm/config.md                             | 4 ++--
 lib/utils/config/definitions.js                              | 4 ++--
 tap-snapshots/test/lib/utils/config/definitions.js.test.cjs  | 4 ++--
 tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs | 4 ++--
 4 files changed, 8 insertions(+), 8 deletions(-)

diff --git a/docs/content/using-npm/config.md b/docs/content/using-npm/config.md
index a7678b18d7f83..fe197e344dbc0 100644
--- a/docs/content/using-npm/config.md
+++ b/docs/content/using-npm/config.md
@@ -1014,8 +1014,8 @@ Ideal if all users are on npm version 7 and higher.
 * Type: "silent", "error", "warn", "notice", "http", "timing", "info",
   "verbose", or "silly"
 
-What level of logs to report. On failure, *all* logs are written to
-`npm-debug.log` in the current working directory.
+What level of logs to report. All logs are written to a debug log, with the
+path to that file printed if the execution of a command fails.
 
 Any logs of a higher level than the setting are shown. The default is
 "notice".
diff --git a/lib/utils/config/definitions.js b/lib/utils/config/definitions.js
index 181406918d1e9..ac8a4e2f6749d 100644
--- a/lib/utils/config/definitions.js
+++ b/lib/utils/config/definitions.js
@@ -1214,8 +1214,8 @@ define('loglevel', {
     'silly',
   ],
   description: `
-    What level of logs to report.  On failure, *all* logs are written to
-    \`npm-debug.log\` in the current working directory.
+    What level of logs to report.  All logs are written to a debug log,
+    with the path to that file printed if the execution of a command fails.
 
     Any logs of a higher level than the setting are shown. The default is
     "notice".
diff --git a/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs b/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
index 069c8ec4f49c9..84bb22ff0ef59 100644
--- a/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
+++ b/tap-snapshots/test/lib/utils/config/definitions.js.test.cjs
@@ -1087,8 +1087,8 @@ exports[`test/lib/utils/config/definitions.js TAP > config description for logle
 * Type: "silent", "error", "warn", "notice", "http", "timing", "info",
   "verbose", or "silly"
 
-What level of logs to report. On failure, *all* logs are written to
-\`npm-debug.log\` in the current working directory.
+What level of logs to report. All logs are written to a debug log, with the
+path to that file printed if the execution of a command fails.
 
 Any logs of a higher level than the setting are shown. The default is
 "notice".
diff --git a/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs b/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs
index 80d95f9713339..3db90f7679d4e 100644
--- a/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs
+++ b/tap-snapshots/test/lib/utils/config/describe-all.js.test.cjs
@@ -888,8 +888,8 @@ Ideal if all users are on npm version 7 and higher.
 * Type: "silent", "error", "warn", "notice", "http", "timing", "info",
   "verbose", or "silly"
 
-What level of logs to report. On failure, *all* logs are written to
-\`npm-debug.log\` in the current working directory.
+What level of logs to report. All logs are written to a debug log, with the
+path to that file printed if the execution of a command fails.
 
 Any logs of a higher level than the setting are shown. The default is
 "notice".