[
https://issues.apache.org/jira/browse/TRAFODION-2380?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15723714#comment-15723714
]
ASF GitHub Bot commented on TRAFODION-2380:
-------------------------------------------
GitHub user DaveBirdsall opened a pull request:
https://github.com/apache/incubator-trafodion/pull/866
[TRAFODION-2380] New script to help automate Message Guide updating work
This new script is designed to help automate development work on the
Messages Guide. In its initial guise, the script does the following:
1. Compares the text in SqlciErrors.txt with that in the Messages Guide
2. Produces a report of mismatched messages. For each mismatched message it
shows:
a. The message text in each of SqlciErrors.txt and the Messages Guide
b. Any enums used in the code to refer to the message number
c. A list of regress tests whose expected files might have examples of the
message
d. Optionally, a list of all C++ source files with possible references to
the message number (this option is very slow unfortunately)
With this information a developer can quickly identify what messages in the
Message Guide are out-of-date or missing. If the developer decides to change
the text in SqlciErrors.txt, he/she can also see what regression test expected
files need to be updated. If option d is specified (--codeRefs), the developer
will also have a list of files in the code where the message is generated. But
this option presently takes six or seven hours to run and so is best done
overnight.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/DaveBirdsall/incubator-trafodion Trafodion2380
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/incubator-trafodion/pull/866.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #866
----
----
> Create script to automate Messages Guide consistency checking
> -------------------------------------------------------------
>
> Key: TRAFODION-2380
> URL: https://issues.apache.org/jira/browse/TRAFODION-2380
> Project: Apache Trafodion
> Issue Type: Sub-task
> Components: elopment-tools
> Affects Versions: 2.1-incubating
> Environment: Development environments
> Reporter: David Wayne Birdsall
> Assignee: David Wayne Birdsall
>
> Create a tool to automate consistency checking of the Messages Guide against
> the code base. This will be a simple Python script that a developer can run
> in their workspace. The result is a report detailing the following:
> 1. Messages where the text in the Messages Guide differs from the code.
> 2. Messages in the Message Guide that are no longer used in the code.
> 3. Messages in the code that are not documented in the Messages Guide.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
