0
0
mirror of https://github.com/vim/vim.git synced 2025-10-01 04:54:07 -04:00

patch 9.0.0110: help tag generation picks up words in code examples

Problem:    Help tag generation picks up words in code examples.
Solution:   Skip over examples. (Carlo Teubner, closes #10813)
This commit is contained in:
Carlo Teubner
2022-07-30 12:03:16 +01:00
committed by Bram Moolenaar
parent 1eead4cf1d
commit ddab3ce345
4 changed files with 45 additions and 10 deletions

View File

@@ -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();
}

View File

@@ -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:')

View File

@@ -735,6 +735,8 @@ static char *(features[]) =
static int included_patches[] =
{ /* Add new patch number below this line */
/**/
110,
/**/
109,
/**/