You are here

Home » API reference » PatchInfo 8.2

README.txt in PatchInfo 8.2

Same filename in this branch
  1. 8.2 README.txt
  2. 8.2 modules/patchinfo_drupalorg/README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration


INTRODUCTION
------------

The PatchInfo Drupal.org module allows you to add Drupal.org information about
patches in the patchinfo-list drush command.


REQUIREMENTS
------------

This module does depend on the Patchinfo and Drush modules.


INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. See:
   https://www.drupal.org/documentation/install/modules-themes/modules-8
   for further information.


CONFIGURATION
-------------

 * Add information about a patch using info.yml patch source

   In the *.info.yml file of a patched theme or module, add a new list like the
   one shown below:

   patches:
     - 'https://www.drupal.org/node/1739718 Issue 1739718, Patch #32'

   You can add multiple entries to the list. Each entry should start with the
   URL of the issue or patch followed by any kind of information about the
   patch. The URL is optional.

   You can use any URL or description, that is convenient to you.

   If you are patching a submodule, you may add the patch entry to the
   *.info.yml file of the submodule.

 * Add information about a patch using composer.json patch source

   The composer.json patch source assumes, that 'cweagans/composer-patches' is
   used for patch management. See https://github.com/cweagans/composer-patches
   for more information.

   For Drupal Core, it will check for a composer.json in your Drupal root
   directory or in the 'core' folder.

   Presently, the source plugin will skip any patches for packages outside the
   'drupal/' namespace.

 * Add the drupal.org issue number to the description of the patch

   Add the issue number preferably at the front of the description. In case of
   the yml file directly after the patch url.

   Accepted are the following notations:

    * Issue 123456
    * issue 123456
    * #123456

   Followed by . or : or | or , or space or EOL.

File

modules/patchinfo_drupalorg/README.txt
View source 
  1. CONTENTS OF THIS FILE

  2. ---------------------

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Recommended modules

  7.  * Installation

  8.  * Configuration

  9. 

  10. 

  11. INTRODUCTION

  12. ------------

  13. 

  14. The PatchInfo Drupal.org module allows you to add Drupal.org information about

  15. patches in the patchinfo-list drush command.

  16. 

  17. 

  18. REQUIREMENTS

  19. ------------

  20. 

  21. This module does depend on the Patchinfo and Drush modules.

  22. 

  23. 

  24. INSTALLATION

  25. ------------

  26. 

  27.  * Install as you would normally install a contributed Drupal module. See:

  28.    https://www.drupal.org/documentation/install/modules-themes/modules-8

  29.    for further information.

  30. 

  31. 

  32. CONFIGURATION

  33. -------------

  34. 

  35.  * Add information about a patch using info.yml patch source

  36. 

  37.    In the *.info.yml file of a patched theme or module, add a new list like the

  38.    one shown below:

  39. 

  40.    patches:

  41.      - 'https://www.drupal.org/node/1739718 Issue 1739718, Patch #32'

  42. 

  43.    You can add multiple entries to the list. Each entry should start with the

  44.    URL of the issue or patch followed by any kind of information about the

  45.    patch. The URL is optional.

  46. 

  47.    You can use any URL or description, that is convenient to you.

  48. 

  49.    If you are patching a submodule, you may add the patch entry to the

  50.    *.info.yml file of the submodule.

  51. 

  52.  * Add information about a patch using composer.json patch source

  53. 

  54.    The composer.json patch source assumes, that 'cweagans/composer-patches' is

  55.    used for patch management. See https://github.com/cweagans/composer-patches

  56.    for more information.

  57. 

  58.    For Drupal Core, it will check for a composer.json in your Drupal root

  59.    directory or in the 'core' folder.

  60. 

  61.    Presently, the source plugin will skip any patches for packages outside the

  62.    'drupal/' namespace.

  63. 

  64.  * Add the drupal.org issue number to the description of the patch

  65. 

  66.    Add the issue number preferably at the front of the description. In case of

  67.    the yml file directly after the patch url.

  68. 

  69.    Accepted are the following notations:

  70. 

  71.     * Issue 123456

  72.     * issue 123456

  73.     * #123456

  74. 

  75.    Followed by . or : or | or , or space or EOL.