Commit 3cbb9c44 authored by Jerediah Fevold's avatar Jerediah Fevold
Browse files

Initital commit of README

parent 424088b3
Loading
Loading
Loading
Loading

README.md

0 → 100644
+64 −0
Original line number Original line Diff line number Diff line
# Introduction
This Markdown Specification project implements an example of a structure to store and collaborate on a 3GPP specification in a git repository. The base version of the specification is v18.0.0 of TS38.331. The example recreates the RILs for the UAV work item starting in RAN2#125. The RILs are named as they were in that reivew, the review file for which can be found linked below in the resources section. The RILs were recreated to closely match their corresponding edits to the frozen specification, as if each RIL were submitted with text proposals for changes. The RILs were then implemented through merges and merge conflict resolution.

# RILs
RILs are comments or direct suggestions for changes to a frozen release under review. Historically, RILs were written such that they would point to a specific example in the specification, with discussion that changes should apply to each relevant section of the specification. However, the RILs for this project have been created differently. Here, the RILs are able to modify related text throughout the specification as to propose a full set of common changes at the same time. For example, procedural text related to releasing configurations might need to be updated in several parts of the specification to address the same issue. One RIL could implement the chagnes all at once.

# Demonstration
In this demonstration, 27 RILs, which were agreed to be implemented in the specification, were transcribed from the initial review of 38.331 v18.0.0. Each RIL modifies the specification text directly and is stored in its own branch.

## Structure
The following structure has been developed for the demonstration. It is a first attempt, and is up for discussion.

* main - Contains the clean specification v18.0.0, and would eventually contain final versions of the modified specifications, e.g., v18.1.0.
  * NR_UAV-core_R2_125 - Contains all changes related to a WI, which can eventually be merged as a running CR, either into the specification or into another running CR capturing other WIs.
    * NR_UAV-core_R2_125_RIL - Contains all changes related to the RIL for this WI. The agreed RILs would eventually be merged here.
      * NR_UAV-core_R2_125_RIL_* - The RIL branches contain changes that make focused modifications ot the specification and can include changes in more than one part of the specification, but the changes should be related to one another.
      * NR_UAV-core_R2_125_impl_v0 - Contains the first set of implemented changes as shown in the the running CR for the WI, which can be found [here](https://www.3gpp.org/ftp/tsg_ran/WG2_RL2/TSGR2_125/Docs/R2-2401605.zip)
        * NR_UAV-core_R2_125_impl_v1 - Adds changes from a second set of changes to demonstrate how further changes could come during a meeting or in a revised CR.
          * NR_UAV-core_R2_125_impl_v2 - Adds editorial changes and any inconsistently or uncompletely implemented changes.

As is demonstrated by the structure, RILs are submitted independently from one another and are merged in as they are agreed. Branches can derive from other branches, creating a hierarchy. Because the branches were based on the clean specification, the final set of changes are fully compatible with the clean specification and can be merged in as a set.

# RIL Report

## Simple Report
RIL reports could come in different forms. On the most basic level, the branches and an excerpt from their comment can be easily produced directly by the git tool as shown or in the [web interface](https://forge.etsi.org/rep/fevold/markdown-specification/-/branches/active].

Note that this simple example can be improved upon with filtering and a full listing of the commoent associated with the latest commit to the branch. The web tool or the command-line tool can be used to determine the difference proposed by the change.

```git branch -v
NR_UAV-core_R2_125                    d256c74 Initial, clean commit of 38331 v18.0.0
NR_UAV-core_R2_125_RIL                d256c74 Initial, clean commit of 38331 v18.0.0
NR_UAV-core_R2_125_RIL_C003           6e9180e [RIL]: C003 [Delegate]: CATT (Tangxun) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_C004           da03d55 [RIL]: C004 [Delegate]: CATT (Tangxun) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_C008           098ce10 [RIL]: C008 [Delegate]: <CATT (Name)> [Class]: 1 [Status]: PropAgree [TDoc]: None [Proposed Conclusion]:
NR_UAV-core_R2_125_RIL_C009           21da34c [RIL]: C009 [Delegate]: CATT (Tangxun) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_C018           783620d [RIL]: C018 [Delegate]: <CATT (Tangxun)> [Class]: UAV [Status]: ToDo [TDoc]: None
NR_UAV-core_R2_125_RIL_E081           3ffa9c2 [RIL]: E081 [Delegate]: Ericsson (Helka-Liina) [Class]: 1 [Status]: PropAgree [TDoc]: None
NR_UAV-core_R2_125_RIL_E085           c9e885a [RIL]: E085 [Delegate]: Ericsson (Helka-Liina) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_E086           e745901 [RIL]: E086 [Delegate]: Ericsson (Helka-Liina) [Class]: 1 [Status]: PropAgree [TDoc]:
NR_UAV-core_R2_125_RIL_E094           42ae3be [RIL]: E094 [Delegate]: Ericsson (Helka-Liina) [Class]: 1 [Status]: PropAgree [TDoc]:
NR_UAV-core_R2_125_RIL_E122           a8b66ef [RIL]: E122 [Delegate]: Ericsson (Nithin) [Class]: 1 [Status]: PropAgree [TDoc]:
NR_UAV-core_R2_125_RIL_E125           488899f [RIL]: E125 [Delegate]: Ericsson (Nithin) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_E127           c5db256 [RIL]: E127 [Delegate]: Ericsson (Nithin) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_E129           bb9e70f [RIL]: E129 [Delegate]: Ericsson (Nithin) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_H059           2225895 [RIL]: H059 [Delegate]: Huawei (Lili) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_H743           bb5c0d8 [RIL]: H743 [Delegate]: Huawei (Simone) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_H745           7f695ab [RIL]: H745 [Delegate]: Huawei (Simone) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_I115           6e88e40 [RIL]: I115 [Delegate]: Intel [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_I116           62a7e6e [RIL]: I116 [Delegate]: Intel (Sudeep) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_J061           0ded1f2 [RIL]: J061 [Delegate]: Sharp (LIU Lei) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_J065           dadf1f5 [RIL]:  Sharp [Delegate]: LIU Lei [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_J074           e40c7b5 [RIL]: J074 [Delegate]: Sharp (LIU Lei) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_L004           52c4685 [RIL]:  L004 [Delegate]: LGE (Soo Kim) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_Rapp_C024_L003 3a292ef [RIL]: Rapp C024 L003 [Delegate]: < ()> [Class]: [Status]: [TDoc]:
NR_UAV-core_R2_125_RIL_W012           4a3daf2 [RIL]: W012 [Delegate]: NEC (Zonghui XIE) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_W014           7199ca4 [RIL]: W014 [Delegate]: NEC (Zonghui XIE) [Class]: 1 [Status]: ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_Z074           ddd53f0 [RIL]: Z074 [Delegate]: ZTE (ZhangMengjie) [Class]: 1 [Status]:ToDo [TDoc]:
NR_UAV-core_R2_125_RIL_Z075           59ce45f [RIL]: Z075 [Delegate]: ZTE (ZhangMengjie) [Class]: 1 [Status]: ToDo [TDoc]:
```

# Resources
[RIL File for 38.331, Review v229](https://www.3gpp.org/ftp/Email_Discussions/RAN2/%5BMisc%5D/ASN1%20review/Rel-18%202024-03/38331/ASN1%20review%20file/38331%20Rel18%20ASN1%20review%20v229.docx)