Clearer protection #3629
Open
Clearer protection #3629
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
henrikt-ma
reviewed
Dec 20, 2024
|
|
||
| record IntLicense "Internal class name, do not use" | ||
| /*literal*/ constant String libraryKey; | ||
| /*literal*/ constant String licenseFile = "" "Optional, default mapping if empty"; |
There was a problem hiding this comment.
No need to point out that this is optional:
Suggested change
| /*literal*/ constant String licenseFile = "" "Optional, default mapping if empty"; | |
| /*literal*/ constant String licenseFile = "" "Default mapping if empty"; |
henrikt-ma
reviewed
Dec 20, 2024
| /*literal*/ constant String libraryKey; | ||
| /*literal*/ constant String licenseFile = "" "Optional, default mapping if empty"; | ||
| end License; | ||
| /*literal*/ constant IntLicense License; |
There was a problem hiding this comment.
I find the Int prefix confusing. How about ProtectionLicense or UserLicense?
henrikt-ma
reviewed
Dec 20, 2024
| end Protection; | ||
|
|
||
| record IntLicense "Internal class name, do not use" |
There was a problem hiding this comment.
Wouldn't it look cleaner like this,
Suggested change
| record IntLicense "Internal class name, do not use" | |
| record IntLicense "Type of Protection.License" |
or without any description at all?
Suggested change
| record IntLicense "Internal class name, do not use" | |
| record IntLicense |
henrikt-ma
reviewed
Dec 20, 2024
| @@ -2350,26 +2351,26 @@ \subsection{Licensing}\label{licensing} | |||
|
|
|||
| In order that the protected class can be used either a tool specific license manager, or a license file (called \lstinline!licenseFile!) must be present. | |||
| The license file is standardized. | |||
| It is a Modelica package without classes that has a \lstinline!Protection! annotation of the following form which specifies a sequence of target records, which makes it natural to define start/end dates for different sets of targets individually: | |||
| It is a Modelica package without classes that has a \lstinline!Authorization! annotation of the following form which specifies a sequence of target records, which makes it natural to define start/end dates for different sets of targets individually: | |||
There was a problem hiding this comment.
Grammar:
Suggested change
| It is a Modelica package without classes that has a \lstinline!Authorization! annotation of the following form which specifies a sequence of target records, which makes it natural to define start/end dates for different sets of targets individually: | |
| It is a Modelica package without classes that has an \lstinline!Authorization! annotation of the following form which specifies a sequence of target records, which makes it natural to define start/end dates for different sets of targets individually: |
henrikt-ma
reviewed
Dec 20, 2024
| end License; | ||
| end Protection; | ||
| record Authorization | ||
| /*literal*/ constant String licensor = "" "Optional string to show information about the licensor"; |
There was a problem hiding this comment.
Again, no need to point out optionality anymore:
Suggested change
| /*literal*/ constant String licensor = "" "Optional string to show information about the licensor"; | |
| /*literal*/ constant String licensor = "" "Information about the licensor"; |
henrikt-ma
reviewed
Dec 20, 2024
| using the following definition: | ||
| \begin{lstlisting}[language=modelica] | ||
| record License | ||
| /*literal*/ constant String licensee = "" "Optional string to show information about the licensee"; |
There was a problem hiding this comment.
Similar:
Suggested change
| /*literal*/ constant String licensee = "" "Optional string to show information about the licensee"; | |
| /*literal*/ constant String licensee = "" "Information about the licensee"; |
henrikt-ma
reviewed
Dec 20, 2024
| /*literal*/ constant String licensee = "" "Optional string to show information about the licensee"; | ||
| /*literal*/ constant String id[:] "Unique machine identifications, e.g., MAC addresses"; | ||
| /*literal*/ constant String features[:] "Activated library license features"; | ||
| /*literal*/ constant String startDate = "" "Optional start date in UTCformat YYYY-MM-DD"; |
There was a problem hiding this comment.
Similar:
Suggested change
| /*literal*/ constant String startDate = "" "Optional start date in UTCformat YYYY-MM-DD"; | |
| /*literal*/ constant String startDate = "" "Start date in UTCformat YYYY-MM-DD"; |
henrikt-ma
reviewed
Dec 20, 2024
| /*literal*/ constant String id[:] "Unique machine identifications, e.g., MAC addresses"; | ||
| /*literal*/ constant String features[:] "Activated library license features"; | ||
| /*literal*/ constant String startDate = "" "Optional start date in UTCformat YYYY-MM-DD"; | ||
| /*literal*/ constant String expirationDate = "" "Optional expiration date in UTCformat YYYY-MM-DD"; |
There was a problem hiding this comment.
Similar:
Suggested change
| /*literal*/ constant String expirationDate = "" "Optional expiration date in UTCformat YYYY-MM-DD"; | |
| /*literal*/ constant String expirationDate = "" "Expiration date in UTCformat YYYY-MM-DD"; |
henrikt-ma
reviewed
Dec 20, 2024
| /*literal*/ constant String expirationDate = "" "Optional expiration date in UTCformat YYYY-MM-DD"; | ||
| /*literal*/ constant String operations[:] "Library usage conditions"; | ||
| end License; | ||
| \end{lstlisting} |
There was a problem hiding this comment.
Somewhere below here, the default behaviors should be explained:
Suggested change
| \end{lstlisting} | |
| \end{lstlisting} | |
| If \lstinline!startDate! or \lstinline!expirationDate! are empty (the default), the license has no start day or expiration date, respectively. |
henrikt-ma
reviewed
Dec 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #3622
In particular: