Difference between revisions of "MapGuide RFC 1 - Commandline Parameter Changes"

From OSGeo
Jump to navigation Jump to search
Line 1: Line 1:
 +
===Status===
 +
*Proposal Date: 19:18, 31 October 2006 (CET)
 +
*Last Modified Date: 21:24, 31 October 2006 (CET)
 +
*Author: Bruce Dechant [[User:Brucedechant|Brucedechant]]
 +
*Status: Pending vote
 +
*Implementation Status: Pending
 +
*Voting History:
 +
 
===Overview===
 
===Overview===
  
 
Make the following MapGuide server commandline parameter changes:
 
Make the following MapGuide server commandline parameter changes:
−
 
+
# Change the "/" character before the parameter to a "-".
−
1) Change the "/" character before the parameter to a "-".
+
# Change the "testmode" parameter to "test"
−
 
+
# Remove the "/t" parameter from the renamed "testmode" parameter.
−
2) Change the "testmode" parameter to "test"
+
# Change the "interactive" parameter to "run".  
−
 
+
# Remove the need for adding the "Test" word in front of all specific unit test names. ie: CoordinateSystem instead of TestCoordinateSystem
−
3) Remove the "/t" parameter from the renamed "testmode" parameter.
 
−
 
 
−
4) Change the "interactive" parameter to "run".  
 
−
 
 
−
5) Remove the need for adding the "Test" word in front of all specific unit test names. ie: CoordinateSystem instead of TestCoordinateSystem
 
  
 
===Motivation===
 
===Motivation===
Line 31: Line 34:
 
====Technical====
 
====Technical====
  
−
The following files will be affects:
+
The following files will be affected:
−
Resources.cpp
+
*Resources.cpp
−
Resources.h
+
*Resources.h
−
main.cpp
+
*main.cpp
−
Server.cpp
+
*Server.cpp
−
UnitTesting.cpp
+
*UnitTesting.cpp
  
 
===Implications===
 
===Implications===
Line 44: Line 47:
 
===Test Plan===
 
===Test Plan===
  
−
Test that the existing and renamed commandline parameters work as expected.
+
*Test that the existing and renamed commandline parameters work as expected.
−
 
+
*Test both the correct and incorrect spellings of commandline parameters.
−
Test both the correct and incorrect spellings of commandline parameters.
+
*Test both valid and invalid specific unit test names to verify the removal of the "/t" parameter works.
−
 
 
−
Test both valid and invalid specific unit test names to verify the removal of the "/t" parameter works.
 
−
 
 
−
 
 
−
--[[User:Brucedechant|Brucedechant]] 19:18, 31 October 2006 (CET)
 

Revision as of 13:24, 31 October 2006

Status

  • Proposal Date: 19:18, 31 October 2006 (CET)
  • Last Modified Date: 21:24, 31 October 2006 (CET)
  • Author: Bruce Dechant Brucedechant
  • Status: Pending vote
  • Implementation Status: Pending
  • Voting History:

Overview

Make the following MapGuide server commandline parameter changes:

  1. Change the "/" character before the parameter to a "-".
  2. Change the "testmode" parameter to "test"
  3. Remove the "/t" parameter from the renamed "testmode" parameter.
  4. Change the "interactive" parameter to "run".
  5. Remove the need for adding the "Test" word in front of all specific unit test names. ie: CoordinateSystem instead of TestCoordinateSystem

Motivation

The current commandline parameters for the MapGuide server require the "/" character before the parameter. This is more Windows centric and is actually the same as the Linux path separator character.

The "testmode" and "interactive" parameter name changes and removal of the "Test" word for specific unit test names are really just changes for shortening the name for easier entry by the user.

The removal of the "/t" extra parameter for the renamed "testmode" ("test") parameter is recommended because it is really not needed. The user can simply specify what specific unit test they want to run without needing the "/t".

Funding/Resources

Bruce Dechant will be the resource to implement the changes outlined in this RFC.

Proposed Changes

The code and string resouces related to the commandline parameters of the server will be modified to work with the proposed changes.

Technical

The following files will be affected:

  • Resources.cpp
  • Resources.h
  • main.cpp
  • Server.cpp
  • UnitTesting.cpp

Implications

Users will need to be aware that the existing commandline parameters have changed, especially the "/interactive" commandline parameter change to "-run".

Test Plan

  • Test that the existing and renamed commandline parameters work as expected.
  • Test both the correct and incorrect spellings of commandline parameters.
  • Test both valid and invalid specific unit test names to verify the removal of the "/t" parameter works.
Retrieved from "http://wiki.osgeo.org/w/index.php?title=MapGuide_RFC_1_-_Commandline_Parameter_Changes&oldid=9108"