/* .. */ and C++ style //, and are ignored. The matching for C-style comments is non-greedy.
IDENTIFIER ::= [a-zA-Z][a-zA-Z0-9_]*
BUILTIN_IDENTIFIER ::= [a-z]+:[a-zA-Z][a-zA-Z0-9_]*
( ) [ ] { }, . =* / % + -< >@ : ;**== <= >= !==> ..== takes precedence over two = tokens.
0b), 10, or 16 (prefixed by 0x), and leading zeros are effectively ignored. It is possible to separate digit groups with an underscore for readability. It shall be a lexing error to use digits that do not fit into the base.
INTEGER ::= (0[xb])?[0-9a-fA-F]+(_[0-9a-fA-F]+)*
DECIMAL ::= [0-9]+(_[0-9]+)*\.[0-9]+(_[0-9]+)*
STRING ::= ("([^"\n]|(\"))*")|('{3}.*?'{3})|("{3}.*?"{3})
\" escape sequence being replaced with ".
.rsl They contains the user-defined type definitions and optionally user-defined warnings or checks.check They contain only user-defined warning or error messages for types declared in .rsl files.trlc They contain instances of the types (this is where your requirements go).rsl files are parsed. Then, if no errors are raised, all .check files are parsed. Finally, if no errors are raised, all .trlc files are parsed.
.trlc files, but it is recommended to not stop processing after the first error.
file_preamble ::= package_indicationpackage IDENTIFIER { import_clauseimport IDENTIFIER } package_indication ::= 'package' IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_name import_clause ::= 'import' IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_name
qualified_name.
.rsl file starts with a package declaration and is followed by type declarations.
rsl_file ::= file_preamblepackage_indication { import_clause } { type_declaration | check_blockchecks IDENTIFIER { { check_declaration } } }
.rsl file declares a package. Any given package name may only be declared once globally.
.rsl file, a package may not import a package that imports itself, directly or indirectly.
Boolean has two values, false and true.
Integer is a signed integer, with an implementation defined range. This range shall be at least -1000 to 1000, and this can be infinite.
Decimal is a signed rational with a power-of-ten denominator, with an implementation defined range. This range for the numerator shall be at least -1000 to 1000, and denominator is always a natural number with a range of at least 1 to 1000. Any of these ranges can be infinite (but the denominator is always non-negative).
String is a sequence of implementation defined characters. (The decision to support Unicode or not is left unspecified.) The maximum length of a String, if any, is implementation defined, but shall be at least 1000.
Markup_String is identical to a String, except for a few additional constraints on the string contents. Any value of type Markup_String is a valid instance of String, but not the other way around.
described_name ::= IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_name [ STRING("([^"\n]|(\"))*")|('{3}.*?'{3})|("{3}.*?"{3})_description ]
qualified_name ::= [ IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_package_name '.' ] IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_name
type_declaration ::= enumeration_declaration | tuple_declaration | record_declaration
enumeration_declaration ::= 'enum' described_nameIDENTIFIER [ STRING ] '{' { enumeration_literal_specificationdescribed_name } '}' enumeration_literal_specification ::= described_nameIDENTIFIER [ STRING ]
enum ASIL { QM "Not safety relevant" A B C D } enum My_Boolean { yes no file_not_found }
tuple_declaration ::= 'tuple' described_nameIDENTIFIER [ STRING ] '{' field_declarationdescribed_name [ optional ] qualified_name { [ separator_declarationseparator separator_symbol ] field_declarationdescribed_name [ optional ] qualified_name } '}' field_declaration ::= described_nameIDENTIFIER [ STRING ] [ 'optional' ] qualified_name[ IDENTIFIER . ] IDENTIFIER_FIELD_TYPE separator_declaration ::= 'separator' separator_symbolIDENTIFIER | @ | : | ; separator_symbol ::= IDENTIFIER[a-zA-Z][a-zA-Z0-9_]* | '@' | ':' | ';'
1; 2; 3.)
x or b. This is resolved by giving precedence to the lexer. For example the string 0x123 should yield the hex integer 291; but the string 0 x123 or 0 x 123 will generate the tuple. It is recommended to warn when building tuples where a b or x separator follows an integer.
tuple Coordinate { x Decimal y Decimal } // allows you to write (4, 3) tuple Codebeamer_Item { item Integer separator @ version optional Integer } // allows you to write 12345@42 but also just 12345 tuple Doors_Item { module_id Integer separator : item_id Integer separator @ baseline optional Decimal } // allows you to write 0xdeadbeef: 666@1.0 or 0xC0ffee: 1234
record_declaration ::= [ inheritance_qualifierabstract | final ] 'type' described_nameIDENTIFIER [ STRING ] [ 'extends' qualified_name[ IDENTIFIER . ] IDENTIFIER_ROOT_TYPE ] '{' { component_declaration | component_freezingfreeze IDENTIFIER = value } '}' inheritance_qualifier ::= 'abstract' | 'final' component_declaration ::= described_nameIDENTIFIER [ STRING ] [ 'optional' ] qualified_name[ IDENTIFIER . ] IDENTIFIER_COMPONENT_TYPE [ array_declaration[ INTEGER .. * ] | [ INTEGER .. INTEGER ] ] array_declaration ::= '[' INTEGER(0[xb])?[0-9a-fA-F]+(_[0-9a-fA-F]+)*_lower '..' '*' ']' | '[' INTEGER(0[xb])?[0-9a-fA-F]+(_[0-9a-fA-F]+)*_lower '..' INTEGER(0[xb])?[0-9a-fA-F]+(_[0-9a-fA-F]+)*_upper ']' component_freezing ::= 'freeze' IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_component '=' value
abstract, in which case no objects of this type may be declared. It must be extended (even if that extension is empty) before instances of that type can be declared. (Note that it is possible to have components of an abstract type.)
final, and the extension of a final type is also considered to be final (even if it is not explicitly marked as such). An extension of a final type may not contain any component declarations.
* is specified. An array instance for an array type with an upper bound shall not have more elements than its upper bound.
* as if it was that limit). This limit, if it exists, shall be greater than or equal to 1000.
abstract type Base_Requirement { summary "A short summary of the requirement." String description "The actual requirement text." String } type Requirement extends Base_Requirement { asil optional ASIL derived_from optional Requirement [1 .. *] } final type Supplier_Requirement extends Requirement { supplier_id Integer } type ACME_Requirement extends Supplier_Requirement { freeze supplier_id = 666 freeze asil = ASIL.QM }
.check file is simply a set of check blocks.
check_file ::= file_preamblepackage_indication { import_clause } { check_blockchecks IDENTIFIER { { check_declaration } } }
.rsl file.
.check file into the package .rsl file.
check_block ::= 'checks' IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_record_or_tuple_name '{' { check_declaration } '}' check_declaration ::= expression ',' [ severitywarning | error | fatal ] STRING("([^"\n]|(\"))*")|('{3}.*?'{3})|("{3}.*?"{3})_message [ ',' STRING("([^"\n]|(\"))*")|('{3}.*?'{3})|("{3}.*?"{3})_details ] [ ',' IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_component_name ] severity ::= 'warning' | 'error' | 'fatal'
.rsl files since it is not possible to specify a qualified name.
checks Requirement { len(description) < 10, warning "Description is too short", description derived_from != null or top_level == true, error "Requirement linkage incorrect", '''You must set either top_level to true or link this requirement to at least one other requirement using derived_from.''' } checks OverflowGuard { value >= -100, fatal "Value must be at least -100" value <= 100, fatal "Value must be at most 100" // These bound value, and effectively guard against integer // overflow in the below expression value ** 2 == 25, warning "Value is not 5 or -5" } checks Codebeamer_Item { item >= 1, error "CB Item must be positive", item version != null implies version >= 1, error "CB Version must be positive", version }
expression ::= relation { 'and' relation } | relation { 'or' relation } | relation [ 'xor' relation ] | relation [ 'implies' relation ] relation ::= simple_expression[ adding_operator ] term { adding_operator term } [ comparison_operator== | != | < | <= | > | >= simple_expression[ adding_operator ] term { adding_operator term } ] | simple_expression[ adding_operator ] term { adding_operator term } [ 'not' ] 'in' membership_choicesimple_expression .. simple_expression | simple_expression[ adding_operator ] term { adding_operator term } [ 'not' ] 'in' simple_expression[ adding_operator ] term { adding_operator term } membership_choice ::= simple_expression[ adding_operator ] term { adding_operator term } '..' simple_expression[ adding_operator ] term { adding_operator term } simple_expression ::= [ adding_operator+ | - ] termfactor { multiplying_operator factor } { adding_operator+ | - termfactor { multiplying_operator factor } } term ::= factorprimary [ ** primary ] | not primary | abs primary { multiplying_operator* | / | % factorprimary [ ** primary ] | not primary | abs primary } factor ::= primary [ '**' primary ] | 'not' primary | 'abs' primary primary ::= INTEGER(0[xb])?[0-9a-fA-F]+(_[0-9a-fA-F]+)* | DECIMAL[0-9]+(_[0-9]+)*\.[0-9]+(_[0-9]+)* | STRING("([^"\n]|(\"))*")|('{3}.*?'{3})|("{3}.*?"{3}) | 'true' | 'false' | 'null' | name | '(' expression ')' | '(' quantified_expressionquantifier IDENTIFIER in IDENTIFIER => expression ')' | '(' conditional_expression ')'
-a % b is actually - (a % b). The semantics of % are carefully specified so that this does not matter. It does also mean that -a / -b is not legal and needs to be written as either -a / (-b) or even better (-a) / (-b). It is recommended that a linter warns whenever a unary minus is encountered that has a non-trivial term or factor as its operand.
checks Expression_Examples { asil != ASIL.QM, "must be safety related" len(summary) + len(description) > 10, "too short" description != null implies "potato" in description, "description must mention the best vegetable" (forall item in codebeamer_link => item > 50000), warning "cb link is suspiciously small" }
name ::= qualified_name[ IDENTIFIER . ] IDENTIFIER | BUILTIN_IDENTIFIER[a-z]+:[a-zA-Z][a-zA-Z0-9_]* | name '.' IDENTIFIER[a-zA-Z][a-zA-Z0-9_]* | name '[' expression ']' | name '(' parameter_listexpression { , expression } ')' parameter_list ::= expression { ',' expression }
qualified_name must resolve to record component or tuple field in scope, or a visible record object, or a visible enumeration type.
.) access resolves to an enumeration type, then the identifier must be a valid literal of that type. If the prefix of a dot (.) access resolves to a tuple, then the identifier must be a valid field of the type of that tuple. Any other prefix is an error.
name in an array indexing prefix (i.e. [ .. ]) must be an array type.
name in a function call must resolve to one of the builtin functions.
len is of arity 1. Its parameter must be of type String or an array type. Its return type is Integer.
startswith and endswith are of arity 2. All of their parameters must be of type String. The return type of either function is Boolean.
matches is of arity 2. Its parameters must be of type String. The return type is Boolean. The second parameter must be a valid regular expression. (It is implementation defined which regular expression language is used, but it is highly, _highly_ recommended to implement the standard POSIX regular expressions.)
matches function must be a static compile-time constant, i.e. it must not depend on the value of a record field or the value of a quantified variable.
len function computes the length of the given string or array.
startswith function returns true iff the first parameter fully contains the second parameter at its start.
endswith function returns true iff the first parameter fully contains the second parameter at its end.
matches function returns true iff the first parameter is matched by the regular expression given in the second parameter.
Integer type conversion rounds to the nearest integral, away from zero in the case of ties.
Decimal type conversion simply converts the given integer to the exact same rational.
checks Name_Examples { foo, "foo" // names the record field foo len(field) > 0, "foo" // name that is a function call potato[3] < potato[2], "foo" // name that is an array index Decimal(potato[0]) < wibble, "foo" // note that type conversion is necessary cb_link.item >= 50000, warning "cb item value is oddly low" // you can obtain a tuple's values }
comparison_operator ::= '==' | '!=' | '<' | '<=' | '>' | '>=' adding_operator ::= '+' | '-' multiplying_operator ::= '*' | '/' | '%'
"potato" in A + B may either create an error when attempting to concatenate the strings, OR it must work correctly. What you cannot do is cause undefined behaviour in the evaluation.)
and, or, and implies. They first evaluate their left-hand side and proceed to evaluate the right-hand side if it could influence the final result. The semantics of these operators are the usual ones.
xor, and not. They do the usual thing.
== and != are defined for all types, as long as the types are compatible, i.e. they are the same types or one type is a (transitive) record extension of the other. The result is a Boolean.
<, <=, >=, and > are defined for pairs of integers or pairs of rationals only. The result is a Boolean.
not in and in are defined for integers and rationals only. All operands must have the same type, and the result is a Boolean.
not in and in are defined for Strings only. The result is a Boolean.
not in and in are defined for all arrays. The type of the left-hand side must match the element type of the array. The result is a Boolean.
x in a .. b has the same meaning as the Boolean expression x >= a and x <= b. (This means if a is less than b, it is not an error. Instead the result of such a test is always false.)
x not in a .. b has the same meaning as the Boolean expression x < a or x > b.
X in A is equivalent to (exists item in A => item == X). The array non-membership test X not in A is equivalent to (forall item in A => item != X).
+ is defined for integers, rationals, and strings. The binary subtraction operator - is defined for only integers and rationals.
+ is used to concatenate strings, the result is always a String, even if one or both operands if of type Markup_String. (This means the only way you can create a markup string is when you construct it at record object declaration.)
+, and the unary subtraction operator - is defined only for integers and rationals.
+ and - for integers and rationals is the usual one.
+ for strings is string concatenation.
*, / are defined for integers and rational types. The remainder operator % is defined for integers only. For any of these the result is always the same type as the operands.
* is the usual one.
/ for integers is floor division. (For example 5 / 2 is 2 and -5 / 2 is -3.)
/ for rationals is the usual one.
x % y satisfies the relation x = y*N + (x % y), for some (signed) value of N, with one of the following constraints met:
x % y is 0x % y has the same sign as y and an absolute value less than y** is defined for integers and rational bases, and returns the same type as its base. The exponent type is always an Integer.
** must be a static compile-time constant, i.e. it must not depend on the value of a record field or the value of a quantified variable. It must not be negative.
abs is defined for integers and rationals, and returns a (positive) integer or rational respectively.
not is defined for Booleans only, and returns a Boolean.
** is the usual one.
abs is the usual one.
not is the usual one.
quantified_expression ::= quantifierforall | exists IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_name 'in' IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_component_name '=>' expression_PREDICATE quantifier ::= 'forall' | 'exists'
and or or expressions, however it is left unspecified if quantification is using short-circuit semantics or not. It is recommended (for sanity) to do the following:
conditional_expression ::= 'if' expression_CONDITION 'then' expression_DEPENDENT { 'elsif' expression_CONDITION 'then' expression_DEPENDENT } 'else' expression_DEPENDENT
.trlc file is simply a set of record object declarations.
trlc_file ::= file_preamblepackage_indication { import_clause } { trlc_entrysection_declaration | record_object_declaration } trlc_entry ::= section_declarationsection STRING { { trlc_entry } } | record_object_declaration
.rsl file, in which case it is declared by the package_indication in the .trlc file. Such a package is declared late. If two .trlc files declare the same package, then it is unspecified which file actually declares it.
.trlc files declare the same package.
section_declaration ::= 'section' STRING("([^"\n]|(\"))*")|('{3}.*?'{3})|("{3}.*?"{3})_section_name '{' { trlc_entrysection_declaration | record_object_declaration } '}'
record_object_declaration ::= qualified_name[ IDENTIFIER . ] IDENTIFIER_RECORD_TYPE IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_object_name '{' { component_associationIDENTIFIER = value } '}' component_association ::= IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_component_name '=' value value ::= [ adding_operator+ | - ] INTEGER(0[xb])?[0-9a-fA-F]+(_[0-9a-fA-F]+)* | [ adding_operator+ | - ] DECIMAL[0-9]+(_[0-9]+)*\.[0-9]+(_[0-9]+)* | STRING("([^"\n]|(\"))*")|('{3}.*?'{3})|("{3}.*?"{3}) | qualified_name[ IDENTIFIER . ] IDENTIFIER_RECORD_OBJECT | qualified_name[ IDENTIFIER . ] IDENTIFIER_ENUM_TYPE '.' IDENTIFIER[a-zA-Z][a-zA-Z0-9_]*_enumeration_literal | '[' [ value { ',' value } ] ']' | tuple_aggregate tuple_aggregate ::= '(' value { ',' value } ')' | value { separator_symbolIDENTIFIER | @ | : | ; value }
(1, 2, 3), and a tuple with separators must use the separator syntax (e.g. 12345@42).
Foo_Bar is foobar and therefore it clashes with Foobar, F_Oobar, or Foo_B_A_R. But only at record declaration; when referring to other object you still have to use a precise match.)
type that carries this information (it is safe to do that, as it is impossible to specify a record type with a field named type).Requirement Potato { description = "Hello World!" coordinate = (42.0, 666.0) derived_from_cb = [ 1234, // references codebeamer item 1234 (at head revision) 1900@42 // references codebeamer item 1900 at version 42 ] }
Markup_String allows you to inline references to TRLC record in a string. The format is limited and simple: any name or comma-separated list of names enclosed in double square brackets (i.e. [[ and ]]) is considered a reference.
Requirement Bean_Vehicle { description = "The car shall have [[WHEEL_COUNT]] wheels." } Requirement SW_Process { description = "We shall use [[TRLC, LOBSTER]] for achieving software traceability." } Constant WHEEL_COUNT { value = 3 } Tool TRLC { vendor = "BMW AG" url = "https://github.com/bmw-software-engineering/trlc/" license = License.GPL3 } Tool LOBSTER { vendor = "BMW AG" url = "https://github.com/bmw-software-engineering/lobster/" license = License.AGPL3 }
(if a then null else b) is rejected statically.
null == null is statically true.
null.
Version 1.3, 3 November 2008
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document's overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.
The "publisher" means any person or entity that distributes copies of the Document to the public.
A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document's license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version's license notice. These titles must be distinct from any other section titles.
You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation's users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document's Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/licenses/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
"Massive Multiauthor Collaboration Site" (or "MMC Site") means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A "Massive Multiauthor Collaboration" (or "MMC") contained in the site means any set of copyrightable works thus published on the MMC site.
"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
"Incorporate" means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is "eligible for relicensing" if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
Copyright (C) YEAR YOUR NAME.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
A copy of the license is included in the section entitled "GNU
Free Documentation License".
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the "with … Texts." line with this:
with the Invariant Sections being LIST THEIR TITLES, with the
Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.