mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-16 00:08:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
Problem:    Help tag generation picks up words in code examples.
Solution:   Skip over examples. (Carlo Teubner, closes vim/vim#10813)

ddab3ce345

Also fix mistakes in help files.

Co-authored-by: Carlo Teubner <carlo@cteubner.net>
This commit is contained in:
zeertzjq
2022-12-03 20:46:01 +08:00
parent 3838ee63d0
commit bf4bf7f9e0
4 changed files with 23 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/nvim/help.c
View File

@@ -941,6 +941,7 @@ static void helptags_one(char *dir, const char *ext, const char *tagfname, bool
}
const char *const fname = files[fi] + dirlen + 1;
bool in_example = false;
bool firstline = true;
while (!vim_fgets(IObuff, IOSIZE, fd) && !got_int) {
if (firstline) {
@@ -971,6 +972,13 @@ static void helptags_one(char *dir, const char *ext, const char *tagfname, bool
}
firstline = false;
}
if (in_example) {
// skip over example; a non-white in the first column ends it
if (vim_strchr(" \t\n\r", IObuff[0])) {
continue;
}
in_example = false;
}
p1 = vim_strchr((char *)IObuff, '*'); // find first '*'
while (p1 != NULL) {
p2 = strchr((const char *)p1 + 1, '*'); // Find second '*'.
@@ -990,7 +998,7 @@ static void helptags_one(char *dir, const char *ext, const char *tagfname, bool
|| s[1] == '\0')) {
*p2 = '\0';
p1++;
size_t s_len= (size_t)(p2 - p1) + strlen(fname) + 2;
size_t s_len = (size_t)(p2 - p1) + strlen(fname) + 2;
s = xmalloc(s_len);
GA_APPEND(char *, &ga, s);
snprintf(s, s_len, "%s\t%s", p1, fname);
@@ -1001,6 +1009,11 @@ static void helptags_one(char *dir, const char *ext, const char *tagfname, bool
}
p1 = p2;
}
size_t len = strlen(IObuff);
if ((len == 2 && strcmp(&IObuff[len - 2], ">\n") == 0)
|| (len >= 3 && strcmp(&IObuff[len - 3], " >\n") == 0)) {
in_example = true;
}
line_breakcheck();
}