Skip to content

Commit d5d2961

Browse files
committed
🎨 Update docs to match latest code
1 parent aef54f2 commit d5d2961

File tree

2 files changed

+44
-25
lines changed

2 files changed

+44
-25
lines changed

doc/overview.md

+42-22
Original file line numberDiff line numberDiff line change
@@ -41,34 +41,54 @@ For example, this code:
4141
results in this expressions-info map (pretty printed for clarity):
4242

4343
```clojure
44-
{"GPL-2.0-or-later"
45-
({:id "GPL-2.0-or-later",
46-
:type :concluded,
47-
:confidence :medium,
48-
:strategy :regex-matching,
49-
:source ("https://repo1.maven.org/maven2/javax/mail/javax.mail-api/1.6.2/javax.mail-api-1.6.2.pom"
50-
"https://repo1.maven.org/maven2/com/sun/mail/all/1.6.2/all-1.6.2.pom"
51-
"<licenses><license><name>"
52-
"CDDL/GPLv2+CE"
53-
"GPLv2+")}),
54-
"CDDL-1.1"
55-
({:id "CDDL-1.1",
56-
:type :concluded,
57-
:confidence :low,
58-
:strategy :regex-matching,
59-
:source ("https://repo1.maven.org/maven2/javax/mail/javax.mail-api/1.6.2/javax.mail-api-1.6.2.pom"
60-
"https://repo1.maven.org/maven2/com/sun/mail/all/1.6.2/all-1.6.2.pom"
61-
"<licenses><license><name>"
62-
"CDDL/GPLv2+CE"
63-
"CDDL")})}
44+
{"CDDL-1.1 OR GPL-2.0-only WITH Classpath-exception-2.0"
45+
({:type :concluded
46+
:confidence :low
47+
:strategy :maven-pom-multi-license-rule
48+
:source ("javax.mail/javax.mail-api@1.6.2"
49+
"https://repo1.maven.org/maven2/javax/mail/javax.mail-api/1.6.2/javax.mail-api-1.6.2.pom"
50+
"https://repo1.maven.org/maven2/com/sun/mail/all/1.6.2/all-1.6.2.pom")}
51+
{:id "GPL-2.0-only"
52+
:type :concluded
53+
:confidence :high
54+
:strategy :manual-verification
55+
:source ("javax.mail/javax.mail-api@1.6.2"
56+
"https://repo1.maven.org/maven2/javax/mail/javax.mail-api/1.6.2/javax.mail-api-1.6.2.pom"
57+
"https://repo1.maven.org/maven2/com/sun/mail/all/1.6.2/all-1.6.2.pom"
58+
"<licenses><license><name>"
59+
"CDDL/GPLv2+CE"
60+
"GPLv2+CE"
61+
"GPLv2")}
62+
{:id "Classpath-exception-2.0"
63+
:type :concluded
64+
:confidence :high
65+
:strategy :manual-verification
66+
:source ("javax.mail/javax.mail-api@1.6.2"
67+
"https://repo1.maven.org/maven2/javax/mail/javax.mail-api/1.6.2/javax.mail-api-1.6.2.pom"
68+
"https://repo1.maven.org/maven2/com/sun/mail/all/1.6.2/all-1.6.2.pom"
69+
"<licenses><license><name>"
70+
"CDDL/GPLv2+CE"
71+
"GPLv2+CE"
72+
"CE")}
73+
{:id "CDDL-1.1"
74+
:type :concluded
75+
:confidence :low
76+
:confidence-explanations #{:missing-version}
77+
:strategy :regex-matching
78+
:source ("javax.mail/javax.mail-api@1.6.2"
79+
"https://repo1.maven.org/maven2/javax/mail/javax.mail-api/1.6.2/javax.mail-api-1.6.2.pom"
80+
"https://repo1.maven.org/maven2/com/sun/mail/all/1.6.2/all-1.6.2.pom"
81+
"<licenses><license><name>"
82+
"CDDL/GPLv2+CE"
83+
"CDDL")})}
6484
```
6585

66-
A key insight that the expressions-info map tells us in this case is that the `javax.mail/javax.mail-api@1.6.2` artifact doesn't declare which version of the CDDL it uses, and lice-comb has _inferred_ the latest (`CDDL-1.1`), and in doing so reduced its confidence to "low". This important insight is not apparent when the `simple` variant of the function is used instead:
86+
A key insight that the expressions-info map tells us in this case is that the `javax.mail/javax.mail-api@1.6.2` artifact doesn't declare which version of the CDDL it uses, and lice-comb has _inferred_ the latest (`CDDL-1.1`), and in doing so reduced its confidence to "low" (while also provided a helpful confidence explanation). This important insight is not apparent when the `simple` variant of the function is used instead:
6787

6888
```clojure
6989
(lcmvn/gav->expressions "javax.mail" "javax.mail-api" "1.6.2")
7090

71-
#{"CDDL-1.1" "GPL-2.0-or-later"}
91+
#{"CDDL-1.1 OR GPL-2.0-only WITH Classpath-exception-2.0"}
7292
```
7393

7494
[Back to GitHub](https://github.com/pmonks/lice-comb)

resources/lice_comb/names.edn

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
; Map of name values seen in the wild that are too ambiguous / cursed to support any reasonable form of automated parsing
22
{
3-
; Seen in https://repo.maven.apache.org/maven2/com/sun/mail/all/1.4.7/all-1.4.7.pom
3+
; Seen in https://repo.maven.apache.org/maven2/com/sun/mail/all/1.4.7/all-1.4.7.pom and other javax.mail/javax.mail-api artifacts
44
"GPLv2+CE" {"GPL-2.0-only WITH Classpath-exception-2.0"
5-
({:type :concluded :confidence :high :strategy :manual-verification :source ("GPLv2+CE")}
6-
{:id "GPL-2.0-only" :type :concluded :confidence :high :strategy :manual-verification :source ("GPLv2+CE" "GPLv2")}
5+
({:id "GPL-2.0-only" :type :concluded :confidence :high :strategy :manual-verification :source ("GPLv2+CE" "GPLv2")}
76
{:id "Classpath-exception-2.0" :type :concluded :confidence :high :strategy :manual-verification :source ("GPLv2+CE" "CE")})}
87
}

0 commit comments

Comments
 (0)