Skip to content

Commit 27a3860

Browse files
committed
Update README, include doc/licenses in distro
We forgot to copy the licenses directory to the dists/ directory, so that they weren't included in the binary distribution. I did some house cleaning while I was at it. We no longer distribute ant as far as I can see (we used to for the sbt build, but that was long since removed). Added license for ASM, and Jansi (just to be sure).
1 parent 139ba9d commit 27a3860

File tree

7 files changed

+301
-66
lines changed

7 files changed

+301
-66
lines changed

build.xml

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1861,22 +1861,27 @@ TODO:
18611861
</target>
18621862

18631863
<target name="dist.doc" depends="dist.base, docs.done">
1864-
<mkdir dir="${dist.dir}/doc/scala-devel-docs"/>
1864+
<mkdir dir="${dist.dir}/doc"/>
1865+
<mkdir dir="${dist.dir}/doc/licenses"/>
1866+
<mkdir dir="${dist.dir}/doc/tools"/>
18651867
<copy file="${docs.dir}/LICENSE" toDir="${dist.dir}/doc"/>
1866-
<copy file="${docs.dir}/README" toDir="${dist.dir}/doc"/>
1867-
<mkdir dir="${dist.dir}/doc/scala-devel-docs/api"/>
1868-
<copy toDir="${dist.dir}/doc/scala-devel-docs/api">
1869-
<fileset dir="${build-docs.dir}/library"/>
1868+
<copy file="${docs.dir}/README" toDir="${dist.dir}/doc"/>
1869+
<copy toDir="${dist.dir}/doc/licenses">
1870+
<fileset dir="${docs.dir}/licenses"/>
18701871
</copy>
1871-
1872-
<mkdir dir="${dist.dir}/doc/scala-devel-docs/tools"/>
1873-
<copy toDir="${dist.dir}/doc/scala-devel-docs/tools">
1872+
<copy toDir="${dist.dir}/doc/tools">
18741873
<fileset dir="${build-docs.dir}/manual/html"/>
18751874
</copy>
1875+
1876+
<mkdir dir="${dist.dir}/api"/>
1877+
<copy toDir="${dist.dir}/api">
1878+
<fileset dir="${build-docs.dir}/library"/>
1879+
</copy>
18761880
<copy file="${src.dir}/swing/doc/README"
1877-
toFile="${dist.dir}/doc/scala-devel-docs/README.scala-swing"/>
1881+
toFile="${dist.dir}/api/README.scala-swing"/>
18781882
</target>
18791883

1884+
18801885
<target name="dist.man" depends="dist.base">
18811886
<mkdir dir="${dist.dir}/man"/>
18821887
<copy toDir="${dist.dir}/man">

