Skip to content

Commit 44e2d48

Browse files
committed
Fixed #342 Updated SPEC
Signed-off-by: Chin Yeung Li <[email protected]>
1 parent 3b606da commit 44e2d48

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

SPECIFICATION.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ An ABOUT file documents one file or directory. The mandatory "about_resource"
222222
field reference the documented file or directory. The value of the
223223
"about_resource" field is the name of the referenced file or directory.
224224

225-
On the other hand, there is anther field "about_resource_path" can be a name stored
225+
On the other hand, there is another field "about_resource_path" can be a name stored
226226
in the same directory as the ABOUT file or a POSIX path relative to the path of
227227
the ABOUT file. POSIX paths use a "/" forward slash sign as path separators.
228228

@@ -235,20 +235,18 @@ For example, a file named django.ABOUT contains the following field to document
235235
the django-1.2.3.tar.gz archive stored in the same directory::
236236

237237
about_resource: django-1.2.3.tar.gz
238+
about_resource_path: django-1.2.3.tar.gz
238239

239240
In this example, the ABOUT file documents a whole sub-directory::
240241

241-
about_resource: downloads/linux-kernel-2.6.23/
242+
about_resource: linux-kernel-2.6.23
243+
about_resource_path: downloads/linux-kernel-2.6.23/
242244

243245
In this example, the ABOUT file documents the current directory, using a "."
244246
period to reference it::
245247

246248
about_resource: .
247-
248-
Since all paths are interpreted relative to the ABOUT file location, this would
249-
also reference the current directory::
250-
251-
about_resource: /
249+
about_resource_path: .
252250

253251

254252
Other Mandatory fields
@@ -264,7 +262,7 @@ field are missing.
264262
Optional Information fields
265263
~~~~~~~~~~~~~~~~~~~~~~~~~~~
266264

267-
- version: Component version. A component usually has a version, such as a
265+
- version: Component or package version. A component or package usually has a version, such as a
268266
revision number or hash from a version control system (for a snapshot checked
269267
out from VCS such as Subversion or Git). If not available, the version should
270268
be the date the component was provisioned, in an ISO date format such as
@@ -301,6 +299,8 @@ Optional Owner and Author fields
301299

302300
- author: Name of the organization(s) or person(s) that authored the component.
303301

302+
- author_file: Author file for the component.
303+
304304

305305
Optional Licensing fields
306306
~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -324,7 +324,7 @@ Optional Licensing fields
324324

325325
- license_name: The license short name for the license.
326326

327-
- license: The license key(s) for the component.
327+
- license_key: The license key(s) for the component.
328328

329329

330330
Optional Licensing flag fields

0 commit comments

Comments
 (0)