Update version and docs

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

SPECIFICATION.rst

@@ -1,4 +1,4 @@
-ABOUT File Specification v3.0
+ABOUT File Specification v3.1
 
 
 Purpose
@@ -25,7 +25,6 @@ Getting Started
 A simple and valid ABOUT file named httpd.ABOUT may look like this::
 
         about_resource: httpd-2.4.3.tar.gz
-        about_resource_path: httpd-2.4.3.tar.gz
         name: Apache HTTP Server
         version: 2.4.3
         homepage_url: http://httpd.apache.org
@@ -223,11 +222,7 @@ Referencing the file or directory documented by an ABOUT file
 
 An ABOUT file documents one file or directory. The mandatory "about_resource"
 field reference the documented file or directory. The value of the
-"about_resource" field is the name of the referenced file or directory. 
-
-On the other hand, there is another field "about_resource_path" can be a name stored
-in the same directory as the ABOUT file or a POSIX path relative to the path of
-the ABOUT file. POSIX paths use a "/" forward slash sign as path separators.
+"about_resource" field is the name or path of the referenced file or directory. 
 
 A tool processing an ABOUT file must report an error if this field is missing.
 
@@ -238,18 +233,15 @@ For example, a file named django.ABOUT contains the following field to document
 the django-1.2.3.tar.gz archive stored in the same directory::
 
       about_resource: django-1.2.3.tar.gz
-      about_resource_path: django-1.2.3.tar.gz
 
 In this example, the ABOUT file documents a whole sub-directory::
 
       about_resource: linux-kernel-2.6.23
-      about_resource_path: downloads/linux-kernel-2.6.23/
 
 In this example, the ABOUT file documents the current directory, using a "."
 period to reference it::
 
       about_resource: .
-      about_resource_path: .
 
 
 Other Mandatory fields
@@ -271,8 +263,6 @@ Optional Information fields
   be the date the component was provisioned, in an ISO date format such as
   'YYYY-MM-DD'.
 
-- about_resource_path: Path the the reference component
-
 - spec_version: The version of the ABOUT file format specification used for this
   file. This is provided as a hint to readers and tools in order to support
   future versions of this specification.
@@ -330,7 +320,7 @@ Optional Licensing fields
 - license_key: The license key(s) for the component.
 
 
-Optional Licensing flag fields
+Optional Boolean flag fields
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 - redistribute: Set this flag to yes if the component license requires source
@@ -345,6 +335,8 @@ Optional Licensing flag fields
 - modified: Set this flag to yes if the component has been modified. Defaults to
   no when absent.
 
+- internal_use_only: Set this flag to yes if the component is used internal only.
+  Defaults to no when absent.
 
 Optional Extension fields
 ~~~~~~~~~~~~~~~~~~~~~~~~~

docs/CHANGELOG.rst

@@ -1,6 +1,6 @@
-2018-xx-xx
+2018-11-15
 
-    Release x.x.x
+    Release 3.3.0
 
     * Update the list of common license keys
     * New UrlListField introduced for list of urls
@@ -9,7 +9,7 @@
     * Format the ordering of the genreated ABOUT file (See https://github.com/nexB/aboutcode-toolkit/issues/349#issuecomment-438871444)
     * '+' and '(' and ')' is now supported in license_expression
     * The key 'about_resource_path' is removed
-    * The 2 required fields are 'about_resource' and 'name'
+    * Revert back the requirement of the 'name' field
     * Add a new supported 'internal_use_only' key
 
 2018-10-23

docs/UsingAboutCodetoDocumentYourSoftwareAssets.md

@@ -63,18 +63,13 @@ You should start with a software inventory of your codebase in spreadsheet forma
   <tr>
     <td>name</td>
     <td>Component name</td>
-    <td>Optional</td>
+    <td>Mandatory</td>
   </tr>
   <tr>
     <td>about_resource</td>
     <td>Name of the component resource</td>
     <td>Optional</td>
   </tr>
-  <tr>
-    <td>about_resource_path</td>
-    <td>Path to the component resource</td>
-    <td>Optional. Relative path to the component resource from where the .ABOUT file located.</td>
-  </tr>
   <tr>
     <td>version</td>
     <td>Component version</td>

docs/UsingAboutCodetoDocumentYourSoftwareAssets.pdf

@@ -24,7 +24,7 @@ def read(*names, **kwargs):
 
 setup(
     name='aboutcode-toolkit',
-    version='3.2.2',
+    version='3.3.0',
     license='Apache-2.0',
     description=(
         'AboutCode-toolkit is a tool to document the provenance (origin and license) of '

setup.py

@@ -27,10 +27,10 @@
     basestring = str  # Python 3 #NOQA
 
 
-__version__ = '3.2.2'
+__version__ = '3.3.0'
 
 
-__about_spec_version__ = '3.0.0'
+__about_spec_version__ = '3.1'
 
 __copyright__ = """
 Copyright (c) 2013-2018 nexB Inc. All rights reserved. http://dejacode.org