commit 9dcd349ca85e1df1abd1cbf1c29c0f1574b70bf8
author Hu Jialun <hujialun@comp.nus.edu.sg> Sat Aug 28 20:42:50 2021 +0200
committer Bram Moolenaar <Bram@vim.org> Sat Aug 28 20:42:50 2021 +0200
tree a3b5f55b7ab7d58e173349c318906c77583f7691
parent 9aecf79c45da5593e4d8c0de1b2d212edc4765ce

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 #8798)

runtime/doc/options.txt

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index ebb408d..a181ecb 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -541,6 +541,15 @@
 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

src/buffer.c

diff --git a/src/buffer.c b/src/buffer.c
index bc3378a..507eb01 100644
--- a/src/buffer.c
+++ b/src/buffer.c
@@ -5446,12 +5446,12 @@
 	return;
 
     ++entered;
-    for (lnum = 1; lnum <= curbuf->b_ml.ml_line_count && lnum <= nmlines;
+    for (lnum = 1; curbuf->b_p_ml && lnum <= curbuf->b_ml.ml_line_count && lnum <= nmlines;
 								       ++lnum)
 	if (chk_modeline(lnum, flags) == FAIL)
 	    nmlines = 0;
 
-    for (lnum = curbuf->b_ml.ml_line_count; lnum > 0 && lnum > nmlines
+    for (lnum = curbuf->b_ml.ml_line_count; curbuf->b_p_ml && lnum > 0 && lnum > nmlines
 		       && lnum > curbuf->b_ml.ml_line_count - nmlines; --lnum)
 	if (chk_modeline(lnum, flags) == FAIL)
 	    nmlines = 0;

src/testdir/test_modeline.vim

diff --git a/src/testdir/test_modeline.vim b/src/testdir/test_modeline.vim
index 19c99b5..f28ad3e 100644
--- a/src/testdir/test_modeline.vim
+++ b/src/testdir/test_modeline.vim
@@ -360,4 +360,12 @@
   bw
 endfunc
 
+func Test_modeline_disable()
+  set modeline
+  call writefile(['vim: sw=2', 'vim: nomodeline', 'vim: sw=3'], 'Xmodeline_disable')
+  edit Xmodeline_disable
+  call assert_equal(2, &sw)
+  call delete('Xmodeline_disable')
+endfunc
+
 " vim: shiftwidth=2 sts=2 expandtab

src/version.c

diff --git a/src/version.c b/src/version.c
index a9c5b4c..d50d098 100644
--- a/src/version.c
+++ b/src/version.c
@@ -756,6 +756,8 @@
 static int included_patches[] =
 {   /* Add new patch number below this line */
 /**/
+    3384,
+/**/
     3383,
 /**/
     3382,