patch 9.1.1486: documentation issues with Wayland
Problem: documentation issues with Wayland
(after v9.1.1485)
Solution: Tweak documentation style. Capitalize the first letter of
Wayland (Hirohito Higashi)
related: #17619
Signed-off-by: Hirohito Higashi <h.east.727@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
diff --git a/src/auto/configure b/src/auto/configure
index 731e0f1..8023fbe 100755
--- a/src/auto/configure
+++ b/src/auto/configure
@@ -9107,8 +9107,8 @@
if test "$with_wayland" = yes; then
{ printf "%s\n" "$as_me:${as_lineno-$LINENO}: result: yes" >&5
printf "%s\n" "yes" >&6; }
- { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking if wayland client header files can be found" >&5
-printf %s "checking if wayland client header files can be found... " >&6; }
+ { printf "%s\n" "$as_me:${as_lineno-$LINENO}: checking if Wayland client header files can be found" >&5
+printf %s "checking if Wayland client header files can be found... " >&6; }
cppflags_save=$CPPFLAGS
CPPFLAGS="$CPPFLAGS $X_CFLAGS"
cat confdefs.h - <<_ACEOF >conftest.$ac_ext
diff --git a/src/clipboard.c b/src/clipboard.c
index 4d9455a..7552751 100644
--- a/src/clipboard.c
+++ b/src/clipboard.c
@@ -2676,7 +2676,7 @@
}
/*
- * Send the current selection to the clipboard. Do nothing for wayland because
+ * Send the current selection to the clipboard. Do nothing for Wayland because
* we will fill in the selection only when requested by another client.
*/
void
@@ -2797,14 +2797,14 @@
if (method == CLIPMETHOD_FAIL)
return e_invalid_argument;
-// If GUI is running or we are not on a system with wayland or x11, then always
+// If GUI is running or we are not on a system with Wayland or X11, then always
// return CLIPMETHOD_NONE. System or GUI clipboard handling always overrides.
#if defined(FEAT_XCLIPBOARD) || defined(FEAT_WAYLAND_CLIPBOARD)
#if defined(FEAT_GUI)
if (gui.in_use)
{
#ifdef FEAT_WAYLAND
- // We only interact with wayland for the clipboard, we can just deinit
+ // We only interact with Wayland for the clipboard, we can just deinit
// everything.
wayland_uninit_client();
#endif
diff --git a/src/configure.ac b/src/configure.ac
index c91c841..9debfd4 100644
--- a/src/configure.ac
+++ b/src/configure.ac
@@ -2407,7 +2407,7 @@
test -z "$with_wayland" && with_wayland=yes
if test "$with_wayland" = yes; then
AC_MSG_RESULT(yes)
- AC_MSG_CHECKING(if wayland client header files can be found)
+ AC_MSG_CHECKING(if Wayland client header files can be found)
cppflags_save=$CPPFLAGS
CPPFLAGS="$CPPFLAGS $X_CFLAGS"
AC_COMPILE_IFELSE([AC_LANG_PROGRAM([#include <wayland-client.h>], )],
diff --git a/src/feature.h b/src/feature.h
index 07db96c..145de0b 100644
--- a/src/feature.h
+++ b/src/feature.h
@@ -813,7 +813,7 @@
#endif
/*
- * +wayland Unix only. Include code for the wayland protocol,
+ * +wayland Unix only. Include code for the Wayland protocol,
* only works if HAVE_WAYLAND is defined.
*/
#if defined(FEAT_NORMAL) && defined(UNIX)
diff --git a/src/globals.h b/src/globals.h
index 31fbf4f..f8b8ade 100644
--- a/src/globals.h
+++ b/src/globals.h
@@ -2079,7 +2079,7 @@
#ifdef FEAT_WAYLAND
-// Don't connect to wayland compositor if TRUE
+// Don't connect to Wayland compositor if TRUE
EXTERN int wayland_no_connect INIT(= FALSE);
// Wayland display name (ex. wayland-0). Can be NULL
diff --git a/src/main.c b/src/main.c
index 98a17bc..5c767a2 100644
--- a/src/main.c
+++ b/src/main.c
@@ -684,11 +684,11 @@
{
if (wayland_init_client(wayland_display_name) == OK)
{
- TIME_MSG("connected to wayland display");
+ TIME_MSG("connected to Wayland display");
# ifdef FEAT_WAYLAND_CLIPBOARD
if (wayland_cb_init((char*)p_wse) == OK)
- TIME_MSG("setup wayland clipboard");
+ TIME_MSG("setup Wayland clipboard");
}
# endif
}
@@ -2482,7 +2482,7 @@
x_no_connect = TRUE;
#endif
break;
- case 'Y': // "-Y" don't connect to wayland compositor
+ case 'Y': // "-Y" don't connect to Wayland compositor
#if defined(FEAT_WAYLAND)
wayland_no_connect = TRUE;
#endif
@@ -3693,7 +3693,7 @@
main_msg(_("-X\t\t\tDo not connect to X server"));
#endif
#if defined(FEAT_WAYLAND)
- main_msg(_("-Y\t\t\tDo not connect to wayland compositor"));
+ main_msg(_("-Y\t\t\tDo not connect to Wayland compositor"));
#endif
#ifdef FEAT_CLIENTSERVER
main_msg(_("--remote <files>\tEdit <files> in a Vim server if possible"));
diff --git a/src/optionstr.c b/src/optionstr.c
index c72c5d2..dcbb30b 100644
--- a/src/optionstr.c
+++ b/src/optionstr.c
@@ -3650,7 +3650,7 @@
did_set_wlseat(optset_T *args UNUSED)
{
#ifdef FEAT_WAYLAND_CLIPBOARD
- // If there isn't any seat named 'wlseat', then let the wayland clipboard be
+ // If there isn't any seat named 'wlseat', then let the Wayland clipboard be
// unavailable. Ignore errors returned.
wayland_cb_reload();
#endif
diff --git a/src/os_unix.c b/src/os_unix.c
index bf07b38..9fd6436 100644
--- a/src/os_unix.c
+++ b/src/os_unix.c
@@ -1319,7 +1319,7 @@
|| defined(FEAT_WAYLAND_CLIPBOARD))
/*
* Called when Vim is going to sleep or execute a shell command.
- * We can't respond to requests for the X or wayland selections.
+ * We can't respond to requests for the X or Wayland selections.
* Lose them, otherwise other applications will hang. But first
* copy the text to cut buffer 0 (for X11). Wayland users must have
* a clipboard manager to replicate such behaviour.
@@ -5608,7 +5608,7 @@
clip_update();
# endif
#ifdef FEAT_WAYLAND
- // Handle wayland events such as sending data as the source
+ // Handle Wayland events such as sending data as the source
// client.
wayland_client_update();
#endif
@@ -5682,7 +5682,7 @@
clip_update();
#endif
#ifdef FEAT_WAYLAND
- // Handle wayland events such as sending data as the source
+ // Handle Wayland events such as sending data as the source
// client.
wayland_client_update();
#endif
diff --git a/src/testdir/test_wayland.vim b/src/testdir/test_wayland.vim
index ef4d8fb..5dd6065 100644
--- a/src/testdir/test_wayland.vim
+++ b/src/testdir/test_wayland.vim
@@ -115,7 +115,7 @@
call assert_equal(l:wayland_display, v:wayland_display)
- " Check if calling wlrestore without arguments uses the existing wayland
+ " Check if calling wlrestore without arguments uses the existing Wayland
" display.
wlrestore!
call assert_equal(l:wayland_display, v:wayland_display)
@@ -151,7 +151,7 @@
call EndWaylandCompositor(l:wayland_display)
endfunc
-" Test behaviour when wayland display connection is lost
+" Test behaviour when Wayland display connection is lost
func Test_wayland_connection_lost()
call s:PreTest()
@@ -356,7 +356,7 @@
bw!
endfunc
-" Test if autoselect option in 'clipboard' works properly for wayland
+" Test if autoselect option in 'clipboard' works properly for Wayland
func Test_wayland_autoselect_works()
call s:PreTest()
call s:CheckXConnection()
diff --git a/src/version.c b/src/version.c
index b38ca08..f5de6ff 100644
--- a/src/version.c
+++ b/src/version.c
@@ -720,6 +720,8 @@
static int included_patches[] =
{ /* Add new patch number below this line */
/**/
+ 1486,
+/**/
1485,
/**/
1484,
diff --git a/src/wayland.c b/src/wayland.c
index aca3e07..dc34925 100644
--- a/src/wayland.c
+++ b/src/wayland.c
@@ -8,7 +8,7 @@
*/
/*
- * wayland.c: Stuff related to wayland
+ * wayland.c: Stuff related to Wayland
*/
#include "vim.h"
@@ -49,7 +49,7 @@
#endif
} vwl_global_objects_T;
-// Struct wrapper for wayland display and registry
+// Struct wrapper for Wayland display and registry
typedef struct {
struct wl_display *proxy;
int fd; // File descriptor for display
@@ -946,7 +946,7 @@
}
/*
- * Connects to the wayland display with given name and binds to global objects
+ * Connects to the Wayland display with given name and binds to global objects
* as needed. If display is NULL then the $WAYLAND_DISPLAY environment variable
* will be used (handled by libwayland). Returns FAIL on failure and OK on
* success
@@ -970,7 +970,7 @@
}
/*
- * Disconnect wayland client and free up all resources used.
+ * Disconnect Wayland client and free up all resources used.
*/
void
wayland_uninit_client(void)
@@ -984,7 +984,7 @@
}
/*
- * Return TRUE if wayland display connection is valid and ready.
+ * Return TRUE if Wayland display connection is valid and ready.
*/
int
wayland_client_is_connected(int quiet)
@@ -1884,7 +1884,7 @@
}
/*
- * Setup required objects to interact with wayland selections/clipboard on given
+ * Setup required objects to interact with Wayland selections/clipboard on given
* seat. Returns OK on success and FAIL on failure.
*/
int
@@ -2325,7 +2325,7 @@
}
/*
- * Return TRUE if the wayland clipboard/selections are ready to use.
+ * Return TRUE if the Wayland clipboard/selections are ready to use.
*/
int
wayland_cb_is_ready(void)
@@ -2339,7 +2339,7 @@
}
/*
- * Reload wayland clipboard, useful if changing seat.
+ * Reload Wayland clipboard, useful if changing seat.
*/
int
wayland_cb_reload(void)
@@ -2391,7 +2391,7 @@
}
/*
- * Disconnect then reconnect wayland connection, and update clipmethod.
+ * Disconnect then reconnect Wayland connection, and update clipmethod.
*/
void
ex_wlrestore(exarg_T *eap)
@@ -2405,7 +2405,7 @@
display = (char*)eap->arg;
// Return early if shebang is not passed, we are still connected, and if not
- // changing to a new wayland display.
+ // changing to a new Wayland display.
if (!eap->forceit && wayland_client_is_connected(TRUE) &&
(display == wayland_display_name ||
(wayland_display_name != NULL &&
@@ -2434,14 +2434,14 @@
if (wayland_init_client(display) == OK)
{
- smsg(_("restoring wayland display %s"), wayland_display_name);
+ smsg(_("restoring Wayland display %s"), wayland_display_name);
#ifdef FEAT_WAYLAND_CLIPBOARD
wayland_cb_init((char*)p_wse);
#endif
}
else
- msg(_("failed restoring, lost connection to wayland display"));
+ msg(_("failed restoring, lost connection to Wayland display"));
vim_free(display);