You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficserver.apache.org by "James Peach (JIRA)" <ji...@apache.org> on 2014/05/06 17:49:38 UTC

[jira] [Commented] (TS-2783) Automated verification of defaults (config vs. code)

    [ https://issues.apache.org/jira/browse/TS-2783?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13990771#comment-13990771 ] 

James Peach commented on TS-2783:
---------------------------------

Does the {{compare_RecordsConfigcc.py}} script do most of what you want?

{code}
oarfish:trafficserver.git jpeach$ python contrib/python/compare_RecordsConfigcc.py .
# Comparing RecordsConfig.cc -> records.config.default.in
...

Undocumented configuration variables:
...

Incorrectly documented defaults:
...

Stale documentation:
...
{code}

> Automated verification of defaults (config vs. code)
> ----------------------------------------------------
>
>                 Key: TS-2783
>                 URL: https://issues.apache.org/jira/browse/TS-2783
>             Project: Traffic Server
>          Issue Type: Improvement
>          Components: Configuration, Documentation
>            Reporter: Piotr BuliƄski
>
> There are cases where documentation states different defaults than they are actually used in code. I will work on some automated mechanism verifying that, so we can keep easily code and docs in sync with each release.
> Additionally it should show:
>  - missing configuration parameters in docs,
>  - unused configuration parameters in code.



--
This message was sent by Atlassian JIRA
(v6.2#6252)