In the latest Drush HEAD, the `drush help make` command outputs the following on the first two lines of the console:
Turns a makefile into a Drupal codebase. For a full description of options and
makefile syntax, see the README.txt included with drush make.
This is confusing, considering Drush Make is now part of Drush and there is no obvious standalone documentation for Drush Make in the Drush installation directory.
If the user is thorough, they will notice the help topics listed at the bottom of the output from `drush help make`, indicating a "docs-make" and "docs-make-example" help topic. These should be more prominent and should likely be mentioned instead of the "README.txt included with drush make" at the top of the help output.
Comment | File | Size | Author |
---|---|---|---|
#1 | drush_make_doc-1538412.patch | 17.66 KB | FluxSauce |
#2 | drush_make_doc-v2-1538412.patch | 35.6 KB | FluxSauce |
Comments
Comment #1
FluxSauce CreditAttribution: FluxSauce commentedBoth README.txt and EXAMPLE.make do exist, but they're actually in commands/make. With that said, it's not logical to keep them anymore.
I moved the
README.txt
todocs/make.txt
,EXAMPLE.make
toexamples/example.make
, and updated thedrush help make
command to reflect the new locations.EDIT - Left out the recreation of the files and missed a command reference to the new files, do not use this version of the patch.
Comment #2
FluxSauce CreditAttribution: FluxSauce commentedUpdated version; the patch was missing the recreation of the files, and did not include an update to docs-make and docs-make-example. Sorry about that.
Comment #3
moshe weitzman CreditAttribution: moshe weitzman commentedIMO this makes sense. I'll let jhedstrom make the final call.
Comment #4
jhedstromI committed a slightly different version (using git mv on those files to retain history). Thanks!