GSoC/GCI Archive
Google Code-in 2010 Parrot Foundation and The Perl Foundation

Rename public functions in src/key.c

completed by: Kristaba

mentors: whiteknight

Task Description: The parrot project has a series of coding standards that its source code is supposed to follow. One of these standards involves the naming conventions of functions in individual subsystems. For example, all functions dealing with PMC objects are named Parrot_pmc_*, and all functions dealing with Object-Oriented features are named Parrot_oo_*.

For this task, all public (non-static) functions in src/key.c need to be renamed to "Parrot_key_*".

Steps: To complete this task, you should:

  1. Create a fork of the parrot/parrot.git repository on github.
  2. Perform all the necessary code changes
  3. Run 'make headerizer' for header files to be updated with your new names
  4. Build parrot and run it's test suite with "make test" to verify that things still work
  5. Create a "pull request" on parrot/parrot.git to have your changed incorporated into the master repository

Benefits: Following standards is extremely important to ensure that multiple developers can work together on a single project without using different styles of code in a confusing way. Keeping functions named according to subsystem makes it easier to find the implementation of the function and deduce from it's name what it's behaviors are.

Requirements: Knowledge of programming. Knowledge of C or C-like languages a plus. Ability to build and test Parrot.