From: Eli Zaretskii <eliz@gnu.org>
Date: Fri, 19 Nov 2021 13:41:48 +0000 (+0200)
Subject: Fix documentation of last commit
X-Git-Tag: emacs-29.0.90~2852^2~191
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=eb86c33c46d4bd1af06abcec5d9d97c705c0ce0d;p=emacs.git

Fix documentation of last commit

* lisp/xwidget.el (xwidget-webkit-cookie-file): Don't use "path"
for file names in the doc string.  Improve wording and markup of
the doc string.

* src/xwidget.c (Fxwidget_webkit_set_cookie_storage_file):
* doc/lispref/display.texi (Xwidgets): Don't use "path" for file
names.

* etc/NEWS: Improve the wording of the entry about
'xwidget-webkit-cookie-file'.
---

diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index a90be5079e2..12257fda54b 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -7015,8 +7015,8 @@ The value returned is a float ranging between 0.0 and 1.0.
 @defun xwidget-webkit-set-cookie-storage-file xwidget file
 Make the WebKit widget @var{xwidget} store cookies in @var{file}.
 
-@var{file} must be an absolute file path.  The new setting will also
-take effect on any xwidget that was created with @var{xwidget} as the
+@var{file} must be an absolute file name.  The new setting will also
+affect any xwidget that was created with @var{xwidget} as the
 @code{related} argument to @code{make-xwidget}, and widgets related to
 those as well.
 
diff --git a/etc/NEWS b/etc/NEWS
index 2d3f9dae5ba..c38e1aa5ebd 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -495,8 +495,10 @@ named.
 
 ---
 *** New user option 'xwidget-webkit-cookie-file'.
-Using this option you can set where and if the xwidget-webkit buffers
-save cookies set by web pages.
+Using this option you can control whether the xwidget-webkit buffers
+save cookies set by web pages, and if so, in which file to save them.
+the default is the file 'xwidget-webkit-cookies.txt' under
+'~/.emacs.d' directory.
 
 +++
 *** New minor mode 'xwidget-webkit-edit-mode'.
diff --git a/lisp/xwidget.el b/lisp/xwidget.el
index 056315a4db9..a1f992e6598 100644
--- a/lisp/xwidget.el
+++ b/lisp/xwidget.el
@@ -111,9 +111,9 @@ It can use the following special constructs:
 (defcustom xwidget-webkit-cookie-file
   (file-name-concat user-emacs-directory
                     "xwidget-webkit-cookies.txt")
-  "A path to the file where xwidget-webkit-browse-url will store cookies.
-They will be stored as plain text in Mozilla `cookies.txt'
-format.  If nil, cookies will not be stored."
+  "The name of the file where `xwidget-webkit-browse-url' will store cookies.
+They will be stored as plain text in Mozilla \"cookies.txt\"
+format.  If nil, do not store cookies."
   :type 'string
   :version "29.1")
 
diff --git a/src/xwidget.c b/src/xwidget.c
index 4e84d43b2a6..8cad2fbc2c1 100644
--- a/src/xwidget.c
+++ b/src/xwidget.c
@@ -2587,8 +2587,8 @@ DEFUN ("xwidget-webkit-set-cookie-storage-file",
        2, 2, 0, doc: /* Make the WebKit widget XWIDGET load and store cookies in FILE.
 
 Cookies will be stored as plain text in FILE, which must be an
-absolute file path.  All xwidgets related to XWIDGET will also be
-changed to store and load cookies in FILE.  */)
+absolute file name.  All xwidgets related to XWIDGET will also
+store cookies in FILE and load them from there.  */)
   (Lisp_Object xwidget, Lisp_Object file)
 {
 #ifdef USE_GTK