hash
stringlengths
32
32
doc_id
stringlengths
5
12
section
stringlengths
5
1.47k
content
stringlengths
0
6.67M
a81d9bd99016b59710681951aa0bdd87
25.926
6.1 Examples of reference radio access bearers
In Table 6.1 reference RAB A-G are defined with some characteristics that impact the required UE Radio Access capabilities. These reference RABs shall be seen as example RABs covered by the reference UE radio access capability combinations defined in Subclause 5.2. Reference RABs for conformance testing are specified i...
a81d9bd99016b59710681951aa0bdd87
25.926
6.2 Example mappings between reference RABs and capability combinations
The following examples show how the reference RABs of Table 6.1 can be mapped to the reference UE radio access capability combinations that are listed in Clause 5. Table 6.2: Example mappings between capability combinations and RAB combinations Reference UE radio access capability combinations Examples of supported ref...
a81d9bd99016b59710681951aa0bdd87
25.926
7 Mandatory UE radio access capabilities
NOTE: In this section features and requirements that are mandatory for UEs (capabilities that do not need to be signalled) will be listed for information. The normative descriptions are part of the respective specifications. Annex A (informative): Change history Change history TSG-RAN# Version CR Tdoc RAN New Version S...
23fc60931a9695f8f8c221e6f4caaa93
21.802
1 Scope
The present document investigates the current specification formats and working methods of 3GPP, and other alternative ways that are available for 3GPP to consider. It provides the following necessary considerations: - Identification of: - benefits of the existing ways; - shortcomings and pain-points of the existing...
23fc60931a9695f8f8c221e6f4caaa93
21.802
2 References
The following documents contain provisions which, through reference in this text, constitute provisions of the present document. - References are either specific (identified by date of publication, edition number, version number, etc.) or non‑specific. - For a specific reference, subsequent revisions do not apply. -...
23fc60931a9695f8f8c221e6f4caaa93
21.802
3 Definitions of terms, symbols and abbreviations
23fc60931a9695f8f8c221e6f4caaa93
21.802
3.1 Terms
For the purposes of the present document, the terms given in TR 21.905 [1] and the following apply. A term defined in the present document takes precedence over the definition of the same term, if any, in TR 21.905 [1]. Consumer: A person who reads the specification such as an Original Equipment Manufacturer (OEM), a ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
3.2 Symbols
For the purposes of the present document, the following symbols apply: µ Average σ Standard Deviation
23fc60931a9695f8f8c221e6f4caaa93
21.802
3.3 Abbreviations
For the purposes of the present document, the abbreviations given in TR 21.905 [1] and the following apply. An abbreviation defined in the present document takes precedence over the definition of the same abbreviation, if any, in TR 21.905 [1]. WYSIWYG What You See Is What You Get
23fc60931a9695f8f8c221e6f4caaa93
21.802
4 Assessment of existing specification formats and working methods, and requirements for any improvements
Editor's note: corresponds to objective 1.
23fc60931a9695f8f8c221e6f4caaa93
21.802
4.1 Benefits of current tools
These benefits may in future be achieved by other means than the current tools and file formats used. 1. Familiarity The current set of tools are well known to delegates. 3GPP TR 21.801 [2] captures all requirements and recommendations, accumulated since 1999. Further, there is institutional expertise in checking th...
23fc60931a9695f8f8c221e6f4caaa93
21.802
4.2 Shortcomings, pain-points and potential benefits
Editor’s note: corresponds to objectives 1a/b Table 4.2-1: Shortcomings, pain-points and potential benefits of current tools # Shortcoming / pain-point / potential benefit Possible improvement approaches with current tools Summary of feasibility of addressing the shortcoming / pain-point / potential benefit with c...
23fc60931a9695f8f8c221e6f4caaa93
21.802
4.3 Requirements Identification
Editor's note: corresponds to Objective 1c. The clause may be further divided into different subclauses depending on the discussion. Table 4.3-1 # Requirement Description Applicable to objective 2 Applicable to objective 3 Evaluation Criteria 1 Global availability There shall be no geographic limitations on...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5 Proposals for new formats for 3GPP specifications
Editor's note: corresponds to objective 2.
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.1 Proposal #1: OpenDocument
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.1.1 Description
OpenDocument (ODF) is an open, XML-based file format family for office documents, established as an international standard (ISO/IEC 26300). It's free, transparent, and not controlled by any single vendor. Most importantly, it is a standardized format) which allows to develop tools to automate virtually any task. The IT...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.1.2 Figures, Diagrams and Embedded Objects
OpenDocument supports basic shapes, as follows: - Basic geometric shapes (Rectangles, Ellipses and Circles, Lines, etc) - Polygons, and paths (Polylines, Polygons, Freeform Lines and curves, etc) - Special-purpose shapes (Text boxes, Block arrows, Stars, Callouts, etc) - And some others However, the shapes support...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.1.3 Master Document
An ODT master document is a special file type, with the extension .odm, used to organize and manage a large, multi-part document. The master document acts as a central container that links to separate .odt files, known as subdocuments. The master document does not hold the content of the subdocuments directly. Instead...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.1.4 Flat XML format
An OpenDocument flat XML file is a version of an OpenDocument Format (ODF) document that is saved as a single, uncompressed XML text file. It is an alternative to the standard ODF files (like .odt for text) which are typically saved as a compressed ZIP archive containing several XML and media files. The "flat" version...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.2 Proposal #2: AsciiDoc
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.2.1 Description
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.2.1.1 Overview
References below provide extensive descriptions of AsciiDoc, which we don’t intent to fully copy here - https://asciidoc.org/ - https://asciidoc-wg.eclipse.org/ - https://gitlab.eclipse.org/eclipse/asciidoc-lang - https://projects.eclipse.org/projects/asciidoc.asciidoc-lang - https://docs.asciidoctor.org/asciidoc/...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.2.1.2 Features of AsciiDoc
A list of features supported by AsciiDoc is summarized in Table 5.2.1.2-1. The full list of features supported by AsciiDoc and more details on the summarized features can be found at https://docs.asciidoctor.org/asciidoc/latest/. Table 5.2.1.2-1 also provides the comparison with the language used in MarkDown. Table 5....
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.2.1.3 Tools for AsciiDoc
AsciiDoc syntax is plain text, so one can write an AsciiDoc document using any text editor. GitHub and GitLab support editing and previewing AsciiDoc files. The file must have a supported AsciiDoc extension (.adoc). When viewing an AsciiDoc file on these sites, one sees an HTML preview of the AsciiDoc content. In edit ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3 Proposal #3: Markdown
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1 Description
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1.1 Introduction of Markdown
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1.1.0 General
Markdown was created by John Gruber in 2004 as an easy-to-read markup language. Popularity of Markdown eventually led to a number of implementations. The original Markdown language had ambiguities that did not get addressed and a group of people has made attempts to standardize the markup language in 2012. This is know...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1.1.1 Comparison of common Markdown variants
As stated in the previous section, there are many variants of Markdown with support for different sets of basic and extended features. Table 5.3.1.1.1-1 compares Commonmark, Gitlab-flavoured Markdown, and Pandoc Markdown, albeit not exhaustively. A cell containing an X indicates support, while an empty cell indicates l...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1.2 Benefits of Markdown
As described in the previous section, Markdown separates information from styles. A major pain point with the way specifications are written in 5G is that it is difficult to properly select styles and that time is wasted on non-technical work. Markdown has the potential to solve this challenge to writing the specificat...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1.3 Base features of Markdown
Markdown without extensions supports the following base features, described in Table 5.3.1.3-1. These features apply to the blocks named “Source” and “Images” in Figure 5.3.1.6-2. The table names each feature and demonstrates the Markdown and HTML syntax. Because the rendered output of Markdown is represented in an HTM...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1.4 Extended features of Markdown
Markdown has been extended to add more features such as equation rendering, superscript and subscript, and grid tables, which enable tables with merged cells. Many popular extensions exist, including Pandoc-flavoured Markdown (https://pandoc.org/MANUAL.html) and GitLab-flavoured Markdown (https://docs.gitlab.com/user/m...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1.5 3GPP extensions to Markdown with custom processing
To support elements which are specific to 3GPP, some extensions to Markdown have been prototyped. These extensions are written in a language called Lua (https://www.lua.org/), for which an interpreter is built directly into Pandoc, the tool used to convert from Markdown to HTML. The benefit of using Lua over other lang...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1.6 How to produce a specification using Markdown
Markdown source is not presentable on its own as it is a language intended to be converted to HTML, using a simple syntax and a subset of the features of HTML. Many tools are available for converting Markdown to HTML, but the one which will be used in this solution is called Pandoc, which can be found at https://pandoc...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1.7 Handling of bitmap or bit pattern elements in specifications (e.g. MAC, RLC, PDCP)
The bitmap or bit pattern representations are used in e.g. MAC specification to describe PDU formats and control element structures using figures (created using e.g. Visio). These can be represented either via figures or via textual representations using ASCII text or ASN.1 as exemplified below. Table 5.3.1.7-1: Examp...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.3.1.8 Front Matter
In Markdown documents, the YAML front matter refers to a block of metadata placed at the very top of a file, typically enclosed between triple dashes (---). This section is widely supported by many Markdown parsers and tools. The front matter allows declaring structured metadata about the document—including titles, ver...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.4 Proposal #4: Multiple formats for single specification with Markdown as baseline
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.4.1 Description
A single specification can be represented or stored in multiple file formats, where each format may contain either specific parts or elements (as shown in the table below) or a complete, self-contained version of the specification (e.g., docx or pdf etc.). In the table below it is described how the various specificati...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.5 Proposal #5: LaTeX
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.5.1 Description
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.5.1.1 Introduction of LaTeX
LaTeX is high-quality typesetting system, intended for production of technical and scientific documentation [4]. LaTeX has a stable specification and uses widely in academic publications for high-quality literature prints. As the file format and typeset-ting system is intended for technical and scientific documentation...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.5.1.2 Benefits of LaTeX
The following are some formatting features that are distinct from Microsoft Word which may be of interest for 3GPP specifications. - Separation of typesetting configuration & actual literature content - LaTeX is consists of two aspects. Typesetting configuration and literature content. It is possible to separate the ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.5.1.3 Examples of LaTeX drafting
In this section, some examples of how LaTeX is drafted and rendered is provided. Additionally, comparison with another popular markup language, Markdown, is provided to provide context of LaTeX as a markup language and to show case how LaTeX handles different use cases of 3GPP specification drafting. The example shows ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.5.1.4 Example implementation of LaTeX based Specification on 3GPP Forge
As part of the Specification modernation study, three example LaTeX implementation of RAN specification was created in 3GPP Forge. The example LaTeX implementations are: - TS38.201 V19.0.0 in https://forge.3gpp.org/rep/fs_6gspecs_new/interdigital_latex_38201. - TS38.202 V19.0.0 in https://forge.3gpp.org/rep/fs_6gspec...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.6 Proposal #6: DOCX with restrictions
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.6.1 Description
This proposal focuses on what can be done to make DOCX and use of MS Word compliant with the requirements. DOCX format needs no introduction, and so we will omit the description of the format itself for brevity. To address requirement 4 "Cross Platform", the following restrictions shall be introduced and enforced to ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.6.2 Evaluation against requirements of section 4.3
Due to similarities and substantial overlap of the "Proposal #6: DOCX with restriction" and "Proposal #7: Multiple formats for single specification with Word as baseline", and considering that these proposals are not mutually exclusive, these proposals are evaluated together. For details see clause 5.7.2.
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.7 Proposal #7: Multiple formats for single specification with Word as baseline
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.7.1 Description
In the table below it is described how the various specification elements of a single specification could be stored, i.e. which file format they could be stored, where the main document of the specification is written with Word. It should be noted that some specification elements can be captured in different formats d...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.7.2 Evaluation against requirements of section 4.3
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.8 Proposal #8: Standalone ASN.1
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.8.1 Description
ASN.1 is the language used to define signalling in the radio resource control (RRC) protocol. The language supports many built-in datatypes, e.g., bit strings, Booleans, enumerations, integers, and octet strings, and data structures, e.g., choices and sequences. Every IE is named, and every field within an IE is named ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.8.1.1 Field descriptions
The specifications only use comments to delineate blocks of ASN.1, e.g., -- TAG-RRCREESTABLISHMENT-START/STOP and ASN1-START/STOP, and to assign need codes, e.g., -- Need R, and conditional presence, e.g., -- Cond L2RemoteUE, to fields. Therefore, it is feasible to write field descriptions in the line immediately prece...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.8.1.2 Conditional presence definitions
Conditional presence definitions could be defined inline to the ASN.1, but not inside of the IE definitions since the conditional presence can apply to multiple ASN.1 IEs. To differentiate conditional presence definitions from other types of comments, a simple syntax like that described in section 5.8.1.1 could be used...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.8.1.3 Rendering the ASN.1
The audience of 3GPP specifications is broad, including mobile network operators (MNO), UE vendors, UE chipset vendors, NW vendors, governmental bodies, researchers, delegates, standards defining organizations (SDO), and the interested public. Therefore, it is reasonable to produce a professionally rendered specificati...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.8.1.4 Editing the ASN.1
Integrated development environments (IDEs), which are essentially text editors that at least support syntax highlighting and indentation and commonly support integration with Git and source code syntax checkers and compilers, can be useful in displaying source files such as ASN.1 files in a more human-friendly way. An ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
5.8.1.5 Storing the ASN.1
RAN4 stores their band combination tables in the JSON file format in the 3GPP Forge, and SA5 store YAML files in the 3GPP Forge (https://forge.3gpp.org/rep/sa5/CH/-/tree/Rel-19/OpenAPI). Similarly, it would be feasible to store ASN.1 in asn files in the 3GPP Forge. Further, we can draw from the example of TS 32.291, a...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6 Proposals for Tools and Ways of Working
Editor's note: corresponds to objective 3.
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.1 Proposal #1: tools and ways of working for OpenDocument
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.1.1 Description
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.1.1.1 Description of tools
For editing ODT documents, LibreOffice is a natural choice, however it is by no means the only option. Here is a short and not exhaustive list of such tools with short summaries of their strengths: - LibreOffice Writer: This is arguably the most popular and comprehensive ODT editor. It's free, open-source, and cross-p...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2 Proposal #2 Git for Version Control
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1 Description
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.0 Overview
Git (https://git-scm.org) is an open-source distributed version control system, which tracks changes to files and enables collaboration. Distributed means that every user can download and update a full copy of the repository, including files and their history locally (not just the current files, but also the full chan...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.1 Description of tools
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.1.0 Overview
The following are basic git commands for creating and saving changes (see Figure 6.2.1.0-1): - git clone - Create a full local copy of a remote repository, it contains both file and changes history. Cloning a repository is the action of downloading the repository from the remote server. - git fetch - Download changes...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.1.1 Git commit
The Git commit command records a snapshot of the project’s staged changes, capturing the state of the codebase at a particular point of time. Each commit consists of following elements: - Metadata - Includes author, committer, message, timestamps, and a unique identifier called a SHA hash. - Commit Message - Describe...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.1.2 Git branching
Git branching is essential for managing projects efficiently in collaborative and feature-driven development workflows. Key aspects of branching include: - Creating independent lines of development - Isolate changes and work on new features, bug fixes, or experiments without affecting the main codebase - Enable coll...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.1.3 Git history
Git history provides detailed information about every single change introduced by commits, including: - Commit Details: Includes commit hashes, messages, authors, dates, and timestamps. - Changes to Files: Tracks what changes were made to specific files over time. - Branch Contributions: Identifies changes introduce...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.1.4 Git GUI tools
Git itself is a CLI (Command Line Interface) based tool, but it is also integrated in many existing GUI (Graphical User Interface) tools. Because Git repositories are decentralized, it can be completely up to user preference which tools to use. Some examples of Git tools include: - Built-in GUIs: - git-gui — Simple o...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.2 Description of repository structure and branching
This section describes the physical structure of the repository and the branches required to track releases, the effect of Git operations on the repository structure, and how CRs become part of the specification.
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.2.1 Structure
A repository would be created for each specification, e.g., TS 38.300 and TS 38.331 would be kept in distinct repositories. The reason for maintaining separate repositories is to cleanly associate CRs with a specification as is done today and to enable the individual tracking of versions of releases. When exploring a s...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.2.2 Branching
As discussed in the previous section, each release would have its own branch, which when checked out would point to the latest version of that release. Creating a branch is the first step to making a modification to the specification. When creating a CR, the latest version of the affected release must first be checked ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.2.3 Merging
After the final revisions of CR1 and CR3 were ready they were marked as agreed, awaiting merging in plenary. During plenary, CR1 and CR3 were approved and merged into the Release 21 branch. Once all merging was complete, the latest commit (the last merge) was tagged with the next version, v21.1.0, for easy retrieval. S...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.2.4 Merging Running CRs, Baseline CRs
During the creation of a new release, the latest version of the active release is used as a baseline for a running CR (or baseline CR) to begin implementing the agreements made during the work item. The current procedure for baseline CR handling is described in Annex C. The first running CR for 38.331 toward Release 1...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.2.5 Example of branching and merging during a release cycle
Figure 6.2.1.2.5-1 is an example of how the mechanisms described in previous sections (branching, merging) can be applied during a release cycle. We take the example of Rel-22 work item phase and assume Rel-21 specifications are available in the Git repository. In this phase, Rel-21 specification maintenance will happe...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.2.6 Directory Contents
The use of Git is agnostic to the format or formats of the files within, and can store any type of file, with the caveat that binary files are not well supported due to the difficulty in generating a difference between two versions of a binary file wherein a single change could affect multiple parts of the file. A sing...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.3 Description of procedures
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.3.1 Mapping Git procedures to Change Request processes
We can compare the typical current CR procedure (Figure 6.2.1.3.1-1) to a potential future CR procedure with Git (Figure 6.2.1.3.1-2), relating each current step to the Git equivalent in the new procedure. The mapping provided is not meant to imply a solution, but rather to relate the Git flow to our current 3GPP flow....
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.3.2 Creating a CR - workflow description
This section describes the workflow for creating a CR. The table, Table 6.2.1.3.2-1, describes the steps required to create and upload a CR to the Git repository. Note that details related to TDoc reservation, and downloading an automatically generated TDoc will not be discussed in this section. Table 6.2.1.3.2-1: Cre...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.3.3 Updating a CR – workflow description
After the first version of a CR has been pushed to the remote repository, it can be further modified by the original author or by other contributors. The CR branch can be worked on directly or one or more branches can be created to make changes. In this example, the focus will be on an author applying further changes t...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.1.4 Intermediate form CR
The time constraints and the large number of contributors to the revision of a CR could necessitate the use of an intermediate document format for use in collaboration. Today it is common for working groups to collaborate as follows. 1. Rapporteur uploads the initial version of a document, e.g., a CR. 2. A delegate d...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.2.2 Evaluation against requirements of section 4.3
Editor's Note: Evaluation is FFS.
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.3 Proposal #3: Ways of Working on CRs during meetings when using Gitlab for preparation of CRs
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.3.1 Description
Gitlab on 3GPP Forge is used as a repository of identical copies of certain (parts of the) specifications that are written in text-based formats separately from the rest of the specifications written in Word. The primary normative reference of specifications remains stored on FTP. Gitlab on 3GPP Forge is used for prep...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.3.1.1 Description of tools
The tools used in these Ways of Working are the following: - 3GU for CR submission - Word for CR cover sheet. - Gitlab on 3GPP Forge for storage of text-based parts of specifications that are not written in Word, and at least for preparation of CRs or draft CRs - Schema files for ensuring consistent use of styles ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.3.1.2 Description of procedures
The following Ways of Working (WoW) are studied for collaborative work on drafting CRs. In this clause, changes to the CR cover sheet data fields must be controlled through access to Gitlab, in order to maintain a one-to-one correspondence between commits and a CR referencing these commits. It is also assumed that ei...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.3.2 Evaluation against requirements of section 4.3
Editor's note: The evaluation is FFS 6.4 Proposal #4 OneM2M workflow
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1 Description
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.1 Description of tools
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.2 Description of procedures
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.2.1 Introduction
Below is described a candidate workflow for using the 3GPP's GitLab environment (i.e. the 3GPP Forge) for handling CRs, TSs and TRs. This workflow is similar to the workflow used by the OneM2M (https://www.onem2m.org/) for handling of CRs, TSs and TRs with adaptations to the current 3GPP ways of working. It should be ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.2.2 Overview
Below is a diagram showing the workflow used for CRs in OneM2M. You might need to zoom in to see the details, but the diagram is also available in a higher resolution version here: https://forge.etsi.org/rep/cti/md-specs-dev/contribution-procedure/-/blob/master/simplified-process.md. More details are also found here: ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.2.3 Git repository settings
In this model each TS or TR has its own associated repository in the 3GPP Forge with a protected "main" branch (containing the latest version of the specification) with the following characteristics: - The main branch is protected: - Only MCC can merge into main branch - Only TSG and WG officials can approve Merge R...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.2.4 Workflow for a WG meeting
The following would happen for a WG meeting: - Following the WG's pre-meeting schedule, delegates request for Tdoc numbers. - With the Tdoc numbers allocated for the CRs, delegates should create "CR" branches which have in the name of the branch a reference to the tdoc number, e.g., CR/WG-YYMCXI_CR_Name. The CR branc...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.2.5 Workflow for a TSG meeting
During the TSG meeting, the CRs agreed in the preceding WG meetings have to be approved by the TSG. In GitLabs terms this means that the Merge Requests tagged as agreed during the WG meetings have to be now approved and merged in the main branch. This could be done following the steps below: - In the TSG meeting, the ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.2.6 Maintenance for frozen specification releases
To handle corrections CRs for frozen releases the current model proposes the following workflow: - At the freeze of each release MCC creates a protected branch for the release to be frozen: - release-xx-main branch created from the main branch For the correction CRs to a frozen release, the protected branch will act...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.2.7 Publishing the specifications
Currently OneM2Ms approach is that they have an automated portal where all their specifications are found: https://specifications.onem2m.org/ Whenever a new version of their specification is ready, i.e. after CR implementation has completed, the latest specification is published and can be accessed on the portal. The ...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.2.8 Potential variant of the OneM2M workflow: GitFlow-like workflow
One variant of the OneM2M workflow described above is the GitFlow work flow. In the GitFlow workflow a develop branch is used as an intermediate step when implementing Merge Requests onto the main branch based on these principles as follows: - Protected main branch: - Only MCC can merge into main branch - Only TSG o...
23fc60931a9695f8f8c221e6f4caaa93
21.802
6.4.1.2.9 Handling CR cover page information
In this model, the CR cover page information is converted from tabular format to JSON format as presented in the example below. Note that approach could be in both the OneM2M workflow or the alternative (GitFlow-like workflow described in clause 6.4.1.2.8). CR-Form-v12.3 CHANGE REQUEST <Spec#> CR <CR#> rev <...