dist/tools/README

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.

The `parse_licenses.py` script is mainly used to prepare license files
related to third-party dependencies when doing binary release.

The list of licenses is generated by the following steps:

1.

After compiling the FE and Broker modules, the `THIRD-PARTY.txt` file is generated in the `target/classes`
directory of each module, which you can find with the following command:

`find target/classes -name THIRD-PARTY.txt`

2.

Combine the contents of these files into one file, e.g.

`cat THIRD-PARTY.txt >> THIRD-PARTY-all.txt`

3.

Generate a collated list of third-party dependent licenses with the following command.

`python parse_licenses.py THIRD-PARTY-all.txt result.txt`

The script will parse the `THIRD-PARTY-all.txt` file and sort the output by license type.

> Note that the final output is still subject to manual finishing.
> You can refer to `dist/LICENSE-dist.txt`.