DIY Disclosure files: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
(Added section on the technical background, but display it only on demand) |
||
Line 1: | Line 1: | ||
=Create individually designed disclosure files= | =Create individually designed disclosure files= | ||
This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository. | This interface uses a script available from the [https://github.com/osadl/SPDX2Disclosure SPDX2Disclosure] repository. | ||
==Encapsulate the [[Search|search]] Web script into a shell script to provide a command line interface for creating individually designed disclosure files== | |||
<html> | <html> | ||
<input type="button" onclick="showorhide(this);" value="Show technical background of this functionality" /> | |||
<div id="showondemand" style="display: none;"> | |||
</html> | |||
To create a disclosure file that relates to a given package name and version from the <span style="font-family: OSSelot-Bold; font-weight: 500; color: #1565af;">O</span> Github repository and design it with respect to the display of licenses and other additional features the following shell script can be used. It selects an additional section with copyright notices per file plus all licenses referenced (option "-lr") and prepending package information (option "-p"). | |||
#!/bin/bash | |||
if test -z "$1" -o -z "$2" | |||
then | |||
echo "Usage: $0 <package> <version>" | |||
exit 1 | |||
fi | |||
package="$1" | |||
version="$2" | |||
if test `wget -qO - <nowiki>https://www.osselot.org/curated.php?$package</nowiki> | grep version-$version` | |||
then | |||
wget -qO - <nowiki>"https://www.osselot.org/diydisclosure.php?$package&-lr&-p"</nowiki> | |||
fi | |||
The output of this script can then be adapted to the actual file set of the binary software distribution and given to the recipient of the software upon delivery as an important step toward compliance with the license terms. Possible further steps to license compliance are the adaptation of other legal materials such as terms and conditions and, if the license imposes this obligation, the immediate provision or an appropriate written offer to deliver the source code. | |||
<html> | |||
</div> | |||
<script src="/scripts/osadl.js"> | <script src="/scripts/osadl.js"> | ||
</script> | </script> | ||
</html> | |||
==Web interface to immediately use the above described script and [[Search|search]] for a given package and create a disclosure document according to the given settings== | |||
<html> | |||
<h5>Overall design</h5> | <h5>Overall design</h5> | ||
<input type="radio" id="none" name="licensing" checked="checked" value="-ln"> | <input type="radio" id="none" name="licensing" checked="checked" value="-ln"> |
Revision as of 18:21, 7 October 2023
Create individually designed disclosure files
This interface uses a script available from the SPDX2Disclosure repository.
Encapsulate the search Web script into a shell script to provide a command line interface for creating individually designed disclosure files
Web interface to immediately use the above described script and search for a given package and create a disclosure document according to the given settings
Overall design
Additional features
Look for software packages that may have already been curated at O and provide links to the related individually designed disclosure documents that will be created on the fly
Interface to obtain standard disclosure documents
A similar interface provides for retrieving the standard disclosure files without the possibility for selecting the overall design for inclusion of licensing data and for adding certain optional features.
Interface to obtain a list of licenses
A similar interface provides for listing the licenses that a particular software package uses instead of the entire disclosure documents.