diff runtime/doc/options.txt @ 25696:64fa341cc33b v8.2.3384

patch 8.2.3384: cannot disable modeline for an individual file Commit: https://github.com/vim/vim/commit/9dcd349ca85e1df1abd1cbf1c29c0f1574b70bf8 Author: Hu Jialun <hujialun@comp.nus.edu.sg> Date: Sat Aug 28 20:42:50 2021 +0200 patch 8.2.3384: cannot disable modeline for an individual file Problem: Cannot disable modeline for an individual file. Solution: Recognize "nomodeline" in a modeline. (Hu Jialun, closes https://github.com/vim/vim/issues/8798)
author Bram Moolenaar <Bram@vim.org>
date Sat, 28 Aug 2021 20:45:03 +0200
parents c26ff3203b43
children d4faa2c5211b
line wrap: on
line diff
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -541,6 +541,15 @@ chance that a normal word like "lex:" is
 version 3.0).  Using "ex:" at the start of the line will be ignored (this
 could be short for "example:").
 
+If the modeline is disabled within a modeline, subsequent modelines will be
+ignored.  This is to allow turning off modeline on a per-file basis.  This is
+useful when a line looks like a modeline but isn't.  For example, it would be
+good to start a YAML file containing strings like "vim:" with
+    # vim: nomodeline ~
+so as to avoid modeline misdetection.  Following options on the same line
+after modeline deactivation, if any, are still evaluated (but you would
+normally not have any).
+
 							*modeline-local*
 The options are set like with ":setlocal": The new value only applies to the
 buffer and window that contain the file.  Although it's possible to set global