README.txt

Same filename in this branch
  1. 11.x sites/README.txt
  2. 11.x composer/Template/README.txt
  3. 11.x composer/Plugin/VendorHardening/README.txt
  4. 11.x profiles/README.txt
  5. 11.x themes/README.txt
  6. 11.x modules/README.txt
  7. 11.x core/profiles/demo_umami/themes/umami/README.txt
  8. 11.x core/profiles/demo_umami/themes/umami/images/classy/README.txt
  9. 11.x core/profiles/demo_umami/themes/umami/css/classy/README.txt
  10. 11.x core/profiles/demo_umami/themes/umami/js/classy/README.txt
  11. 11.x core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  12. 11.x core/themes/stable9/README.txt
  13. 11.x core/themes/claro/images/classy/README.txt
  14. 11.x core/themes/claro/css/classy/README.txt
  15. 11.x core/themes/claro/js/classy/README.txt
  16. 11.x core/themes/claro/templates/classy/README.txt
  17. 11.x core/themes/stark/README.txt
  18. 11.x core/modules/sdc/README.txt
  19. 11.x core/modules/system/tests/src/Functional/UpdateSystem/README.txt
  20. 11.x core/modules/system/tests/src/Functional/Update/README.txt
  21. 11.x core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  22. 11.x core/tests/fixtures/files/README.txt
  23. 11.x core/assets/scaffold/README.txt
  24. 11.x core/assets/vendor/tabbable/README.txt
  25. 11.x core/lib/Drupal/Core/README.txt
  26. 11.x core/lib/Drupal/Component/Render/README.txt
  27. 11.x core/lib/Drupal/Component/Assertion/README.txt
  28. 11.x core/lib/Drupal/Component/Discovery/README.txt
  29. 11.x core/lib/Drupal/Component/FileSecurity/README.txt
  30. 11.x core/lib/Drupal/Component/FileCache/README.txt
  31. 11.x core/lib/Drupal/Component/Utility/README.txt
  32. 11.x core/lib/Drupal/Component/README.txt
  33. 11.x core/lib/Drupal/Component/Graph/README.txt
  34. 11.x core/lib/Drupal/Component/DependencyInjection/README.txt
  35. 11.x core/lib/Drupal/Component/FrontMatter/README.txt
  36. 11.x core/lib/Drupal/Component/Version/README.txt
  37. 11.x core/lib/Drupal/Component/Serialization/README.txt
  38. 11.x core/lib/Drupal/Component/ClassFinder/README.txt
  39. 11.x core/lib/Drupal/Component/ProxyBuilder/README.txt
  40. 11.x core/lib/Drupal/Component/EventDispatcher/README.txt
  41. 11.x core/lib/Drupal/Component/Diff/README.txt
  42. 11.x core/lib/Drupal/Component/FileSystem/README.txt
  43. 11.x core/lib/Drupal/Component/Gettext/README.txt
  44. 11.x core/lib/Drupal/Component/PhpStorage/README.txt
  45. 11.x core/lib/Drupal/Component/Datetime/README.txt
  46. 11.x core/lib/Drupal/Component/Transliteration/README.txt
  47. 11.x core/lib/Drupal/Component/Annotation/README.txt
  48. 11.x core/lib/Drupal/Component/HttpFoundation/README.txt
  49. 11.x core/lib/Drupal/Component/Uuid/README.txt
  50. 11.x core/lib/Drupal/Component/Plugin/README.txt
  51. 11.x core/lib/README.txt
