]> git.eshelyaron.com Git - emacs.git/commitdiff
Fix documentation of last commit
authorEli Zaretskii <eliz@gnu.org>
Fri, 19 Nov 2021 13:41:48 +0000 (15:41 +0200)
committerEli Zaretskii <eliz@gnu.org>
Fri, 19 Nov 2021 13:41:48 +0000 (15:41 +0200)
* 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'.

doc/lispref/display.texi
etc/NEWS
lisp/xwidget.el
src/xwidget.c

index a90be5079e2781d3dda2198a086d2e2b24f8b711..12257fda54b68e64dda26def6708809788506011 100644 (file)
@@ -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.
 
index 2d3f9dae5baf6e57c409c84109d3f963a9a67f5b..c38e1aa5ebdbe3a27e8964f1d6c3ac59d0c58204 100644 (file)
--- 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'.
index 056315a4db9cf43b4b2f1d7adac9b6db46a7779d..a1f992e65989c56905a8038260cc43f158fbe664 100644 (file)
@@ -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")
 
index 4e84d43b2a61476290090529520f5dfa66d92c6f..8cad2fbc2c13bf8426a9d0d5d7c9b6c763e349ae 100644 (file)
@@ -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