docs/LICENSE

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
Scala is licensed under the [BSD 3-Clause License](http://opensource.org/licenses/BSD-3-Clause).
2+
3+
## Scala License
4+
15
Copyright (c) 2002-2013 EPFL
26

37
Copyright (c) 2011-2013 Typesafe, Inc.
@@ -27,3 +31,33 @@ PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
2731
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
2832
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
2933
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34+
35+
# Other Licenses
36+
37+
This software includes projects with the following licenses,
38+
which are also included in the `licenses/` directory:
39+
40+
### [Apache License](http://www.apache.org/licenses/LICENSE-2.0.html)
41+
This license is used by the following third-party libraries:
42+
* jansi
43+
44+
### [BSD License](http://www.opensource.org/licenses/bsd-license.php)
45+
This license is used by the following third-party libraries:
46+
* jline
47+
48+
### [BSD 3-Clause License](http://opensource.org/licenses/BSD-3-Clause)
49+
This license is used by the following third-party libraries:
50+
* asm
51+
52+
### [MIT License](http://www.opensource.org/licenses/MIT)
53+
This license is used by the following third-party libraries:
54+
* jquery
55+
* jquery-ui
56+
* jquery-layout
57+
* sizzle
58+
* tools tooltip
59+
60+
### Public Domain
61+
The following libraries are freely available in the public domain:
62+
* forkjoin
63+

docs/README

Lines changed: 18 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,58 +1,36 @@
1+
Scala Distribution
2+
------------------
13

2-
Scala Software Distributions
3-
----------------------------
4-
5-
- scala-<major>.<minor>.<patch>.tgz Unix distribution
6-
- scala-<major>.<minor>.<patch>.zip Windows distribution
7-
8-
The standard distributions require Java 1.5 or above. If you don't
9-
know which version of Java you have, run the command "java -version".
4+
The Scala distribution requires Java 1.6 or above.
105

6+
Please report bugs at https://issues.scala-lang.org/.
7+
We welcome contributions at https://github.com/scala/scala!
118

129
Scala Tools
1310
-----------
1411

15-
- fsc Scala offline compiler
12+
- scala Scala interactive interpreter
1613
- scalac Scala compiler
14+
- fsc Scala resident compiler
1715
- scaladoc Scala API documentation generator
18-
- scala Scala interactive interpreter
1916
- scalap Scala classfile decoder
2017

2118
Run the command "scalac -help" to display the list of available
2219
compiler options.
2320

2421

25-
Unix Installation
26-
-----------------
27-
28-
Untar the archive. All Scala tools are located in the "bin" directory.
29-
Adding that directory to the PATH variable will make the Scala commands
30-
directly accessible.
31-
32-
You may test the distribution by running the following commands:
33-
34-
$ ./bin/scala
35-
scala> Array(4,3,2,1).sorted
36-
res0: Array[Int] = Array(1, 2, 3, 4)
37-
38-
scala>:quit
39-
$
40-
41-
42-
Windows Installation
43-
--------------------
44-
45-
Unzip the archive. All Scala tools are located in the "bin" directory.
46-
Adding that directory to the PATH variable will make the Scala commands
47-
directly accessible.
22+
Installation
23+
------------
4824

49-
On Windows 95/98/Me, you must define the environment variable SCALA_HOME
50-
to point to the home directory of the Scala distribution to run any of
51-
these tools. This can be done by adding the following command to your
52-
AUTOEXEC.BAT file and then rebooting your machine.
25+
Decompress the archive and run the above commands directly from `bin` directory.
26+
We recommend adding the full path of the `bin` directory to the `PATH`
27+
environment variable.
5328

54-
set SCALA_HOME=<install-directory>\scala-<major>.<minor>.<patch>
5529

56-
On Windows NT/2000/XP, you do not need to define any variable in order
57-
for the Scala commands to run correctly.
30+
Licenses
31+
--------
5832

33+
Scala is licensed under the standard 3-clause BSD license,
34+
included in the distribution as the file `doc/LICENSE`.
35+
The licenses of the software included in the Scala distribution can
36+
be found in the `doc/licenses` directory.

docs/licenses/apache_ant.txt

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/licenses/apache_jansi.txt

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
Scala includes the JLine library, which includes the Jansi library.
2+
3+
Apache License
4+
Version 2.0, January 2004
5+
http://www.apache.org/licenses/
6+
7+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8+
9+
1. Definitions.
10+
11+
"License" shall mean the terms and conditions for use, reproduction,
12+
and distribution as defined by Sections 1 through 9 of this document.
13+
14+
"Licensor" shall mean the copyright owner or entity authorized by
15+
the copyright owner that is granting the License.
16+
17+
"Legal Entity" shall mean the union of the acting entity and all
18+
other entities that control, are controlled by, or are under common
19+
control with that entity. For the purposes of this definition,
20+
"control" means (i) the power, direct or indirect, to cause the
21+
direction or management of such entity, whether by contract or
22+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
23+
outstanding shares, or (iii) beneficial ownership of such entity.
24+
25+
"You" (or "Your") shall mean an individual or Legal Entity
26+
exercising permissions granted by this License.
27+
28+
"Source" form shall mean the preferred form for making modifications,
29+
including but not limited to software source code, documentation
30+
source, and configuration files.
31+
32+
"Object" form shall mean any form resulting from mechanical
33+
transformation or translation of a Source form, including but
34+
not limited to compiled object code, generated documentation,
35+
and conversions to other media types.
36+
37+
"Work" shall mean the work of authorship, whether in Source or
38+
Object form, made available under the License, as indicated by a
39+
copyright notice that is included in or attached to the work
40+
(an example is provided in the Appendix below).
41+
42+
"Derivative Works" shall mean any work, whether in Source or Object
43+
form, that is based on (or derived from) the Work and for which the
44+
editorial revisions, annotations, elaborations, or other modifications
45+
represent, as a whole, an original work of authorship. For the purposes
46+
of this License, Derivative Works shall not include works that remain
47+
separable from, or merely link (or bind by name) to the interfaces of,
48+
the Work and Derivative Works thereof.
49+
50+
"Contribution" shall mean any work of authorship, including
51+
the original version of the Work and any modifications or additions
52+
to that Work or Derivative Works thereof, that is intentionally
53+
submitted to Licensor for inclusion in the Work by the copyright owner
54+
or by an individual or Legal Entity authorized to submit on behalf of
55+
the copyright owner. For the purposes of this definition, "submitted"
56+
means any form of electronic, verbal, or written communication sent
57+
to the Licensor or its representatives, including but not limited to
58+
communication on electronic mailing lists, source code control systems,
59+
and issue tracking systems that are managed by, or on behalf of, the
60+
Licensor for the purpose of discussing and improving the Work, but
61+
excluding communication that is conspicuously marked or otherwise
62+
designated in writing by the copyright owner as "Not a Contribution."
63+
64+
"Contributor" shall mean Licensor and any individual or Legal Entity
65+
on behalf of whom a Contribution has been received by Licensor and
66+
subsequently incorporated within the Work.
67+
68+
2. Grant of Copyright License. Subject to the terms and conditions of
69+
this License, each Contributor hereby grants to You a perpetual,
70+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71+
copyright license to reproduce, prepare Derivative Works of,
72+
publicly display, publicly perform, sublicense, and distribute the
73+
Work and such Derivative Works in Source or Object form.
74+
75+
3. Grant of Patent License. Subject to the terms and conditions of
76+
this License, each Contributor hereby grants to You a perpetual,
77+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78+
(except as stated in this section) patent license to make, have made,
79+
use, offer to sell, sell, import, and otherwise transfer the Work,
80+
where such license applies only to those patent claims licensable
81+
by such Contributor that are necessarily infringed by their
82+
Contribution(s) alone or by combination of their Contribution(s)
83+
with the Work to which such Contribution(s) was submitted. If You
84+
institute patent litigation against any entity (including a
85+
cross-claim or counterclaim in a lawsuit) alleging that the Work
86+
or a Contribution incorporated within the Work constitutes direct
87+
or contributory patent infringement, then any patent licenses
88+
granted to You under this License for that Work shall terminate
89+
as of the date such litigation is filed.
90+
91+
4. Redistribution. You may reproduce and distribute copies of the
92+
Work or Derivative Works thereof in any medium, with or without
93+
modifications, and in Source or Object form, provided that You
94+
meet the following conditions:
95+
96+
(a) You must give any other recipients of the Work or
97+
Derivative Works a copy of this License; and
98+
99+
(b) You must cause any modified files to carry prominent notices
100+
stating that You changed the files; and
101+
102+
(c) You must retain, in the Source form of any Derivative Works
103+
that You distribute, all copyright, patent, trademark, and
104+
attribution notices from the Source form of the Work,
105+
excluding those notices that do not pertain to any part of
106+
the Derivative Works; and
107+
108+
(d) If the Work includes a "NOTICE" text file as part of its
109+
distribution, then any Derivative Works that You distribute must
110+
include a readable copy of the attribution notices contained
111+
within such NOTICE file, excluding those notices that do not
112+
pertain to any part of the Derivative Works, in at least one
113+
of the following places: within a NOTICE text file distributed
114+
as part of the Derivative Works; within the Source form or
115+
documentation, if provided along with the Derivative Works; or,
116+
within a display generated by the Derivative Works, if and
117+
wherever such third-party notices normally appear. The contents
118+
of the NOTICE file are for informational purposes only and
119+
do not modify the License. You may add Your own attribution
120+
notices within Derivative Works that You distribute, alongside
121+
or as an addendum to the NOTICE text from the Work, provided
122+
that such additional attribution notices cannot be construed
123+
as modifying the License.
124+
125+
You may add Your own copyright statement to Your modifications and
126+
may provide additional or different license terms and conditions
127+
for use, reproduction, or distribution of Your modifications, or
128+
for any such Derivative Works as a whole, provided Your use,
129+
reproduction, and distribution of the Work otherwise complies with
130+
the conditions stated in this License.
131+
132+
5. Submission of Contributions. Unless You explicitly state otherwise,
133+
any Contribution intentionally submitted for inclusion in the Work
134+
by You to the Licensor shall be under the terms and conditions of
135+
this License, without any additional terms or conditions.
136+
Notwithstanding the above, nothing herein shall supersede or modify
137+
the terms of any separate license agreement you may have executed
138+
with Licensor regarding such Contributions.
139+
140+
6. Trademarks. This License does not grant permission to use the trade
141+
names, trademarks, service marks, or product names of the Licensor,
142+
except as required for reasonable and customary use in describing the
143+
origin of the Work and reproducing the content of the NOTICE file.
144+
145+
7. Disclaimer of Warranty. Unless required by applicable law or
146+
agreed to in writing, Licensor provides the Work (and each
147+
Contributor provides its Contributions) on an "AS IS" BASIS,
148+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149+
implied, including, without limitation, any warranties or conditions
150+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151+
PARTICULAR PURPOSE. You are solely responsible for determining the
152+
appropriateness of using or redistributing the Work and assume any
153+
risks associated with Your exercise of permissions under this License.
154+
155+
8. Limitation of Liability. In no event and under no legal theory,
156+
whether in tort (including negligence), contract, or otherwise,
157+
unless required by applicable law (such as deliberate and grossly
158+
negligent acts) or agreed to in writing, shall any Contributor be
159+
liable to You for damages, including any direct, indirect, special,
160+
incidental, or consequential damages of any character arising as a
161+
result of this License or out of the use or inability to use the
162+
Work (including but not limited to damages for loss of goodwill,
163+
work stoppage, computer failure or malfunction, or any and all
164+
other commercial damages or losses), even if such Contributor
165+
has been advised of the possibility of such damages.
166+
167+
9. Accepting Warranty or Additional Liability. While redistributing
168+
the Work or Derivative Works thereof, You may choose to offer,
169+
and charge a fee for, acceptance of support, warranty, indemnity,
170+
or other liability obligations and/or rights consistent with this
171+
License. However, in accepting such obligations, You may act only
172+
on Your own behalf and on Your sole responsibility, not on behalf
173+
of any other Contributor, and only if You agree to indemnify,
174+
defend, and hold each Contributor harmless for any liability
175+
incurred by, or claims asserted against, such Contributor by reason
176+
of your accepting any such warranty or additional liability.
177+
178+
END OF TERMS AND CONDITIONS
179+
180+
APPENDIX: How to apply the Apache License to your work.
181+
182+
To apply the Apache License to your work, attach the following
183+
boilerplate notice, with the fields enclosed by brackets "[]"
184+
replaced with your own identifying information. (Don't include
185+
the brackets!) The text should be enclosed in the appropriate
186+
comment syntax for the file format. We also recommend that a
187+
file or class name and description of purpose be included on the
188+
same "printed page" as the copyright notice for easier
189+
identification within third-party archives.
190+
191+
Copyright [yyyy] [name of copyright owner]
192+
193+
Licensed under the Apache License, Version 2.0 (the "License");
194+
you may not use this file except in compliance with the License.
195+
You may obtain a copy of the License at
196+
197+
http://www.apache.org/licenses/LICENSE-2.0
198+
199+
Unless required by applicable law or agreed to in writing, software
200+
distributed under the License is distributed on an "AS IS" BASIS,
201+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202+
See the License for the specific language governing permissions and
203+
limitations under the License.

0 commit comments

Comments
 (0)