[UR] Address review feedback

Author: Petr Vesely

scripts/add_experimental_feature.py

@@ -10,6 +10,7 @@
 import sys
 from util import makoWrite
 import re
+import subprocess
 
 def verify_kebab_case(input: str) -> bool:
     # kebab case regex from https://github.com/expandjs/expandjs/blob/master/lib/kebabCaseRegex.js
@@ -20,16 +21,34 @@ def verify_kebab_case(input: str) -> bool:
     return True
 
 
+def get_user_name_email_from_git_config():
+    proc = subprocess.run(["git", "config", "user.name"], stdout=subprocess.PIPE)
+    if proc.returncode != 0:
+        raise Exception("Failed to get user name from git config.")
+    user_name = proc.stdout.decode().strip()
+
+    proc = subprocess.run(["git", "config", "user.email"], stdout=subprocess.PIPE)
+    if proc.returncode != 0:
+        raise Exception("Failed to get user email from git config.")
+    user_email = proc.stdout.decode().strip()
+
+    return user_name, user_email
+
+
 def main():
 
     argParser = argparse.ArgumentParser()
     argParser.add_argument("name", help="must be lowercase and kebab case i.e. command-buffer", type=str)
+    argParser.add_argument("--dry_run", help="run the script without generating any files", action='store_true')
     args = argParser.parse_args()
 
     if not verify_kebab_case(args.name):
         print("Name must be lowercase and kebab-case i.e. command-buffer.")
         sys.exit(1)
 
+    user_name, user_email = get_user_name_email_from_git_config()
+    user = {'email':user_email, 'name': user_name}
+
     exp_feat_name = args.name
 
     out_yml_name = f"exp-{exp_feat_name}.yml"
@@ -40,8 +59,9 @@ def main():
     out_yml_path = f"./scripts/core/{out_yml_name}"
     out_rst_path = f"./scripts/core/{out_rst_name}"
 
-    makoWrite(yaml_template_path, out_yml_path, name=exp_feat_name)
-    makoWrite(rst_template_path, out_rst_path, name=exp_feat_name)
+    if not args.dry_run:
+        makoWrite(yaml_template_path, out_yml_path, name=exp_feat_name)
+        makoWrite(rst_template_path, out_rst_path, name=exp_feat_name, user=user)
 
 
     print(f"""\

scripts/templates/exp_feat.rst.mako

@@ -10,7 +10,7 @@
 ${" ".join(name.split("-")).title()}
 ================================================================================
 
-.. _warning:
+.. warning::
 
     Experimental features:
 
@@ -20,63 +20,60 @@ ${" ".join(name.split("-")).title()}
     *   Do not require conformance testing of their own additions.
 
 
---------------------------------------------------------------------------------
 Terminology
 --------------------------------------------------------------------------------
-If your experimental feature introduces a new concept or terminoloyg. Please 
-provide a detailed explanation in this section. If this does not apply to your 
-feature you may freely delete this section.
+.. comment:
+    If your experimental feature introduces a new concept or terminology. Please 
+    provide a detailed explanation in this section. If this does not apply to 
+    your feature you may freely delete this section.
 
---------------------------------------------------------------------------------
 Motivation
 --------------------------------------------------------------------------------
-In this section you *must* justify your motivation for adding this experimental
-feature. You should also state at least one adapter upon which this feature can 
-be supported.
+.. comment:
+    In this section you *must* justify your motivation for adding this 
+    experimental feature. You should also state at least one adapter upon which 
+    this feature can be supported.
 
---------------------------------------------------------------------------------
 API
 --------------------------------------------------------------------------------
-In this section you *must* list all additions your experimental feature will 
-make to the Unified Runtime specification. If your experimental feature does not
-include additions from one or more of the sections listed below, you may freely 
-remove them.
+.. comment:
+    In this section you *must* list all additions your experimental feature will 
+    make to the Unified Runtime specification. If your experimental feature does 
+    not include additions from one or more of the sections listed below, you may 
+    freely remove them.
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Macros
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * <%text>${x}</%text>_EXP_MACRO
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Enums
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * <%text>${x}</%text>_exp_enum_t
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Structs
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * <%text>${x}</%text>_exp_struct_t 
 
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 Functions
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 * <%text>${x}</%text>FunctionExp
 
---------------------------------------------------------------------------------
 Changelog
 --------------------------------------------------------------------------------
+.. comment:
+    When making a change to an experimental feature, increment the version and 
+    provide a brief description of the change in the table below.
 
 +-----------+------------------------+
 | Revision  | Changes                |
 +===========+========================+
 | 1.0       | Intial Draft           |
 +-----------+------------------------+
 
---------------------------------------------------------------------------------
 Contributors
 --------------------------------------------------------------------------------
-Please list all people who wish to be credited for contribution to this 
-experimental feature.
+.. comment:
+    Please list all people who wish to be credited for contribution to this 
+    experimental feature.
 
-* Contributor One `contrib.one@email.com <contrib.one@email.com>`_
-* Contributor Two `contrib.two@email.com <contrib.one@email.com>`_
+* ${user['name']} `${user['email']} <${user['email']}>`_