MapGuide RFC 1 - Commandline Parameter Changes

From OSGeo
Jump to navigation Jump to search
This page contains an change request (RFC) for MapGuide Open Source.  
More MapGuide RFCs can be found on the MapGuide RFCs page.

Status

  • Proposal Date: 19:18, 31 October 2006 (CET)
  • Last Modified Date: 21:50, 1 November 2006 (CET)
  • Author: Bruce Dechant Brucedechant
  • Status: Pending vote
  • Implementation Status: Pending
  • Voting History:
  • Assigned PSC guide(s):

Overview

Make the following MapGuide server commandline parameter changes:

  1. Remove the need for the "/" character before the parameter name, but retain support for the "/" for backwards compatibility.
  2. Change the "testmode" parameter to "test", but retain support for the "testmode" for backwards compatibility.
  3. Remove the "/t" parameter from the renamed "testmode" parameter.
  4. Change the "interactive" parameter to "run", but retain support for "interactive" for backwards compatibility.
  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 name which is not really needed

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

The commandline help will show the updated parameter names without the "/" character. However, the old parameter names with the "/" character will still work.

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.