From: Bartosz Dziewoński <matma.rex@gmail.com>
Date: Wed, 12 Sep 2018 16:13:53 +0000 (+0200)
Subject: foreign-resources.yaml: Fix some documentation typos
X-Git-Tag: 1.34.0-rc.0~4109^2
X-Git-Url: https://git.cyclocoop.org/%242?a=commitdiff_plain;h=9b405a3f1780ad1869bcd6b5bea591da455eed36;p=lhc%2Fweb%2Fwiklou.git

foreign-resources.yaml: Fix some documentation typos

Change-Id: I89281ddaeec5d0bc778ca6829dc2d7a531fb5320
---

diff --git a/maintenance/resources/foreign-resources.yaml b/maintenance/resources/foreign-resources.yaml
index 9beb0e3877..a54f1fd790 100644
--- a/maintenance/resources/foreign-resources.yaml
+++ b/maintenance/resources/foreign-resources.yaml
@@ -1,6 +1,7 @@
 ### Format of this file
 #
-# The top-level keys are module names (as registered in Resources.php).
+# The top-level keys are directory names (under resources/lib/).
+# They should match module names (as registered in Resources.php), but there are exceptions.
 # Each top-level key holds a resource descriptor that must have one of
 # the following `type` values:
 #
@@ -10,9 +11,9 @@
 #
 ### Type tar
 #
-# The `src` and `integrity` keys are quired.
+# The `src` and `integrity` keys are required.
 #
-# * `src`: Full URL to thes remote resource.
+# * `src`: Full URL to the remote resource.
 # * `integrity`: Cryptographic hash (integrity metadata format per <https://www.w3.org/TR/SRI/>).
 # * `dest`: An object mapping paths to files or directory from the remote resource to a destination
 #    in the module directory. The value of key in dest may be omitted, which will extract the key
@@ -20,13 +21,13 @@
 #
 ### Type file
 #
-# The `src` and `integrity` keys are quired.
+# The `src` and `integrity` keys are required.
 #
-# * `src`: Full URL to thes remote resource.
+# * `src`: Full URL to the remote resource.
 # * `integrity`: Cryptographic hash (integrity metadata format per <https://www.w3.org/TR/SRI/>).
 # * `dest`: The name of the file in the module directory. Default: Basename of URL.
 #
-### Type mult-file
+### Type multi-file
 #
 # The `files` key is required.
 #
diff --git a/maintenance/resources/manageForeignResources.php b/maintenance/resources/manageForeignResources.php
index 41e579ba39..aa22c68dd1 100644
--- a/maintenance/resources/manageForeignResources.php
+++ b/maintenance/resources/manageForeignResources.php
@@ -45,8 +45,8 @@ libraries registered as ResourceLoader modules. See also foreign-resources.yaml.
 For sources that don't publish an integrity hash, omit "integrity" (or leave empty)
 and run the "make-sri" action to compute the missing hashes.
 
-This script runs in dry mode by default. Use --update to actually change, remove,
-or add files to /resources/lib/.
+This script runs in dry-run mode by default. Use --update to actually change,
+remove, or add files to resources/lib/.
 TEXT
 		);
 		$this->addArg( 'action', 'One of "update", "verify" or "make-sri"', true );