You are here

Home » API reference » Coder 7

README.txt in Coder 7

Same filename in this branch
  1. 7 README.txt
  2. 7 coder_upgrade/README.txt
  3. 7 scripts/coder_format/README.txt
  4. 7 scripts/coder_format/tests/README.txt
Same filename and directory in other branches
  1. 7.2 coder_upgrade/README.txt
CONTENTS OF THIS FILE
---------------------

 * Author
 * Description
 * Installation
 * Dependencies
 * Developers

AUTHOR
------
Jim Berry ("solotandem", http://drupal.org/user/240748)

DESCRIPTION
-----------
This module provides upgrade routines to modify a source code file for changes
to the Drupal core APIs. Currently, the module provides routines for an upgrade
from Drupal 6 to 7.

This module utilizes the Grammar Parser library to modify source code in a
precise and programmatic fashion. The module utilizes the familiar Drupal hook
system to invoke upgrade routines, allowing other modules to enhance or modify
a routine.

Contributed modules that define an API can develop upgrade routines that would
enable other contributed modules relying on that API to upgrade their code.

INSTALLATION
------------
To use this module, install it in a modules directory. See
http://drupal.org/node/895232 for further information.

The included Drush Make file provides a convenient method of downloading and
installing the correct version of the Grammar Parser Library (>=1) dependency.
This project has a short name of "grammar_parser_lib" while the module name is
"gplib." The latter name is included in the .info file. From a command line,
simply invoke:

  drush make coder_upgrade.make

DEPENDENCIES
------------
While the Grammar Parser Library is the only dependency for this module, the
latter has two dependencies: the Libraries API module and the Grammar Parser
"library." All of these dependencies may be easily downloaded and installed
using the Drush Make file included with this project. Otherwise please refer to
the README files of those projects for installation instructions.

DEVELOPERS
----------
In the event of issues with the upgrade routines, debug output may be enabled on
the settings page of this module. It is recommended to enable this only with
smaller files that include the code causing an issue.

File

coder_upgrade/README.txt
View source 
  1. 

  2. CONTENTS OF THIS FILE

  3. ---------------------

  4. 

  5.  * Author

  6.  * Description

  7.  * Installation

  8.  * Dependencies

  9.  * Developers

  10. 

  11. AUTHOR

  12. ------

  13. Jim Berry ("solotandem", http://drupal.org/user/240748)

  14. 

  15. DESCRIPTION

  16. -----------

  17. This module provides upgrade routines to modify a source code file for changes

  18. to the Drupal core APIs. Currently, the module provides routines for an upgrade

  19. from Drupal 6 to 7.

  20. 

  21. This module utilizes the Grammar Parser library to modify source code in a

  22. precise and programmatic fashion. The module utilizes the familiar Drupal hook

  23. system to invoke upgrade routines, allowing other modules to enhance or modify

  24. a routine.

  25. 

  26. Contributed modules that define an API can develop upgrade routines that would

  27. enable other contributed modules relying on that API to upgrade their code.

  28. 

  29. INSTALLATION

  30. ------------

  31. To use this module, install it in a modules directory. See

  32. http://drupal.org/node/895232 for further information.

  33. 

  34. The included Drush Make file provides a convenient method of downloading and

  35. installing the correct version of the Grammar Parser Library (>=1) dependency.

  36. This project has a short name of "grammar_parser_lib" while the module name is

  37. "gplib." The latter name is included in the .info file. From a command line,

  38. simply invoke:

  39. 

  40.   drush make coder_upgrade.make

  41. 

  42. DEPENDENCIES

  43. ------------

  44. While the Grammar Parser Library is the only dependency for this module, the

  45. latter has two dependencies: the Libraries API module and the Grammar Parser

  46. "library." All of these dependencies may be easily downloaded and installed

  47. using the Drush Make file included with this project. Otherwise please refer to

  48. the README files of those projects for installation instructions.

  49. 

  50. DEVELOPERS

  51. ----------

  52. In the event of issues with the upgrade routines, debug output may be enabled on

  53. the settings page of this module. It is recommended to enable this only with

  54. smaller files that include the code causing an issue.