Same filename in other branches
  1. 7.x sites/README.txt
  2. 7.x sites/all/themes/README.txt
  3. 7.x sites/all/modules/README.txt
  4. 7.x sites/all/libraries/README.txt
  5. 7.x profiles/README.txt
  6. 7.x profiles/standard/translations/README.txt
  7. 7.x profiles/minimal/translations/README.txt
  8. 7.x README.txt
  9. 7.x themes/README.txt
  10. 7.x themes/stark/README.txt
  11. 7.x modules/README.txt
  12. 7.x modules/simpletest/files/README.txt
  13. 9 sites/README.txt
  14. 9 composer/Template/README.txt
  15. 9 composer/Metapackage/README.txt
  16. 9 composer/Plugin/VendorHardening/README.txt
  17. 9 profiles/README.txt
  18. 9 themes/README.txt
  19. 9 modules/README.txt
  20. 9 core/profiles/demo_umami/themes/umami/README.txt
  21. 9 core/profiles/demo_umami/themes/umami/images/classy/README.txt
  22. 9 core/profiles/demo_umami/themes/umami/css/classy/README.txt
  23. 9 core/profiles/demo_umami/themes/umami/js/classy/README.txt
  24. 9 core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  25. 9 core/themes/stable9/README.txt
  26. 9 core/themes/stable9/images/README.txt
  27. 9 core/themes/seven/README.txt
  28. 9 core/themes/seven/images/classy/README.txt
  29. 9 core/themes/seven/css/classy/README.txt
  30. 9 core/themes/seven/js/classy/README.txt
  31. 9 core/themes/seven/templates/classy/README.txt
  32. 9 core/themes/claro/images/classy/README.txt
  33. 9 core/themes/claro/css/classy/README.txt
  34. 9 core/themes/claro/js/classy/README.txt
  35. 9 core/themes/claro/templates/classy/README.txt
  36. 9 core/themes/stark/README.txt
  37. 9 core/themes/bartik/README.txt
  38. 9 core/themes/bartik/images/classy/README.txt
  39. 9 core/themes/bartik/css/classy/README.txt
  40. 9 core/themes/bartik/js/classy/README.txt
  41. 9 core/themes/bartik/templates/classy/README.txt
  42. 9 core/themes/stable/README.txt
  43. 9 core/themes/classy/README.txt
  44. 9 core/modules/system/tests/src/Functional/UpdateSystem/README.txt
  45. 9 core/modules/system/tests/src/Functional/Update/README.txt
  46. 9 core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  47. 9 core/tests/fixtures/files/README.txt
  48. 9 core/assets/scaffold/README.txt
  49. 9 core/assets/vendor/tabbable/README.txt
  50. 9 core/lib/Drupal/Core/README.txt
  51. 9 core/lib/Drupal/Component/Render/README.txt
  52. 9 core/lib/Drupal/Component/Assertion/README.txt
  53. 9 core/lib/Drupal/Component/Discovery/README.txt
  54. 9 core/lib/Drupal/Component/FileSecurity/README.txt
  55. 9 core/lib/Drupal/Component/FileCache/README.txt
  56. 9 core/lib/Drupal/Component/Utility/README.txt
  57. 9 core/lib/Drupal/Component/README.txt
  58. 9 core/lib/Drupal/Component/Graph/README.txt
  59. 9 core/lib/Drupal/Component/DependencyInjection/README.txt
  60. 9 core/lib/Drupal/Component/FrontMatter/README.txt
  61. 9 core/lib/Drupal/Component/Version/README.txt
  62. 9 core/lib/Drupal/Component/Serialization/README.txt
  63. 9 core/lib/Drupal/Component/ClassFinder/README.txt
  64. 9 core/lib/Drupal/Component/ProxyBuilder/README.txt
  65. 9 core/lib/Drupal/Component/EventDispatcher/README.txt
  66. 9 core/lib/Drupal/Component/Diff/README.txt
  67. 9 core/lib/Drupal/Component/FileSystem/README.txt
  68. 9 core/lib/Drupal/Component/Gettext/README.txt
  69. 9 core/lib/Drupal/Component/Bridge/README.txt
  70. 9 core/lib/Drupal/Component/PhpStorage/README.txt
  71. 9 core/lib/Drupal/Component/Datetime/README.txt
  72. 9 core/lib/Drupal/Component/Transliteration/README.txt
  73. 9 core/lib/Drupal/Component/Annotation/README.txt
  74. 9 core/lib/Drupal/Component/HttpFoundation/README.txt
  75. 9 core/lib/Drupal/Component/Uuid/README.txt
  76. 9 core/lib/Drupal/Component/Plugin/README.txt
  77. 9 core/lib/README.txt
  78. 8.9.x sites/README.txt
  79. 8.9.x composer/Template/README.txt
  80. 8.9.x composer/Metapackage/README.txt
  81. 8.9.x composer/Plugin/VendorHardening/README.txt
  82. 8.9.x profiles/README.txt
  83. 8.9.x README.txt
  84. 8.9.x themes/README.txt
  85. 8.9.x modules/README.txt
  86. 8.9.x core/profiles/demo_umami/themes/umami/README.txt
  87. 8.9.x core/profiles/demo_umami/themes/umami/images/classy/README.txt
  88. 8.9.x core/profiles/demo_umami/themes/umami/css/classy/README.txt
  89. 8.9.x core/profiles/demo_umami/themes/umami/js/classy/README.txt
  90. 8.9.x core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  91. 8.9.x core/themes/seven/README.txt
  92. 8.9.x core/themes/seven/images/classy/README.txt
  93. 8.9.x core/themes/seven/css/classy/README.txt
  94. 8.9.x core/themes/seven/js/classy/README.txt
  95. 8.9.x core/themes/seven/templates/classy/README.txt
  96. 8.9.x core/themes/claro/images/classy/README.txt
  97. 8.9.x core/themes/claro/css/classy/README.txt
  98. 8.9.x core/themes/claro/js/classy/README.txt
  99. 8.9.x core/themes/claro/templates/classy/README.txt
  100. 8.9.x core/themes/stark/README.txt
  101. 8.9.x core/themes/bartik/README.txt
  102. 8.9.x core/themes/bartik/images/classy/README.txt
  103. 8.9.x core/themes/bartik/css/classy/README.txt
  104. 8.9.x core/themes/bartik/js/classy/README.txt
  105. 8.9.x core/themes/bartik/templates/classy/README.txt
  106. 8.9.x core/themes/stable/README.txt
  107. 8.9.x core/themes/classy/README.txt
  108. 8.9.x core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  109. 8.9.x core/tests/fixtures/files/README.txt
  110. 8.9.x core/assets/scaffold/README.txt
  111. 8.9.x core/lib/Drupal/Core/README.txt
  112. 8.9.x core/lib/Drupal/Component/Render/README.txt
  113. 8.9.x core/lib/Drupal/Component/Assertion/README.txt
  114. 8.9.x core/lib/Drupal/Component/Discovery/README.txt
  115. 8.9.x core/lib/Drupal/Component/FileSecurity/README.txt
  116. 8.9.x core/lib/Drupal/Component/FileCache/README.txt
  117. 8.9.x core/lib/Drupal/Component/Utility/README.txt
  118. 8.9.x core/lib/Drupal/Component/README.txt
  119. 8.9.x core/lib/Drupal/Component/Graph/README.txt
  120. 8.9.x core/lib/Drupal/Component/DependencyInjection/README.txt
  121. 8.9.x core/lib/Drupal/Component/Version/README.txt
  122. 8.9.x core/lib/Drupal/Component/Serialization/README.txt
  123. 8.9.x core/lib/Drupal/Component/ClassFinder/README.txt
  124. 8.9.x core/lib/Drupal/Component/ProxyBuilder/README.txt
  125. 8.9.x core/lib/Drupal/Component/EventDispatcher/README.txt
  126. 8.9.x core/lib/Drupal/Component/Diff/README.txt
  127. 8.9.x core/lib/Drupal/Component/FileSystem/README.txt
  128. 8.9.x core/lib/Drupal/Component/Gettext/README.txt
  129. 8.9.x core/lib/Drupal/Component/Bridge/README.txt
  130. 8.9.x core/lib/Drupal/Component/PhpStorage/README.txt
  131. 8.9.x core/lib/Drupal/Component/Datetime/README.txt
  132. 8.9.x core/lib/Drupal/Component/Transliteration/README.txt
  133. 8.9.x core/lib/Drupal/Component/Annotation/README.txt
  134. 8.9.x core/lib/Drupal/Component/HttpFoundation/README.txt
  135. 8.9.x core/lib/Drupal/Component/Uuid/README.txt
  136. 8.9.x core/lib/Drupal/Component/Plugin/README.txt
  137. 8.9.x core/lib/README.txt
  138. 10 sites/README.txt
  139. 10 composer/Template/README.txt
  140. 10 composer/Metapackage/README.txt
  141. 10 composer/Plugin/VendorHardening/README.txt
  142. 10 profiles/README.txt
  143. 10 themes/README.txt
  144. 10 modules/README.txt
  145. 10 core/profiles/demo_umami/themes/umami/README.txt
  146. 10 core/profiles/demo_umami/themes/umami/images/classy/README.txt
  147. 10 core/profiles/demo_umami/themes/umami/css/classy/README.txt
  148. 10 core/profiles/demo_umami/themes/umami/js/classy/README.txt
  149. 10 core/profiles/demo_umami/themes/umami/templates/classy/README.txt
  150. 10 core/themes/stable9/README.txt
  151. 10 core/themes/claro/images/classy/README.txt
  152. 10 core/themes/claro/css/classy/README.txt
  153. 10 core/themes/claro/js/classy/README.txt
  154. 10 core/themes/claro/templates/classy/README.txt
  155. 10 core/themes/stark/README.txt
  156. 10 core/modules/sdc/README.txt
  157. 10 core/modules/system/tests/src/Functional/UpdateSystem/README.txt
  158. 10 core/modules/system/tests/src/Functional/Update/README.txt
  159. 10 core/modules/system/tests/modules/plugin_test/src/Plugin/plugin_test/fruit/README.txt
  160. 10 core/tests/fixtures/files/README.txt
  161. 10 core/assets/scaffold/README.txt
  162. 10 core/assets/vendor/tabbable/README.txt
  163. 10 core/lib/Drupal/Core/README.txt
  164. 10 core/lib/Drupal/Component/Render/README.txt
  165. 10 core/lib/Drupal/Component/Assertion/README.txt
  166. 10 core/lib/Drupal/Component/Discovery/README.txt
  167. 10 core/lib/Drupal/Component/FileSecurity/README.txt
  168. 10 core/lib/Drupal/Component/FileCache/README.txt
  169. 10 core/lib/Drupal/Component/Utility/README.txt
  170. 10 core/lib/Drupal/Component/README.txt
  171. 10 core/lib/Drupal/Component/Graph/README.txt
  172. 10 core/lib/Drupal/Component/DependencyInjection/README.txt
  173. 10 core/lib/Drupal/Component/FrontMatter/README.txt
  174. 10 core/lib/Drupal/Component/Version/README.txt
  175. 10 core/lib/Drupal/Component/Serialization/README.txt
  176. 10 core/lib/Drupal/Component/ClassFinder/README.txt
  177. 10 core/lib/Drupal/Component/ProxyBuilder/README.txt
  178. 10 core/lib/Drupal/Component/EventDispatcher/README.txt
  179. 10 core/lib/Drupal/Component/Diff/README.txt
  180. 10 core/lib/Drupal/Component/FileSystem/README.txt
  181. 10 core/lib/Drupal/Component/Gettext/README.txt
  182. 10 core/lib/Drupal/Component/PhpStorage/README.txt
  183. 10 core/lib/Drupal/Component/Datetime/README.txt
  184. 10 core/lib/Drupal/Component/Transliteration/README.txt
  185. 10 core/lib/Drupal/Component/Annotation/README.txt
  186. 10 core/lib/Drupal/Component/HttpFoundation/README.txt
  187. 10 core/lib/Drupal/Component/Uuid/README.txt
  188. 10 core/lib/Drupal/Component/Plugin/README.txt
  189. 10 core/lib/README.txt
