diff --git a/commands/make/EXAMPLE.make b/commands/make/EXAMPLE.make deleted file mode 100644 index ae0cb06..0000000 --- a/commands/make/EXAMPLE.make +++ /dev/null @@ -1,96 +0,0 @@ -; Example makefile -; ---------------- -; This is an example makefile to introduce new users of drush_make to the -; syntax and options available to drush_make. For a full description of all -; options available, see README.txt. - -; This make file is a working makefile - try it! Any line starting with a `;` -; is a comment. - -; Core version -; ------------ -; Each makefile should begin by declaring the core version of Drupal that all -; projects should be compatible with. - -core = 7.x - -; API version -; ------------ -; Every makefile needs to declare it's Drush Make API version. This version of -; drush make uses API version `2`. - -api = 2 - -; Core project -; ------------ -; In order for your makefile to generate a full Drupal site, you must include -; a core project. This is usually Drupal core, but you can also specify -; alternative core projects like Pressflow. Note that makefiles included with -; install profiles *should not* include a core project. - -; Use Pressflow instead of Drupal core: -; projects[pressflow][type] = "core" -; projects[pressflow][download][type] = "file" -; projects[pressflow][download][url] = "http://launchpad.net/pressflow/6.x/6.15.73/+download/pressflow-6.15.73.tar.gz" - -; Git clone of Drupal 7.x. Requires the `core` property to be set to 7.x. -; projects[drupal][type] = "core" -; projects[drupal][download][type] = git -; projects[drupal][download][url] = http://git.drupal.org/project/drupal.git - -projects[] = drupal - -; Projects -; -------- -; Each project that you would like to include in the makefile should be -; declared under the `projects` key. The simplest declaration of a project -; looks like this: - -; To include the most recent views module: - -projects[] = views - -; This will, by default, retrieve the latest recommended version of the project -; using its update XML feed on Drupal.org. If any of those defaults are not -; desirable for a project, you will want to use the keyed syntax combined with -; some options. - -; If you want to retrieve a specific version of a project: - -; projects[views] = 2.16 - -; Or an alternative, extended syntax: - -projects[ctools][version] = 1.3 - -; Check out the latest version of a project from Git. Note that when using a -; repository as your project source, you must explictly declare the project -; type so that drush_make knows where to put your project. - -projects[data][type] = module -projects[data][download][type] = git -projects[data][download][url] = http://git.drupal.org/project/views.git -projects[data][download][revision] = DRUPAL-6--3 - -; For projects on drupal.org, some shorthand is available. If any -; download parameters are specified, but not type, the default is git. -projects[cck_signup][download][revision] = "2fe932c" - -; Specifying 'revision' in the top level is shorthand for download revision. -projects[context_admin][revision] = "eb9f05e" - -; Clone a project from github. - -projects[tao][type] = theme -projects[tao][download][type] = git -projects[tao][download][url] = git://github.com/developmentseed/tao.git - -; If you want to install a module into a sub-directory, you can use the -; `subdir` attribute. - -projects[admin_menu][subdir] = custom - -; To apply a patch to a project, use the `patch` attribute and pass in the URL -; of the patch. - -projects[admin_menu][patch][] = "http://drupal.org/files/issues/admin_menu.long_.31.patch" diff --git a/commands/make/README.txt b/commands/make/README.txt deleted file mode 100644 index 157ef6f..0000000 --- a/commands/make/README.txt +++ /dev/null @@ -1,397 +0,0 @@ - -Drush make ----------- -Drush make is an extension to drush that can create a ready-to-use drupal site, -pulling sources from various locations. It does this by parsing a flat text file -(similar to a drupal `.info` file) and downloading the sources it describes. In -practical terms, this means that it is possible to distribute a complicated -Drupal distribution as a single text file. - -Among drush make's capabilities are: - -- Downloading Drupal core, as well as contrib modules from drupal.org. -- Checking code out from SVN, git, and bzr repositories. -- Getting plain `.tar.gz` and `.zip` files (particularly useful for libraries - that can not be distributed directly with drupal core or modules). -- Fetching and applying patches. -- Fetching modules, themes, and installation profiles, but also external - libraries. - - -Usage ------ -The `drush make` command can be executed from a path within a Drupal codebase or -independent of any Drupal sites entirely. See the examples below for instances -where `drush make` can be used within an existing Drupal site. - - drush make [-options] [filename.make] [build path] - -The `.make` file format ------------------------ -Each makefile is a plain text file that adheres to the Drupal `.info` file -syntax. See the included `example.make` for an example of a working makefile. - - -### Core version - -The make file always begins by specifying the core version of Drupal for which - each package must be compatible. Example: - - core = 6.x - - -### API version - -The make file must specify which Drush Make API version it uses. This version -of Drush Make uses API version `2` - - api = 2 - - -### Projects - -An array of the projects (e.g. modules, themes, libraries, and drupal) to be -retrieved. Each project name can be specified as a single string value. If -further options need to be provided for a project, the project should be -specified as the key. - -**Project with no further options:** - - projects[] = drupal - -**Project using options (see below):** - - projects[drupal][version] = 7.12 - -Do not use both types of declarations for a single project in your makefile. - - -### Project options - -- `version` - - Specifies the version of the project to retrieve. - This can be as loose as the major branch number or - as specific as a particular point release. - - projects[views][version] = 3 - projects[views][version] = 2.8 - projects[views][version] = 3.0-alpha2 - - ; Shorthand syntax for versions if no other options are to be specified - projects[views] = 3.0-alpha2 - -- `patch` - - One or more patches to apply to this project. An array of URLs from which - each patch should be retrieved. - - projects[calendar][patch][rfc-fixes][url] = "http://drupal.org/files/issues/cal-760316-rfc-fixes-2.diff" - projects[calendar][patch][rfc-fixes][md5] = "e4876228f449cb0c37ffa0f2142" - - ; shorthand syntax if no md5 checksum is specified - projects[adminrole][patch][] = "http://drupal.org/files/issues/adminrole_exceptions.patch" - -- `subdir` - - Place a project within a subdirectory of the `--contrib-destination` - specified. In the example below, `cck` will be placed in - `sites/all/modules/contrib` instead of the default `sites/all/modules`. - - projects[cck][subdir] = "contrib" - -- `location` - - URL of an alternate project update XML server to use. Allows project XML data - to be retrieved from sites other than `updates.drupal.org`. - - projects[tao][location] = "http://code.developmentseed.com/fserver" - -- `type` - - The project type. Must be provided if an update XML source is not specified - and/or using version control or direct retrieval for a project. May be one of - the following values: core, module, profile, theme. - - projects[mytheme][type] = "theme" - -- `directory_name` - - Provide an alternative directory name for this project. By default, the - project name is used. - - projects[mytheme][directory_name] = "yourtheme" - -- `l10n_path` - - Specific URL (can include tokens) to a translation. Allows translations to be - retrieved from l10n servers other than `localize.drupal.org`. - - projects[mytheme][l10n_path] = "http://myl10nserver.com/files/translations/%project-%core-%version-%language.po" - -- `l10n_url` - - URL to an l10n server XML info file. Allows translations to be retrieved from - l10n servers other than `localize.drupal.org`. - - projects[mytheme][l10n_url] = "http://myl10nserver.com/l10n_server.xml" - -- `overwrite` - - Allows the project to be installed in a directory that is not empty. - If not specified this is treated as FALSE, drush_make sets an error when the directory is not empty. - If specified TRUE, drush_make will continue and use the existing directory. - Useful when adding extra files and folders to existing folders in libraries or module extensions. - - projects[myproject][overwrite] = TRUE - -- `translations` - - Retrieve translations for the specified language, if available, for all projects. - - translations[] = es - - -### Project download options - - Use an alternative download method instead of retrieval through update XML. - - If no download type is specified, make defaults the type to - `git`. Additionally, if no url is specified, make defaults to use - Drupal.org. - - The following methods are available: - -- `download[type] = file` - - Retrieve a project as a direct download. Options: - - `url` - the URL of the file. Required. - - `md5`, `sha1`, `sha256`, or `sha512` - one or more checksums for the file. Optional. - - `request_type` - the request type - get or post. post depends on - http://drupal.org/project/make_post. Optional. - - `data` - The post data to be submitted with the request. Should be a - valid URL query string. Requires http://drupal.org/project/make_post. Optional. - - `filename` - What to name the file, if it's not an archive. Optional. - - `subtree` - if the download is an archive, only this subtree within the - archive will be copied to the target destination. Optional. - -- `download[type] = bzr` - - Use a bazaar repository as the source for this project. Options: - - `url` - the URL of the repository. Required. - -- `download[type] = git` - - Use a git repository as the source for this project. Options: - - `url` - the URL of the repository. Required. - - `branch` - the branch to be checked out. Optional. - - `revision` - a specific revision identified by commit to check out. Optional. - - `tag` - the tag to be checked out. Optional. - - projects[mytheme][download][type] = "git" - projects[mytheme][download][url] = "git://github.com/jane_doe/mytheme.git" - - Shorthand is available to pull a specific revision from a git - repository: - - projects[context_admin][revision] = "eb9f05e" - - is the same as: - - projects[context_admin][download][revision] = "eb9f05e" - - `refspec` - the git reference to fetch and checkout. Optional. - - If this is set, it will have priority over tag, revision and branch options. - -- `download[type] = svn` - - Use an SVN repository as the source for this project. Options: - - `url` - the URL of the repository. Required. - - `interactive` - whether to prompt the user for authentication credentials - when using a private repository. Allows username and/or password options to - be omitted. Optional. - - `username` - the username to use when retrieving an SVN project as a working - copy or from a private repository. Optional. - - `password` - the password to use when retrieving an SVN project as a working - copy or from a private repository. Optional. - - projects[mytheme][download][type] = "svn" - projects[mytheme][download][url] = "http://example.com/svnrepo/cool-theme/" - - -### Libraries - -An array of non-Drupal-specific libraries to be retrieved (e.g. js, PHP or other -Drupal-agnostic components). Each library should be specified as the key of an -array of options in the libraries array. - -**Example:** - - libraries[jquery_ui][download][type] = "file" - libraries[jquery_ui][download][url] = "http://jquery- ui.googlecode.com/files/jquery.ui-1.6.zip" - libraries[jquery_ui][download][md5] = "c177d38bc7af59d696b2efd7dda5c605" - - -### Library options - -Libraries share the `download`, `subdir`, and `directory_name` options with -projects. Additionally, they may specify a destination: - -- `destination` - - The target path to which this library should be moved. The path is relative to - that specified by the `--contrib-destination` option. By default, libraries - are placed in the `libraries` directory. - - libraries[jquery_ui][destination] = "modules/contrib/jquery_ui - - -### Includes - -An array of makefiles to include. Each include may be a local relative path -to the includer makefile directory or a direct URL to the makefile. Includes -are appended in order with the source makefile appended last, allowing latter -makefiles to override the keys/values of former makefiles. - -**Example:** - - includes[example] = "example.make" - includes[example_relative] = "../example_relative/example_relative.make" - includes[remote] = "http://www.example.com/remote.make" - - -### Overriding properties - -Makefiles which include others may override the included makefiles properties. -Properties in the includer takes precedence over the includee. - -**Example:** - -`base.make` - - core = "6.x" - projects[views][subdir] = "contrib" - projects[cck][subdir] = "contrib" - -`extender.make` - - includes[base] = "base.make" - - ; This line overrides the included makefile's 'subdir' option - projects[views][subdir] = "patched" - - ; This line overrides the included makefile, switching the download type - ; to a git clone - projects[views][type] = "module" - projects[views][download][type] = "git" - projects[views][download][url] = "http://git.drupal.org/project/views.git" - -A project or library entry of an included makefile can be removed entirely by -setting the corresponding key to FALSE: - - ; This line removes CCK entirely which was defined in base.make - projects[cck] = FALSE - - -Recursion ---------- -If a project that is part of a build contains a `.make` itself, drush make will -automatically parse it and recurse into a derivative build. - -For example, a full build tree may look something like this: - - drush make distro.make distro - - distro.make FOUND - - Drupal core - - Foo bar install profile - + foobar.make FOUND - - CCK - - Token - - Module x - + x.make FOUND - - External library x.js - - Views - - etc. - -Recursion can be used to nest an install profile build in a Drupal site, easily -build multiple install profiles on the same site, fetch library dependencies -for a given module, or bundle a set of module and its dependencies together. -For Drush Make to recognize a makefile embedded within a project, the makefile -itself must have the same name as the project. For instance, the makefile -embedded within the managingnews profile must be called "managingnews.make". - -**Build a full Drupal site with the Managing News install profile:** - - core = 6.x - projects[] = drupal - projects[] = managingnews - -Testing -------- -Drush make also comes with testing capabilities, designed to test drush make -itself. Writing a new test is extremely simple. The process is as follows: - -1. Figure out what you want to test. Write a makefile that will test - this out. You can refer to existing test makefiles for - examples. These are located in `DRUSH/tests/makefiles`. -2. Drush make your makefile, and use the --md5 option. You may also use other - options, but be sure to take note of which ones for step 4. -3. Verify that the result you got was in fact what you expected. If so, - continue. If not, tweak it and re-run step 2 until it's what you expected. -4. Using the md5 hash that was spit out from step 2, make a new entry in the - tests clase (DRUSH/tests/makeTest.php), following the example below. - 'machine-readable-name' => array( - 'name' => 'Human readable name', - 'makefile' => 'tests/yourtest.make', - 'messages' => array( - 'Build hash: f68e6510-your-hash-e04fbb4ed', - ), - 'options' => array('any' => TRUE, 'other' => TRUE, 'options' => TRUE), - ), -5. Test! Run drush test suite (see DRUSH/tests/README.txt). To just - run the make tests: - - `phpunit --filter=makeMake .` - - -You can check for any messages you want in the message array, but the most -basic tests would just check the build hash. - -Generate --------- - -Drush make has a primitive makefile generation capability. To use it, simply -change your directory to the Drupal installation from which you would like to -generate the file, and run the following command: - -`drush generate-makefile /path/to/make-file.make` - -This will generate a basic makefile. If you have code from other repositories, -the makefile will not complete - you'll have to fill in some information before -it is fully functional. - -Maintainers ------------ -- Jonathan Hedstrom (jhedstrom) -- The rest of the Drush maintainers - -Original Author ---------------- -Dmitri Gaskin (dmitrig01) diff --git a/commands/make/make.drush.inc b/commands/make/make.drush.inc index 7ddc41b..e821daf 100644 --- a/commands/make/make.drush.inc +++ b/commands/make/make.drush.inc @@ -131,7 +131,7 @@ function make_drush_command() { function make_drush_help($section) { switch ($section) { case 'drush:make': - return 'Turns a makefile into a Drupal codebase. For a full description of options and makefile syntax, see the README.txt included with drush make.'; + return 'Turns a makefile into a Drupal codebase. For a full description of options and makefile syntax, see docs/make.txt and examples/example.make.'; case 'drush:make-generate': return 'Generate a makefile from the current Drupal site, specifying project version numbers unless not known or otherwise specified. Unversioned projects will be interpreted later by drush make as "most recent stable release"'; }