cURL / Mailing Lists / curl-library / Single Mail

curl-library

now checking more docs with tests

From: Daniel Stenberg <daniel_at_haxx.se>
Date: Tue, 3 May 2016 00:01:11 +0200 (CEST)

Hey just a FYI here,

Just wanted to mention that I added test 1139 and 1140 the last couple of
days. They do all sorts of fun verifications of docs:

test 1139 runs manpage-scan.pl which

1. checks that all CURLOPT_ options mentioned in symbols-in-versions have
    their own man pages _and_ are mentioned in curl_easy_setopt.3

2. checks that all CURLINFO_ options mentioned in symbols-in-versions have
    their own man pages _and_ are mentioned in curl_easy_getinfo.3

3. checks that all CURLMOPT_ options mentioned in symbols-in-versions have
    their own man pages _and_ are mentioned in curl_multi_setopt.3

4. checks that the code that shows curl -h, the code that lists all command
    line options for the parser and curl.1 all mention the same set of command
    line options. Any and all mismatches are reported. There's a whitelisting
    concept to allow curl -h to not include deprecated options.

test 1140 runs nroff-scan.pl which goes through all nroff formatted man pages
we have (about 346 files right now) and:

1. checks that all references to curl symbols are all within \fI and \fP

2. checks that the targets in references are actual existing man pages

3. checks for mentions of curl symbols with (3) added, that isn't written to
    become a reference

While writing these scripts I of course detected a busload of mistakes in the
docs that I've pushed. My hope is that these scripts will help us reduce the
number of documentation mistakes we commit and help us detect them when we
forget. As the tests also run on pull-requests, they will help contributors to
get their patches with docs done correctly.

Let me know if you get or see any problems because of these!

-- 
  / daniel.haxx.se
-------------------------------------------------------------------
List admin: https://cool.haxx.se/list/listinfo/curl-library
Etiquette:  https://curl.haxx.se/mail/etiquette.html
Received on 2016-05-03