# Drupal Metapackages

A metapackage is a Composer package that contains only a composer.json, and
has no other content. In other words, the purpose of a metapackage is to
provide dependencies, not to provide code or data.


## Metapackages Provided by Drupal Core

Drupal Core provides three metapackages that serve different purposes.

 - drupal/core-recommended: This project pins to the exact version of each
   dependency used in drupal/core. It also requires drupal/core, so
   drupal/core-recommended should be used INSTEAD OF drupal/core. See usage
   diagram below. This relationship makes it easier for Composer to update
   a Drupal project.

 - drupal/core-dev: This project provides the same version constraints as Drupal
   uses for testing. It is useful for projects that either wish to run some of
   the Drupal tests directly, or for projects that may wish to use the same
   components that Drupal does for testing.

 - drupal/core-dev-pinned: This project should be used INSTEAD OF
   drupal/core-dev in instances where a project wishes to pin to the exact
   version of each testing dependency used in Drupal. This in general should not
   be necessary.

Note that a project that uses both drupal/core-recommended and
drupal/core-dev-pinned must update them both at the same time, e.g.:

  composer update drupal/core-recommended drupal/core-dev-pinned --with-dependencies

Composer may have trouble with the update if one of these projects is listed
on the command line without the other. Running composer update without any
parameters should also work, because in this instance every dependency is
updated.


