[patch] fixed broken jump tag in help files

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
2 messages Options
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

[patch] fixed broken jump tag in help files

Dominique Pellé
Hi

Attached patch corrects a few issues in help files (2318:c79ccf947487):
- fixed some incorrect jump tags
- fixed a couple of typos

I also see the following broken tags which I don't know how to fix
in runtime/doc/ft_ada.txt:

|g:gnat.Pretty_Command|
|g:gnat.Find_Command|


I used the following Perl script to find the incorrect jump tags
(it gives a few false positive):

$ cat find-broken-links.pl
#!/usr/bin/perl -w

# Find broken links in Vim help files.
# Example:
#   find-broken-links.pl vim/runtime/doc/*txt

my %used_links;
my %defined_links;

while (<>) {
  foreach (/(?<!\\)\|([#-)!+-~]+)\|/g) {
    $used_links{$_} = $ARGV unless /====/;
  }
  foreach (/(?<!\\)\*([#-)!+-~]+)\*/g) {
    $defined_links{$_} = 1 unless /====/;
  }
}
foreach (keys %used_links) {
  print "link [$_] used in [$used_links{$_}] but not defined anywhere\n"
    unless exists $defined_links{$_};
}

$ ./find-broken-links.pl /usr/local/share/vim/vim73a/doc/*txt
...

Regards
-- Dominique

--
You received this message from the "vim_dev" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php

fixed-invalid-doc-tags.patch (5K) Download Attachment
Reply | Threaded
Open this post in threaded view
|  
Report Content as Inappropriate

Re: [patch] fixed broken jump tag in help files

Tony Mechelynck
On 14/07/10 22:59, Dominique Pellé wrote:

> Hi
>
> Attached patch corrects a few issues in help files (2318:c79ccf947487):
> - fixed some incorrect jump tags
> - fixed a couple of typos
>
> I also see the following broken tags which I don't know how to fix
> in runtime/doc/ft_ada.txt:
>
> |g:gnat.Pretty_Command|
> |g:gnat.Find_Command|
>
>
> I used the following Perl script to find the incorrect jump tags
> (it gives a few false positive):
>
> $ cat find-broken-links.pl
> #!/usr/bin/perl -w
>
> # Find broken links in Vim help files.
> # Example:
> #   find-broken-links.pl vim/runtime/doc/*txt
>
> my %used_links;
> my %defined_links;
>
> while (<>) {
>    foreach (/(?<!\\)\|([#-)!+-~]+)\|/g) {
>      $used_links{$_} = $ARGV unless /====/;
>    }
>    foreach (/(?<!\\)\*([#-)!+-~]+)\*/g) {
>      $defined_links{$_} = 1 unless /====/;
>    }
> }
> foreach (keys %used_links) {
>    print "link [$_] used in [$used_links{$_}] but not defined anywhere\n"
>      unless exists $defined_links{$_};
> }
>
> $ ./find-broken-links.pl /usr/local/share/vim/vim73a/doc/*txt
> ...
>
> Regards
> -- Dominique
>

In at least three places in this patch I see changed lines with
|'options'| using both single quotes and bars. This is unnecessary. The
help syntax script highlights 'options' distinctively, and bars are not
necessary (in fact, in most of the help they are not used) to make
hotlinks out of single-quoted options.


Best regards,
Tony.
--
Once a young gay from Khartoum
Took a lesbian up to his room.
        They argued all night
        Over who had the right
To do what, and with which, and to whom.

--
You received this message from the "vim_dev" maillist.
Do not top-post! Type your reply below the text you are replying to.
For more information, visit http://www.vim.org/maillist.php
Loading...