diff options
author | Carlo Teubner <carlo@cteubner.net> | 2022-07-30 12:03:16 +0100 |
---|---|---|
committer | Bram Moolenaar <Bram@vim.org> | 2022-07-30 12:03:16 +0100 |
commit | ddab3ce3457aadffb16ce0127f67a99966a065a8 (patch) | |
tree | 2af8366ff637bb9153ff37fd88c89bab83162c17 /src | |
parent | 1eead4cf1daf87ee41aeb4de3b3e38708417f9d5 (diff) |
patch 9.0.0110: help tag generation picks up words in code examplesv9.0.0110
Problem: Help tag generation picks up words in code examples.
Solution: Skip over examples. (Carlo Teubner, closes #10813)
Diffstat (limited to 'src')
-rw-r--r-- | src/help.c | 14 | ||||
-rw-r--r-- | src/testdir/test_help.vim | 7 | ||||
-rw-r--r-- | src/version.c | 2 |
3 files changed, 23 insertions, 0 deletions
diff --git a/src/help.c b/src/help.c index e58068020c..0f43c0063c 100644 --- a/src/help.c +++ b/src/help.c @@ -960,6 +960,8 @@ helptags_one( int utf8 = MAYBE; int this_utf8; int firstline; + int in_example; + int len; int mix = FALSE; // detected mixed encodings // Find all *.txt files. @@ -1025,6 +1027,7 @@ helptags_one( } fname = files[fi] + dirlen + 1; + in_example = FALSE; firstline = TRUE; while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int) { @@ -1059,6 +1062,13 @@ helptags_one( } firstline = FALSE; } + if (in_example) + { + // skip over example; a non-white in the first column ends it + if (vim_strchr((char_u *)" \t\n\r", IObuff[0])) + continue; + in_example = FALSE; + } p1 = vim_strchr(IObuff, '*'); // find first '*' while (p1 != NULL) { @@ -1103,6 +1113,10 @@ helptags_one( } p1 = p2; } + len = (int)STRLEN(IObuff); + if ((len == 2 && STRCMP(&IObuff[len - 2], ">\n") == 0) + || (len >= 3 && STRCMP(&IObuff[len - 3], " >\n") == 0)) + in_example = TRUE; line_breakcheck(); } diff --git a/src/testdir/test_help.vim b/src/testdir/test_help.vim index ff06b0f2ab..30c0b9d807 100644 --- a/src/testdir/test_help.vim +++ b/src/testdir/test_help.vim @@ -141,6 +141,13 @@ func Test_helptag_cmd() call assert_equal(["help-tags\ttags\t1"], readfile('Xdir/tags')) call delete('Xdir/tags') + " Test parsing tags + call writefile(['*tag1*', 'Example: >', ' *notag*', 'Example end: *tag2*'], + \ 'Xdir/a/doc/sample.txt') + helptags Xdir + call assert_equal(["tag1\ta/doc/sample.txt\t/*tag1*", + \ "tag2\ta/doc/sample.txt\t/*tag2*"], readfile('Xdir/tags')) + " Duplicate tags in the help file call writefile(['*tag1*', '*tag1*', '*tag2*'], 'Xdir/a/doc/sample.txt') call assert_fails('helptags Xdir', 'E154:') diff --git a/src/version.c b/src/version.c index cc642cc42c..c3b5b65208 100644 --- a/src/version.c +++ b/src/version.c @@ -736,6 +736,8 @@ static char *(features[]) = static int included_patches[] = { /* Add new patch number below this line */ /**/ + 110, +/**/ 109, /**/ 108, |