## Metapackage Usage in Template Projects

The relationship between the metapackages drupal/core-recommended and
drupal/core-dev and the project (subtree split) drupal/core, as used in the
drupal/recommended-project is shown below:

+----------------------------+
| drupal/recommended-project |
+----------------------------+
 |
 +--"require":
 |    |
 |    |   +-------------------------+   +-------------+
 |    +-->| drupal/core-recommended |-->| drupal/core |
 |        +-------------------------+   +-------------+
 |
 +--"require-dev":
      |
      |   +-------------------------+
      +-->| drupal/core-dev         |
          +-------------------------+

If a user does not wish to pin their Drupal project's dependencies to the same
versions used in drupal/core, then they should replace drupal/core-recommended
with drupal/core in their "require" section.

If a user does not need the testing dependencies in their Drupal project, then
they may simply remove drupal/core-dev from the "require-dev" section.

File

composer/Metapackage/README.txt

View source
  1. # Drupal Metapackages
  2. A metapackage is a Composer package that contains only a composer.json, and
  3. has no other content. In other words, the purpose of a metapackage is to
  4. provide dependencies, not to provide code or data.
  5. ## Metapackages Provided by Drupal Core
  6. Drupal Core provides three metapackages that serve different purposes.
  7. - drupal/core-recommended: This project pins to the exact version of each
  8. dependency used in drupal/core. It also requires drupal/core, so
  9. drupal/core-recommended should be used INSTEAD OF drupal/core. See usage
  10. diagram below. This relationship makes it easier for Composer to update
  11. a Drupal project.
  12. - drupal/core-dev: This project provides the same version constraints as Drupal
  13. uses for testing. It is useful for projects that either wish to run some of
  14. the Drupal tests directly, or for projects that may wish to use the same
  15. components that Drupal does for testing.
  16. - drupal/core-dev-pinned: This project should be used INSTEAD OF
  17. drupal/core-dev in instances where a project wishes to pin to the exact
  18. version of each testing dependency used in Drupal. This in general should not
  19. be necessary.
  20. Note that a project that uses both drupal/core-recommended and
  21. drupal/core-dev-pinned must update them both at the same time, e.g.:
  22. composer update drupal/core-recommended drupal/core-dev-pinned --with-dependencies
  23. Composer may have trouble with the update if one of these projects is listed
  24. on the command line without the other. Running composer update without any
  25. parameters should also work, because in this instance every dependency is
  26. updated.
  27. ## Metapackage Usage in Template Projects
  28. The relationship between the metapackages drupal/core-recommended and
  29. drupal/core-dev and the project (subtree split) drupal/core, as used in the
  30. drupal/recommended-project is shown below:
  31. +----------------------------+
  32. | drupal/recommended-project |
  33. +----------------------------+
  34. |
  35. +--"require":
  36. | |
  37. | | +-------------------------+ +-------------+
  38. | +-->| drupal/core-recommended |-->| drupal/core |
  39. | +-------------------------+ +-------------+
  40. |
  41. +--"require-dev":
  42. |
  43. | +-------------------------+
  44. +-->| drupal/core-dev |
  45. +-------------------------+
  46. If a user does not wish to pin their Drupal project's dependencies to the same
  47. versions used in drupal/core, then they should replace drupal/core-recommended
  48. with drupal/core in their "require" section.
  49. If a user does not need the testing dependencies in their Drupal project, then
  50. they may simply remove drupal/core-dev from the "require-dev" section.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.