Update documentation and changelog #264

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

Author: chinyeungli

SPEC

@@ -165,8 +165,9 @@ notice_file: Legal notice or credits for the component.
 notice_url: URL to a legal notice for the component.
 license_file: License file that applies to the component. For example, the name of a license file such as LICENSE or COPYING file extracted from a downloaded archive.
 license_url: URL to the license text for the component.
-license_expression: The license expression for the license of this component. You can separate each identifier using " or " and " and " to document the relationship between multiple license identifiers, such as a choice among multiple licenses.
+license_expression: The license expression that apply to the component. You can separate each identifier using " or " and " and " to document the relationship between multiple license identifiers, such as a choice among multiple licenses.
 license_name: The license short name for the license.
+license: The license key(s) for the component.
 Optional Licensing flag fields
 
 redistribute: Set this flag to yes if the component license requires source code redistribution. Defaults to no when absent.

docs/CHANGELOG.rst

@@ -1,8 +1,109 @@
-2015-xx-xx  xxxxx
+2017-xx-xx  xxxxx
 
     Release 3.0.0
 
-    * Breaking API changes:
+    ABOUT files is now YAML formatted.
+    Supported license expression.
+    Supported JSON input and output format: https://github.com/nexB/aboutcode-toolkit/issues/246 and https://github.com/nexB/aboutcode-toolkit/issues/277
+    Support Python 3: https://github.com/nexB/aboutcode-toolkit/issues/280
+    Refined help texts
+    Refined USAGE texts
+    Refined SPECs
+
+    Input key changes:
+    ==================
+    `about_file` is replaced by `about_file_path`
+    `dje_license_key` is replaced by `license_expression`
+    `version` is no longer a required field
+
+    API Updated:
+    ============
+     - Break down the 3 major functions: `inventory`, `genabout` and `genattrib` into 3 subcommands:
+        i.e.
+        `about inventory`, `about generate` and `about attrib`
+
+     - A new `check` subcommand: https://github.com/nexB/aboutcode-toolkit/issues/281
+
+     - Some options changes
+        `--extract_license` becomes `--fetch-license`
+        `--license_text_location` becomes `--license-notice-text-location`
+
+    etc...
+
+
+2016-06-27  Chin-Yeung Li  <[email protected]>
+
+    Release 2.3.2
+
+    * Documentation updates
+
+
+2016-03-29  Philippe Ombredanne <[email protected]>
+
+    Release 2.3.1
+
+    * Various minor bug fixes and improvements
+    * Support for the latest DejaCode API if you use DejaCode
+
+
+2016-03-28  Philippe Ombredanne <[email protected]>
+
+    Release 2.3.0
+
+    * Various minor bug fixes and improvements
+    * Support for the latest DejaCode API if you use DejaCode
+
+
+2015-10-23  Chin-Yeung Li  <[email protected]>
+
+    Release 2.2.0
+
+    * Improved CLI error messages
+    * Fixed the filtering of dicts with empty values.
+    * Refined help texts
+    * Updated configure script
+    * Refactorings and code simplifications
+    * Fixed misleading error message when using invalid api_url
+
+
+2015-10-09  Chin-Yeung Li  <[email protected]>
+
+    Release 2.1.0
+
+    * Minor code refactoring
+    * Handle long path error on Windows OS when using genattrib with a zip
+
+
+2015-09-29  Chin-Yeung Li  <[email protected]>
+
+    Release 2.0.4
+
+    * Added support to run genattrib with a zip file and tests
+    * Display a "Completed" message once the generation is completed
+
+
+2015-08-01  Chin-Yeung Li  <[email protected]>
+
+    Release 2.0.3
+
+    * Fix the bug of using genattrib.py on Windows OS
+    * Display version when running about.py, genabout.py and genattrib.py
+
+
+2015-07-07  Chin-Yeung Li  <[email protected]>
+
+    Release 2.0.2
+
+    * Handle input's encoding issues
+    * Better error handling
+    * Writing to and reading from Windows OS with paths > 255 chars
+
+
+2015-06-09  Chin-Yeung Li  <[email protected]>
+
+    Release 2.0.1
+
+    * Configuration script fixes and updates basic documentation.
 
 
 2015-05-05  Chin-Yeung Li  <[email protected]>