You are here

Home » API reference » PatchInfo 8

README.txt in PatchInfo 8

Same filename and directory in other branches
  1. 8.2 README.txt
  2. 7 README.txt
CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended modules
 * Installation
 * Configuration
 * Maintainers


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

The Patch Info module allows you to add information about patches to a
modules .info.yml file. It will show the information prominently in the
update report and on the update manager form.

 * For a full description of the module, visit the project page:
   https://www.drupal.org/sandbox/feyp/2556153

 * To submit bug reports and feature suggestions, or to track changes:
   https://www.drupal.org/node/add/project-issue/2556153


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

This module does not depend on any other modules.


RECOMMENDED MODULES
-------------------

 * Drush (https://github.com/drush-ops/drush):
   When enabled, you can use drush patchinfo-list to get a list of
   patches applied to Drupal core or contributed modules on your system.
   Refer to drush help patchinfo-list for a list of available options.


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

   In the .info.yml file of a patched 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.

 * Exclude module from update check

   The module will extend the update report settings form at Reports »
   Available Updates » Settings with a textarea, where you can list
   modules, that should be excluded from the update check. List one
   module per line. Use the machine readable module name of the module.
   Modules, which are excluded from the update check will be displayed
   prominently above the update report.


MAINTAINERS
-----------

Current maintainers:
 * Patrick Fey (feyp) - https://drupal.org/u/feyp
 * David Franke (mirroar) - https://drupal.org/u/mirroar

This project has been partly sponsored by:
 * werk21 GmbH
   werk21 is a full service agency from Berlin, Germany, for politics,
   government, organizations and NGOs. Together with its customers,
   werk21 has realized over 60 Drupal web sites (since version 5).
   Visit http://www.werk21.de for more information.

File

README.txt
View source 
  1. CONTENTS OF THIS FILE

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

  3. 

  4.  * Introduction

  5.  * Requirements

  6.  * Recommended modules

  7.  * Installation

  8.  * Configuration

  9.  * Maintainers

  10. 

  11. 

  12. INTRODUCTION

  13. ------------

  14. 

  15. The Patch Info module allows you to add information about patches to a

  16. modules .info.yml file. It will show the information prominently in the

  17. update report and on the update manager form.

  18. 

  19.  * For a full description of the module, visit the project page:

  20.    https://www.drupal.org/sandbox/feyp/2556153

  21. 

  22.  * To submit bug reports and feature suggestions, or to track changes:

  23.    https://www.drupal.org/node/add/project-issue/2556153

  24. 

  25. 

  26. REQUIREMENTS

  27. ------------

  28. 

  29. This module does not depend on any other modules.

  30. 

  31. 

  32. RECOMMENDED MODULES

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

  34. 

  35.  * Drush (https://github.com/drush-ops/drush):

  36.    When enabled, you can use drush patchinfo-list to get a list of

  37.    patches applied to Drupal core or contributed modules on your system.

  38.    Refer to drush help patchinfo-list for a list of available options.

  39. 

  40. 

  41. INSTALLATION

  42. ------------

  43. 

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

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

  46.    for further information.

  47. 

  48. 

  49. CONFIGURATION

  50. -------------

  51. 

  52.  * Add information about a patch

  53. 

  54.    In the .info.yml file of a patched module, add a new list like the one

  55.    shown below:

  56. 

  57.    patches:

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

  59. 

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

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

  62.    patch. The URL is optional.

  63. 

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

  65. 

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

  67.    .info.yml file of the submodule.

  68. 

  69.  * Exclude module from update check

  70. 

  71.    The module will extend the update report settings form at Reports »

  72.    Available Updates » Settings with a textarea, where you can list

  73.    modules, that should be excluded from the update check. List one

  74.    module per line. Use the machine readable module name of the module.

  75.    Modules, which are excluded from the update check will be displayed

  76.    prominently above the update report.

  77. 

  78. 

  79. MAINTAINERS

  80. -----------

  81. 

  82. Current maintainers:

  83.  * Patrick Fey (feyp) - https://drupal.org/u/feyp

  84.  * David Franke (mirroar) - https://drupal.org/u/mirroar

  85. 

  86. This project has been partly sponsored by:

  87.  * werk21 GmbH

  88.    werk21 is a full service agency from Berlin, Germany, for politics,

  89.    government, organizations and NGOs. Together with its customers,

  90.    werk21 has realized over 60 Drupal web sites (since version 5).

  91.    Visit http://www.werk21.de for more information.