Skip to content

C
CERN Open Hardware Licence
Commit 3ea4ddcf authored by Andrew Katz's avatar Andrew Katz Committed by Javier Serrano
Browse files
Options

Correcting formatting, white space and typos.

parent 0576ecf9
Hide whitespace changes
Inline Side-by-side
Showing with 49 additions and 63 deletions
user_guides/cern_ohl_s_v2_user_guide.tex
View file @ 3ea4ddcf
...@@ -29,16 +29,14 @@ citecolor=blue]{hyperref} ...@@ -29,16 +29,14 @@ citecolor=blue]{hyperref}
This document contains guidelines on how to apply the CERN-OHL-S v2 to a given This document contains guidelines on how to apply the CERN-OHL-S v2 to a given
hardware design, and on the use of hardware designs licensed under hardware design, and on the use of hardware designs licensed under
CERN-OHL-S v2. This means we will be talking to you sometimes as a licensor, CERN-OHL-S v2. This means we will be talking to you sometimes as a licensor,
and and other times as a licensee.
other times as a licensee.
As a licensor, there are many ways in which you can make it clear to your As a licensor, there are many ways in which you can make it clear to your
licensees that you are sharing your designs under the licence. These guidelines licensees that you are sharing your designs under the licence. These guidelines
are only to be taken as advice, illustrating some ways in which we think this are only to be taken as advice, illustrating some ways in which we think this
can be done efficiently. can be done efficiently.
To help you distinguish between requirements imposed by the licence (mostly as a To help you distinguish between requirements imposed by the licence (mostly as a licensee)
licensee)
and our suggestions to you (mostly as a licensor), we will use the word `rule' and our suggestions to you (mostly as a licensor), we will use the word `rule'
for the former and the word `suggestion' for the latter. Any perceived for the former and the word `suggestion' for the latter. Any perceived
contradiction between these guidelines and the licence text should of course be contradiction between these guidelines and the licence text should of course be
...@@ -50,8 +48,7 @@ resolved in favour of the licence text. ...@@ -50,8 +48,7 @@ resolved in favour of the licence text.
Authorship/ownership of the design must be clear and undisputed. Only the legal Authorship/ownership of the design must be clear and undisputed. Only the legal
owner of the rights in the hardware design may decide under what conditions to owner of the rights in the hardware design may decide under what conditions to
make it available. Generally, If ownership is vested in more than one make it available. Generally, If ownership is vested in more than one person/entity, there
person/entity, there
must be an agreement among the owners (or a chain of compatible licences from must be an agreement among the owners (or a chain of compatible licences from
each of them) to release the hardware design as open hardware, and under the each of them) to release the hardware design as open hardware, and under the
CERN-OHL-S v2 in particular. CERN-OHL-S v2 in particular.
...@@ -59,10 +56,9 @@ CERN-OHL-S v2 in particular. ...@@ -59,10 +56,9 @@ CERN-OHL-S v2 in particular.
\subsection{Your sources} \subsection{Your sources}
\label{subsec:your-sources} \label{subsec:your-sources}
Nowadays most designers who intend to share their work do so by hosting their Nowadays, most designers who intend to share their work do so by hosting their
design files (sources) in a publicly-accessible repository using design files (sources) in a publicly-accessible repository using
version-control version-control systems such as git. The sites hosting these repositories usually provide users
systems such as git. The sites hosting these repositories usually provide users
with the convenience of downloading a whole repository as a compressed (e.g. with the convenience of downloading a whole repository as a compressed (e.g.
zip) file. This is a very effective way of working: it makes it easier for you zip) file. This is a very effective way of working: it makes it easier for you
to receive feedback, shows your users the complete history of the project and to receive feedback, shows your users the complete history of the project and
...@@ -70,8 +66,7 @@ allows them to easily start using it and contributing improvements. ...@@ -70,8 +66,7 @@ allows them to easily start using it and contributing improvements.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.1}] \begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.1}]
\item \textbf{Suggestion: } try to host your design in a publicly-accessible \item \textbf{Suggestion: } try to host your design in a publicly-accessible
repository using version control. If that is not possible, compress your repository using version control. If that is not possible, compress your whole
whole
directory structure into one file and publish that file, so users get your directory structure into one file and publish that file, so users get your
whole project in one go. whole project in one go.
\end{enumerate} \end{enumerate}
...@@ -79,38 +74,33 @@ whole ...@@ -79,38 +74,33 @@ whole
If your goal is to share, it makes sense to provide enough information to users If your goal is to share, it makes sense to provide enough information to users
about the contents of the design package they download, and to make it easy for about the contents of the design package they download, and to make it easy for
them to browse that information. For example, if you have designed your them to browse that information. For example, if you have designed your
hardware using proprietary tools, people who download the design files hardware using proprietary tools, people who download the design files may not
may not
have access to the tools you used. Sometimes you can also provide exported have access to the tools you used. Sometimes you can also provide exported
versions of those files which, although not as useful for modification as the versions of those files which, although not as useful for modification as the
originals, will make life easier for people who want to understand your originals, will make life easier for people who want to understand your designs.
designs.
For example, PCB schematics and layout can be exported as pdf files, and For example, PCB schematics and layout can be exported as pdf files, and
3D mechanical designs can be exported to the STEP format. 3D mechanical designs can be exported to the STEP format.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.3}]
\item \textbf{Rule: } if your design is a modification of someone else's
design, or incorporates parts of another's design, and in each case the
other's design is released under CERN-OHL, CERN-OHL-W or CERN-OHL-S you must
(if your tools allow this) include in your design sources versions of the
files exported to formats everybody can read using tools available under an
free or open source software licence.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.2}] \begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.2}]
\item \textbf{Suggestion: } include in your design sources versions of the \item \textbf{Suggestion: } include in your design sources versions of the
files exported to formats everybody can read. It would be helpful to specify files exported to formats everybody can read. It would be helpful to specify
the tools you used, and, if they are publicly available under free and open the tools you used, and, if they are publicly available under free and open
source licences, provide information about where the recipient can find them. source licences, provide information about where the recipient can find them.
\end{enumerate} \end{enumerate}
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.3}]
\item \textbf{Rule: } if your design is a modification of someone else's
design, or incorporates parts of another's design, and in each case the
other's design is released under CERN-OHL, CERN-OHL-W or CERN-OHL-S you must
(if your tools allow this) include in your design sources versions of the
files exported to formats everybody can read using tools available under an
free or open source software licence.
\end{enumerate} \end{enumerate}
It can also be good to let people know that you are following this guide, so It can also be good to let people know that you are following this guide, so
they see why you are doing things in this or that way. they see why you are doing things in this or that way.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.4}] \begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.4}]
\item \textbf{Suggestion: } include a copy of this user guide, in pdf or plain \item \textbf{Suggestion: } include a copy of this user guide, in pdf or plain
text format, in your sources. text format, in your sources.
...@@ -132,21 +122,21 @@ to the licence at ...@@ -132,21 +122,21 @@ to the licence at
\end{enumerate} \end{enumerate}
One of the requirements for licensees who make modifications to the design and One of the requirements for licensees who make modifications to the design and
publish those modifications, is to make them explicit in a dedicated text file. publish those modifications is to make them explicit in a dedicated text file.
As a licensor, you can make this obligation more easy to see and bear in mind As a licensor, you can make this obligation more easy for licensees to see and bear in mind
by including a placeholder file called CHANGES.txt in your sources. by including a placeholder file called CHANGES.txt in your sources.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.6}] \begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.6}]
\item \textbf{Suggestion: } include an empty CHANGES.txt file in your sources. \item \textbf{Suggestion: } include an empty CHANGES.txt file in your sources.
You may write a few lines in the beginning of the file stating that anyone You may write a few lines in the beginning of the file stating that anyone
modifying the design should provide brief information about the modifications, modifying the design should provide brief information about the modifications,
including the date they were made, and stating that information about the design should be including the date they were made, and stating that information about the design should be
added but never removed from that file. It could also state that, according to section 3.3.b of the licence, licensees should added but never removed from that file. It could also state that, according to section 3.3.b
provide a brief entry with a date and the nature of the modification for each of the licence, licensees should provide a brief entry with a date and the nature of the
design change. For example `26 April 2020: AC/DC power converter circuit modification for each design change. For example `26 April 2020: AC/DC power converter circuit
removed as AC input no longer necessary'. removed as AC input no longer necessary'. You can make this obligation easier to manage by
You can make this obligation easier to manage my making your design modular in making your design modular in the first place (so that the CHANGES.txt file does not accumulate
the first place (so that the CHANGES.txt file does not accumulate information from parts of designs which you are not using). information from parts of designs which you are not using).
\end{enumerate} \end{enumerate}
Now, as you have seen, as the initial licensor, relatively few rules apply to Now, as you have seen, as the initial licensor, relatively few rules apply to
...@@ -231,10 +221,8 @@ SPDX-License-Identifier: CERN-OHL-S-2.0+ ...@@ -231,10 +221,8 @@ SPDX-License-Identifier: CERN-OHL-S-2.0+
Why would you license your design under `CERN-OHL-S v2 or later'? Imagine we Why would you license your design under `CERN-OHL-S v2 or later'? Imagine we
discovered a shortcoming of the licence which made us write a new version, discovered a shortcoming of the licence which made us write a new version,
let's let's say version 3.0, to fix it. Let us further imagine that we decided to make v3
say version 3.0, to fix it. Let us further imagine that we decided to make v3 incompatible with v2 (this actually happened with the GPL). If you licensed your
incompatible with v2 (this actually happened with the GPL). If you licensed
your
design under `v2 only' that means it could not be combined with new designs design under `v2 only' that means it could not be combined with new designs
licensed under v3. If, on the other hand, you license your design under `v2 or licensed under v3. If, on the other hand, you license your design under `v2 or
later', you give future licensees the option of interpreting the design as later', you give future licensees the option of interpreting the design as
...@@ -242,16 +230,15 @@ licensed under the hypothetical v3, and there would be no compatibility issues. ...@@ -242,16 +230,15 @@ licensed under the hypothetical v3, and there would be no compatibility issues.
This is quite an important decision to take when you use a reciprocal licence, This is quite an important decision to take when you use a reciprocal licence,
so we thought we'd mention it in this guide. You have to make your own judgment so we thought we'd mention it in this guide. You have to make your own judgment
as to whether you believe that CERN can be trusted to ensure that as to whether you believe that CERN can be trusted to ensure that
future future versions of the CERN-OHL will be similar in spirit and effect to
versions of the CERN-OHL will be similar in spirit and effect to this version. this version.
\begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.8}] \begin{enumerate}[label=\textbf{\ref*{subsec:your-sources}.8}]
\item \textbf{Suggestion: } give some thought to the `or later' option before \item \textbf{Suggestion: } give some thought to the `or later' option before
publishing your design under CERN-OHL-S v2. publishing your design under CERN-OHL-S v2.
\end{enumerate} \end{enumerate}
We are going to assume that you, as a licensor, want people who receive a We are going to assume that you, as a licensor, want people who receive a product
product
based on your design to know that it is Open Hardware and where they can find based on your design to know that it is Open Hardware and where they can find
the design files for that product, hence: the design files for that product, hence:
...@@ -264,20 +251,23 @@ visible ...@@ -264,20 +251,23 @@ visible
\item the licence notice: “Licensed under CERN-OHL-S v2”; \item the licence notice: “Licensed under CERN-OHL-S v2”;
\item the Source Location. \item the Source Location.
\end{enumerate} \end{enumerate}
\item \textbf{Suggestion: }You can optionally include a copyright notice to be printed on the Product (remember you must keep intact any Notices in the source, though), but do \emph{not} include the CERN logo. You may include a copyright \item \textbf{Suggestion: }You can optionally include a copyright notice to be
notice. If you do, and your design includes part of other designs, you should at least acknowledge the work is not all your own by using Copyright \textcopyright 2020 Sam Smith and others. printed on the Product (remember you must keep intact any Notices in the source,
though), but do \emph{not} include the CERN logo. You may include a copyright
notice. If you do, and your design includes part of other designs, you should at
least acknowledge the work is not all your own by using Copyright \textcopyright
2020 Sam Smith and others.
\end{enumerate} \end{enumerate}
\subsection{A Note on Components} \subsection{A Note on Components}
\label{subsec:note-components} \label{subsec:note-components}
If your design is modular, consider licensing each of If your design is modular, consider licensing each of the components you have designed
the components you have designed separately, and then having an overarching separately, and then having an overarching design, also licensed under an appropriate
design, also licensed under an appropriate variant of CERN-OHL which contains variant of CERN-OHL which contains each of the sub-components as an Available Component.
the each of the sub-components. This will This will make life easier for licensees who only want to make use of one
make life easier for licensees who only want to make use of one component of your design.
component of
your design.
\section{How to deal with hardware designs licensed under CERN-OHL-S v2} \section{How to deal with hardware designs licensed under CERN-OHL-S v2}
\label{sec:receive-designs} \label{sec:receive-designs}
...@@ -287,9 +277,8 @@ receive hardware designs licensed under the CERN-OHL-S v2, the requirements are ...@@ -287,9 +277,8 @@ receive hardware designs licensed under the CERN-OHL-S v2, the requirements are
to: to:
\begin{enumerate}[label=\textbf{\ref*{sec:receive-designs}.1}] \begin{enumerate}[label=\textbf{\ref*{sec:receive-designs}.1}]
\item \textbf{Rule: } keep intact all the copyright, acknowledgment and \item \textbf{Rule: } keep intact all the copyright, acknowledgment and
trademark notices and trademark notices and
Source Location notices that are on the hardware design sources. Source Location notices that are on the hardware design sources.
...@@ -337,14 +326,12 @@ components of the design allow you to license with the "or later" option. ...@@ -337,14 +326,12 @@ components of the design allow you to license with the "or later" option.
\subsection{Hardware production and distribution} \subsection{Hardware production and distribution}
\label{subsec:make-hardware} \label{subsec:make-hardware}
If, as a licensee, you want to produce hardware based on a design licensed If, as a licensee, you want to produce hardware based on a design licensed under
under
CERN-OHL-S v2 and/or distribute that hardware, you need to: CERN-OHL-S v2 and/or distribute that hardware, you need to:
\begin{enumerate}[label=\textbf{\ref*{subsec:make-hardware}.1}] \begin{enumerate}[label=\textbf{\ref*{subsec:make-hardware}.1}]
\item \textbf{Rule: } either provide each recipient with a copy of the Complete \item \textbf{Rule: } either provide each recipient with a copy of the Complete
Source or ensure that each recipient is notified of the Source Location of Source or ensure that each recipient is notified of the Source Location of the
the
Complete Source. Complete Source.
\end{enumerate} \end{enumerate}
...@@ -354,8 +341,7 @@ expressed by the licensor to have a clear visual indication of the Source ...@@ -354,8 +341,7 @@ expressed by the licensor to have a clear visual indication of the Source
Location on the hardware: Location on the hardware:
\begin{enumerate}[label=\textbf{\ref*{subsec:make-hardware}.2}] \begin{enumerate}[label=\textbf{\ref*{subsec:make-hardware}.2}]
\item \textbf{Rule: } if specified in a Notice by the licensor, the Product \item \textbf{Rule: } if specified in a Notice by the licensor, the Product must
must
visibly and securely display the Source Location on it or its packaging or visibly and securely display the Source Location on it or its packaging or
documentation in the manner specified in that Notice. documentation in the manner specified in that Notice.
\end{enumerate} \end{enumerate}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment